dbx defined

dbx defined dbtype

Dbx.Defined(dbtype)

Check whether a driver module for the specified database type is either already loaded, or available. If a module can be found, and it not yet loaded, it is automatically loaded.

The return value is a boolean status code. No error is generated when the database type cannot be resolved to a module.

Example:

dbx defined mysql

dbx exists

dbx exists dbtype

d.exists()

Dbx.Exists(dbtype)

Check whether a driver module for the specified database type is already loaded. No attempt is made to auto-load a module if it is not already loaded.

The return value is a boolean status code. No error is generated when the database type cannot be resolved to a module.

Example:

dbx exists postgresql

dbx get

dbx get dbtype attribute

d.get(attribute)

d.attribute

d[attribute]

Dbx.Get(dbtype,attribute)

Get an attribute the database driver module. The following attributes can be queried:

• aliases
  A list of recognized alias names of the database type.
• builtin
  A flag indicating whether this driver module is built-in. Built-in module cannot be unloaded.
• address_city
  The city part of the author contact address.
• address_country
  The country part of the author contact address, following the ISO3166 standard.
• address_state
  The state part of the author contact address. Empty if not applicable.
• address_street
  The street address part of the author contact address. Includes floor, house number, etc.
• address_zip
  The ZIP code or other applicable postal code of the author contact address.
• affiliation
  The institution the author works for.
• affiliationduns
  The DUNS registration ID of the affiliated institution. This is primarily useful for US government projects.
• affiliationurl
  The URL of the affiliated institution.
• author
  The author of the module, as free-format text.
• authorurl
  A URL with information on the author, or an empty string if unset.
• blobsize
  The default maximum binary blob size.
• category
  A category string to be used if the module is stored in a repository.
• classuuid
  The base class UUID of this database interface module
• comment
  A free-form comment
• date
  The date the module source code was last changed.
• doi
  A digital object identifier for the module, if defined.
• email
  An email contact address of the developer of the module.
• flags
  A collection of flags indicating special capabilities of the module. The only flag currently used is sqlarrays , indicating support for arrays as column data types.
• history
  Module history data
• infourl
  A URL with information on the module, or an empty string if unset.
• keywords
  A list of keywords associated with the module.
• license
  The license class associated with this module. Setting the license to a standard type updates the associated URL with a standard location.
• licenseurl
  A URL with details about the module license.
• literature
  A free-form literature reference.
• name
  The official name of the module. Since the information may be queried via an alias name, this can be different from the command argument.
• objectfile
  The name of the currently loaded object or shared library file implementing the functions of the selected database interface module.
• orcid
  The ORCID code of the author (see www.orcid.org).
• path
  The repository path for displaying hierarchical repository trees. This attribute is independent of any file system paths.
• phone
  A contact phone number of the author.
• port
  The default TCP/IP port used for communication with database servers.
• protocolversion
  The primary protocol version this module supports.
• references
  Cross references of the module. This is a nested list of class UUID s and reference type tags.
• regid
  For officially registered data driver modules handlers, this is the assigned registration ID. Unregistered modules report zero.
• slot
  The driver table slot this module is loaded into.
• sourcefile
  The name of the source file for the database interface module.
• textsize
  The default maximum text blob size.
• version
  Version information for the module.This is a string in a 1.2.3 (or shortened) style.
• versionuuid
  The UUID associated with this module version.

Example:

dbx get mysql version

dbx list

dbx list ?pattern?

Dbx.List(?pattern=?)

Return a list of all currently loaded database driver modules. The output may be filtered by a string pattern. Its syntax is the same as in standard Tcl command string match .

dbx load

dbx load dbtype ?objectfile?...

dbx load all

Dbx.Load(dbtype,?objectfile?,...)

Dbx.Load(“all”)

Load or re-load a database interface module. If no object file name is specified, the name of the shared library, DLL or bundle is automatically constructed from the database type name, and the module is located by traversing the database module path, which is accessible via the control array element ::cactvs(databasepath) , but this mechanism can be overridden by specifying an explicit object file with or without a path.

The all command variant locates all currently available database interface modules in the module search path and loads these. This is primarily useful for automatic database interface attribute documentation.

Example:

dbx load mysql

Above statement locates and loads the standard driver for interacting with Mysql and Mariadb databases. Depending on the platform, the object file would be named dbx_mysql.so , dbx_mysql.dll, etc.. It is located in the module directory of a standard Cactvs distribution.

In case the interface module is already loaded, the current module is unloaded first, so this command can be used to update a driver in a running application. Nevertheless, swapping a driver while database access objects which rely on this driver are in existence in the current process is usually not a good idea, though the details on whether this is possible or not depend on the module implementation.

For Tcl , the return value of the command is the slot in the handler module table the module has been loaded into. This corresponds to the value of the slot attribute which can be queried via dbx get . For Python , the return value is a module reference.

dbx ref

Dbx.Ref(dbtype)

Python -only method to get a reference of the module, which allows terser attribute retrieval commands and other operations.

dbx subcommands

dbx subcommands

dir(Dbx)

This command returns a list of all the defined subcommands of the dbx command.