ServerDatabaseConnection Objects

This encapsulates the functionality of an object that represents a connection to a database.

s.dropTable(tableName)
tableName (string) : 
s.getDBQueryColumns(queryText) : RowSet

queryText (string) : the text of the query

Returns a list of the columns returned by a specified database query. The list is returned in the form of a dataset where the first column contains the column name as a string.

Exceptions:

ServerResourceException : if the server resource cannot be accessed

s.getDBTableColumns(catalogName, schemaName, tableName) : RowSet

catalogName (string) : the catalog name

schemaName (string) : the schema name

tableName (string) : the base table name

Returns a list of the columns in a specified database table. The list is returned in the form of a dataset where the first column contains the column name as a string and the second column contains StorageType constants that provide the closest match for the storage types for the columns in the database table.

Exceptions:

ServerResourceException : if the server resource cannot be accessed

s.getDBTables(catalogName, schemaName, tableName, includeUserTables, includeSystemTables, includeViews, 
includeSynonyms) : RowSet

catalogName (string) : pattern for the catalog name

schemaName (string) : pattern for the schema name

tableName (string) : pattern for the table name

includeUserTables (boolean) : indicates whether user tables should be included

includeSystemTables (boolean) : indicates whether system tables should be included

includeViews (boolean) : indicates whether views should be included

includeSynonyms (boolean) : indicates whether synonyms should be included

Returns a summary of the tables available on this database connection which match the specified arguments. The summary is returned in the form of a dataset with at least two columns, of which the first two columns are the schema name and table name, both as strings.

Exceptions:

ServerResourceException : if the server resource cannot be accessed

s.isDBTableVisible(catalogName, schemaName, tableName) : boolean

catalogName (string) : the catalog name

schemaName (string) : the schema name

tableName (string) : the table name

Returns True if the specified table is visible to this connection.

Exceptions:

ServerResourceException : if the server resource cannot be accessed