|
Options |
Name |
Purpose |
|
|
|
CreateAlias (character, character)
|
Registers (or updates) a schema alias for a database name
Notes : Mirrors CREATE ALIAS / the parser's &-alias handling.
@param pcAlias The alias name
@param pcDatabaseName The logical database name the alias resolves to
*/
|
|
|
|
DeleteAlias (character)
|
Removes a schema alias
Notes :
@param pcAlias The alias name
*/
|
|
|
|
Consultingwerk.Studio.ProparseApi.Implementation.ProparseAbl.Schema.SchemaDatabase GetDatabases ()
|
Returns the databases of the schema, in load order
Notes : Materialized lazily; an indeterminate array when the schema is empty.
A method rather than a property because an EXTENT property cannot
run a whole-array getter.
@return The array of SchemaDatabase instances (indeterminate when none)
*/
|
|
|
|
LOGICAL HasField (character, character)
|
Returns whether a field exists within a table
Notes : No wrapper is materialized. The table name may be db-qualified.
@param pcTableName The table name (optionally database-qualified)
@param pcFieldName The field name
@return Logical value
*/
|
|
|
|
LOGICAL HasTable (character)
|
Returns whether a table name exists (unqualified or db-qualified)
Notes : No wrapper is materialized - a single indexed lookup.
@param pcName The table name (optionally database-qualified)
@return Logical value
*/
|
|
|
|
LOGICAL IsAlias (character)
|
Returns whether a name is a registered schema alias
Notes :
@param pcAlias The name to test
@return Logical value
*/
|
|
|
|
INTEGER LoadConnectedDatabases ()
|
Loads (or reloads) the schema from the connected databases
Notes : Clears the store first, so it doubles as the refresh implementation.
@return The number of databases loaded
*/
|
|
|
|
Consultingwerk.Studio.ProparseApi.Implementation.ProparseAbl.Schema.SchemaDatabase LookupDatabase (character)
|
Returns a database by logical (or alias) name, or the unknown value
Notes :
@param pcName The database or alias name
@return The SchemaDatabase, or the unknown value when there is no such database
*/
|
|
|
|
Consultingwerk.Studio.ProparseApi.IField LookupField (character, character)
|
Returns a field of a table by name, or the unknown value
Notes : The table name may be database-qualified.
@param pcTableName The table name (optionally database-qualified)
@param pcFieldName The field name
@return The IField, or the unknown value when there is no such field
*/
|
|
|
|
Consultingwerk.Studio.ProparseApi.ITable LookupTable (character)
|
Returns a table by name, or the unknown value
Notes : Accepts an unqualified table name or a database-qualified
"database.table" name (the database part is alias-resolved). The
first match by connection / load order wins for an unqualified name.
A third dotted part (database.table.field) is ignored, as the
reference schema lookup does (SCL-5780).
@param pcName The table name (optionally database-qualified)
@return The ITable, or the unknown value when there is no such table
*/
|
|
|
|
Consultingwerk.Studio.ProparseApi.ITable LookupTable (character, character)
|
Returns a table qualified by database (or alias), or the unknown value
Notes :
@param pcDatabaseName The database or alias name
@param pcTableName The table name
@return The ITable, or the unknown value when there is no such table
*/
|
|
|
|
INTEGER Refresh ()
|
Reloads the schema from the connected databases
Notes : Explicit refresh for the cached instance after a connection change.
@return The number of databases loaded
*/
|
|
|
|
ResetInstance ()
|
Drops the cached session-singleton Schema
Notes : The next Instance access rebuilds and reloads it. Chiefly for tests
and for forcing a full rebuild.
*/
|
|
|
|
Consultingwerk.Studio.ProparseApi.ITable TableFromId (integer)
|
Materializes a table wrapper from a store table id (0 -> unknown)
Notes :
@param piTableId The store table id
@return The ITable, or the unknown value when the id is 0
*/
|
