About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class DataSourceItemPath

Represents a path to a a metadata item in a data source in Information Services.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- DataSourceItemPath

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Extended capability 'LibraryWrite'

Catalog Procedure Schema Table CreateCatalog CreateProcedure CreateSchema CreateTable

Methods

Cast

Cast<T1, T2>(this, type): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this, type): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

Equals(objA, objB): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals

Extended capability 'LibraryWrite'

Catalog

get Catalog(): string
Gets the name of the catalog. May be null or empty.

Returns string
Since
2.0

Procedure

get Procedure(): string
Gets the name of the procedure. May be null or empty.

Returns string
Since
2.0

Schema

get Schema(): string
Gets the name of the schema. May be null or empty.

Returns string
Since
2.0

Table

get Table(): string
Gets the name of the table. May be null or empty.

Returns string
Since
2.0

`Static`CreateCatalog

CreateCatalog(catalog): DataSourceItemPath
Creates a path to a catalog.
Parameters
- catalog: string | String
  The name of the catalog.
Returns DataSourceItemPath
The newly created path.

Since
2.0

`Static`CreateProcedure

CreateProcedure(catalog, schema, procedure): DataSourceItemPath
Creates a path to a procedure.
Parameters
- catalog: string | String
  The name of the catalog. Null or empty if it does not exist.
- schema: string | String
  The name of the schema. Null or empty if it does not exist.
- procedure: string | String
  The name of the procedure.
Returns DataSourceItemPath
The newly created path.

Since
2.0

`Static`CreateSchema

CreateSchema(catalog, schema): DataSourceItemPath
Creates a path to a schema.
Parameters
- catalog: string | String
  The name of the catalog. Null or empty if it does not exist.
- schema: string | String
  The name of the schema.
Returns DataSourceItemPath
The newly created path.

Since
2.0

`Static`CreateTable

CreateTable(catalog, schema, table): DataSourceItemPath
Creates a path to a table.
Parameters
- catalog: string | String
  The name of the catalog. Null or empty if it does not exist.
- schema: string | String
  The name of the schema. Null or empty if it does not exist.
- table: string | String
  The name of the table.
Returns DataSourceItemPath
The newly created path.

Since
2.0