Package rdkit :: Package Dbase :: Module DbInfo
[hide private]
[frames] | no frames]

Module DbInfo

source code

Functions [hide private]
 
GetDbNames(user='sysdba', password='masterkey', dirName='.', dBase='::template1', cn=None)
returns a list of databases that are available
source code
 
GetTableNames(dBase, user='sysdba', password='masterkey', includeViews=0, cn=None)
returns a list of tables available in a database
source code
 
GetColumnInfoFromCursor(cursor) source code
 
GetColumnNamesAndTypes(dBase, table, user='sysdba', password='masterkey', join='', what='*', cn=None)
gets a list of columns available in a DB table along with their types
source code
 
GetColumnNames(dBase, table, user='sysdba', password='masterkey', join='', what='*', cn=None)
gets a list of columns available in a DB table
source code
Variables [hide private]
  sqlTextTypes = []
  sqlIntTypes = []
  sqlFloatTypes = []
  sqlBinTypes = []
  __package__ = 'rdkit.Dbase'

Imports: RDConfig, DbModule, sys


Function Details [hide private]

GetDbNames(user='sysdba', password='masterkey', dirName='.', dBase='::template1', cn=None)

source code 
returns a list of databases that are available

**Arguments**

  - user: the username for DB access

  - password: the password to be used for DB access

**Returns**

  - a list of db names (strings)

GetTableNames(dBase, user='sysdba', password='masterkey', includeViews=0, cn=None)

source code 
returns a list of tables available in a database

**Arguments**

  - dBase: the name of the DB file to be used

  - user: the username for DB access

  - password: the password to be used for DB access

  - includeViews: if this is non-null, the views in the db will
    also be returned

**Returns**

  - a list of table names (strings)

GetColumnNamesAndTypes(dBase, table, user='sysdba', password='masterkey', join='', what='*', cn=None)

source code 
gets a list of columns available in a DB table along with their types

**Arguments**

  - dBase: the name of the DB file to be used

  - table: the name of the table to query

  - user: the username for DB access

  - password: the password to be used for DB access

  - join: an optional join clause (omit the verb 'join')

  - what: an optional clause indicating what to select

**Returns**

  - a list of 2-tuples containing:

      1) column name

      2) column type

GetColumnNames(dBase, table, user='sysdba', password='masterkey', join='', what='*', cn=None)

source code 
gets a list of columns available in a DB table

**Arguments**

  - dBase: the name of the DB file to be used

  - table: the name of the table to query

  - user: the username for DB access

  - password: the password to be used for DB access

  - join: an optional join clause  (omit the verb 'join')

  - what: an optional clause indicating what to select

**Returns**

  -  a list of column names