| | |
- builtins.object
-
- sqlrconnection
- sqlrcursor
class sqlrconnection(builtins.object) |
| |
sqlrconnection(host, port, socket, user, password, retrytime=0, tries=1)
A wrapper for the sqlrelay connection API. Closely follows the C++ API.
|
| |
Methods defined here:
- __del__(self)
- __init__(self, host, port, socket, user, password, retrytime=0, tries=1)
- Initiates a connection to "server" on "port" or to the unix "socket" on
the local machine and auths with "user" and "password". Failed
connections will be retried for "tries" times, waiting "retrytime"
seconds between each try. If "tries" is 0 then retries will continue
forever. If "retrytime" is 0 then retries will be attempted on a
default interval.
If "server" is a comma-separated list of hosts, then an attempt will be
made to connect to each until the attempt succeeds, or there are no
more hosts left to try.
If the "socket" parameter is neither None nor "" then an
attempt will be made to connect through it before
attempting to connect to "server" on "port". If it is None
or "" then no attempt will be made to connect through the
socket.
- autoCommitOff(self)
- Instructs the database to wait for the
client to tell it when to commit.
- autoCommitOn(self)
- Instructs the database to perform a commit
after every successful query.
- begin(self)
- Begins a transaction. Returns true if the begin
succeeded, false if it failed. If the database
automatically begins a new transaction when a
commit or rollback is issued then this doesn't
do anything unless SQL Relay is faking transaction
blocks.
- bindFormat(self)
- Returns a string representing the bind variable format used
by the database. For example:
? - database uses a ? to represent a bind variable
@* - database uses a @ followed by any characters to
represent a bind variable
$1 - database uses a $ followed by a number to represent a
bind variable
:* - database uses a : followed by any characters to
represent a bind variable
- clientVersion(self)
- Returns the version of the sqlrelay client software.
- commit(self)
- Commits a transaction. Returns true if the commit
succeeded, false if it failed.
- dbHostName(self)
- Returns the host name of the database
- dbIpAddress(self)
- Returns the ip address of the database
- dbVersion(self)
- Returns the version of the database
- debugOff(self)
- Turns debugging off.
- debugOn(self)
- Causes verbose debugging information to be
sent to standard output. Another way to do
this is to start a query with "-- debug
".
Yet another way is to set the environment
variable SQLR_CLIENT_DEBUG to "ON"
- disableEncryption(self)
- Disables encryption.
- enableKerberos(self, service, mech, flags)
- Enables Kerberos authentication and encryption.
"service" indicates the Kerberos service name of the
SQL Relay server. If left empty or None then the service
name "sqlrelay" will be used. "sqlrelay" is the default
service name of the SQL Relay server. Note that on Windows
platforms the service name must be fully qualified,
including the host and realm name. For example:
"sqlrelay/sqlrserver.firstworks.com@AD.FIRSTWORKS.COM".
"mech" indicates the specific Kerberos mechanism to use.
On Linux/Unix platforms, this should be a string
representation of the mechnaism's OID, such as:
{ 1 2 840 113554 1 2 2 }
On Windows platforms, this should be a string like:
Kerberos
If left empty or None then the default mechanism will be
used. Only set this if you know that you have a good
reason to.
"flags" indicates what Kerberos flags to use. Multiple
flags may be specified, separated by commas. If left
empty or None then a defalt set of flags will be used.
Only set this if you know that you have a good reason to.
Valid flags include:
* GSS_C_MUTUAL_FLAG
* GSS_C_REPLAY_FLAG
* GSS_C_SEQUENCE_FLAG
* GSS_C_CONF_FLAG
* GSS_C_INTEG_FLAG
For a full list of flags, consult the GSSAPI documentation,
though note that only the flags listed above are supported
on Windows.
- enableTls(self, version, cert, password, ciphers, validate, ca, depth)
- Enables TLS/SSL encryption, and optionally authentication.
"version" specifies the TLS/SSL protocol version that the
client will attempt to use. Valid values include SSL2,
SSL3, TLS1, TLS1.1, TLS1.2 or any more recent version of
TLS, as supported by and enabled in the underlying TLS/SSL
library. If left blank or empty then the highest supported
version will be negotiated.
"cert" is the file name of the certificate chain file to
send to the SQL Relay server. This is only necessary if
the SQL Relay server is configured to authenticate and
authorize clients by certificate.
If "cert" contains a password-protected private key, then
"password" may be supplied to access it. If the private
key is not password-protected, then this argument is
ignored, and may be left empty or None.
"ciphers" is a list of ciphers to allow. Ciphers may be
separated by spaces, commas, or colons. If "ciphers" is
empty or None then a default set is used. Only set this if
you know that you have a good reason to.
For a list of valid ciphers on Linux/Unix platforms, see:
man ciphers
For a list of valid ciphers on Windows platforms, see:
https://msdn.microsoft.com/en-us/library/windows/desktop/aa375549%28v=vs.85%29.aspx
On Windows platforms, the ciphers (alg_id's) should omit
CALG_ and may be given with underscores or dashes.
For example: 3DES_112
"validate" indicates whether to validate the SQL Relay's
server certificate, and may be set to one of the following:
"no" - Don't validate the server's certificate.
"ca" - Validate that the server's certificate was
signed by a trusted certificate authority.
"ca+host" - Perform "ca" validation and also validate
that one of the subject altenate names (or the
common name if no SANs are present) in the
certificate matches the host parameter.
(Falls back to "ca" validation when a unix
socket is used.)
"ca+domain" - Perform "ca" validation and also validate
that the domain name of one of the subject
alternate names (or the common name if no SANs
are present) in the certificate matches the
domain name of the host parameter. (Falls back
to "ca" validation when a unix socket is used.)
"ca" is the location of a certificate authority file to
use, in addition to the system's root certificates, when
validating the SQL Relay server's certificate. This is
useful if the SQL Relay server's certificate is self-signed.
On Windows, "ca" must be a file name.
On non-Windows systems, "ca" can be either a file or
directory name. If it is a directory name, then all
certificate authority files found in that directory will be
used. If it a file name, then only that file will be used.
Note that the supported "cert" and "ca" file formats may
vary between platforms. A variety of file formats are
generally supported on Linux/Unix platfoms (.pem, .pfx,
etc.) but only the .pfx format is currently supported on
Windows.
- endSession(self)
- Ends the session.
- errorMessage(self)
- If an operation failed and generated an
error, the error message is available here.
If there is no error then this method
returns None.
- errorNumber(self)
- If an operation failed and generated an
error, the error number is available here.
If there is no error then this method
returns 0.
- getAutoCommit(self)
- Returns true if auto-commit is currently on,
false otherwise.
- getBindVariableDelimiterAtSignSupported(self)
- Returns true if at-signs (@) are considered to be
valid bind variable delimiters.
- getBindVariableDelimiterColonSupported(self)
- Returns true if colons (:) are considered to be
valid bind variable delimiters.
- getBindVariableDelimiterDollarSignSupported(self)
- Returns true if dollar signs ($) are considered to be
valid bind variable delimiters.
- getBindVariableDelimiterQuestionMarkSupported(self)
- Returns true if question marks (?) are considered to be
valid bind variable delimiters.
- getClientInfo(self)
- Returns the string that was set by setClientInfo().
- getConnectTimeoutMicroseconds(self)
- Gets the server connect timeout in microseconds.
- getConnectTimeoutSeconds(self)
- Gets the server connect timeout in seconds.
- getConnectionPort(self)
- Returns the inet port that the connection is
communicating over. This parameter may be
passed to another connection for use in
the resumeSession() method.
Note: The value this method returns is only
valid after a call to suspendSession().
- getConnectionSocket(self)
- Returns the unix socket that the connection
is communicating over. This parameter may be
passed to another connection for use in
the resumeSession() method.
Note: The value this method returns is only
valid after a call to suspendSession().
- getCurrentCatalog(self)
- Returns the catalog that is currently in use.
- getCurrentDatabase(self)
- Returns the database that is currently in use.
May return the current catalog or schema, depending on
whether the backend database equates "database" with
catalog or schema.
See getDatabaseIsSchema().
- getCurrentSchema(self)
- Returns the schema that is currently in use.
- getCurrentUser(self)
- Returns the user that sqlrelay is currently logged in to
the database as, or None if no user could be determined
or if an error occurred.
- getDatabaseFeature(self, feature)
- Returns the value of the specified database "feature".
Valid features include:
* aggregate_functions
* list - ALL,AVG,COUNT,DISTINCT,MAX,MIN,SUM
* all_procedures_are_callable
* true/false
* all_tables_are_selectable
* true/false
* alter_domain_clauses
* list - ADD_DOMAIN_CONSTRAINT,ADD_DOMAIN_DEFAULT,...
* alter_table_operations
* list - ADD_COLUMN,DROP_COLUMN
* ansi92_sql_levels
* list - ENTRY_LEVEL,FULL,INTERMEDIATE
* auto_commit_failure_closes_all_result_sets
* true/false
* batch_operations
* list - SELECT_EXPLICIT,ROW_COUNT_EXPLICIT,SELECT_PROC,ROW_COUNT_PROC
* batch_row_counts
* list - PROCEDURES,EXPLICIT,ROLLED_UP
* catalog_separator
* string
* catalog_term
* string
* catalog_usage
* list - DATA_MANIPULATION,INDEX_DEFINITIONS,...
* collation_seq
* string
* create_assertion_clauses
* list - CREATE_ASSERTION,CONSTRAINT_INITIALLY_DEFERRED,...
* create_character_set_clauses
* list - CREATE_CHARACTER_SET,COLLATE_CLAUSE,...
* create_collation_clauses
* list - CREATE_COLLATION
* create_domain_clauses
* list - CREATE_DOMAIN,CONSTRAINT_NAME_DEFINITION,...
* create_schema_clauses
* list - CREATE_SCHEMA,AUTHORIZATION,DEFAULT_CHARACTER_SET
* create_table_clauses
* list - CREATE_TABLE,TABLE_CONSTRAINT,...
* create_translation_clauses
* list - CREATE_TRANSLATION
* create_view_clauses
* list - CREATE_VIEW,CHECK_OPTION,CASCADED,LOCAL
* data_definition_transaction_behavior
* list - CAUSES_COMMIT,IGNORED_IN_TRANSACTIONS
* ddl_index_operations
* list - CREATE_INDEX,DROP_INDEX
* string
* default_result_set_holdability
* string
* deletes_are_detected
* list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
* does_max_row_size_include_blobs
* true/false
* drop_assertion_clauses
* list - DROP_ASSERTION
* drop_character_set_clauses
* list - DROP_CHARACTER_SET
* drop_collation_clauses
* list - DROP_COLLATION
* drop_domain_clauses
* list - DROP_DOMAIN,CASCADE,RESTRICT
* drop_schema_clauses
* list - DROP_SCHEMA,CASCADE,RESTRICT
* drop_table_clauses
* list - DROP_TABLE,CASCADE,RESTRICT
* drop_translation_clauses
* list - DROP_TRANSLATION
* drop_view_clauses
* list - DROP_VIEW,CASCADE,RESTRICT
* extra_name_characters
* string
* foreign_key_delete_rules
* list - CASCADE,NO_ACTION,SET_DEFAULT,SET_NULL
* foreign_key_update_rules
* list - CASCADE,NO_ACTION,SET_DEFAULT,SET_NULL
* forward_only_cursor_attributes
* list - NEXT,ABSOLUTE,RELATIVE,BOOKMARK,...
* generated_key_always_returned
* true/false
* grant_clauses
* list - DELETE_TABLE,INSERT_COLUMN,INSERT_TABLE,...
* group_by_clauses
* list - BASIC,BEYOND_SELECT,UNRELATED
* identifier_case_storage
* list - LOWER,MIXED,SENSITIVE,UPPER
* identifier_quote_string
* string
* index_keywords
* list - ASC,DESC
* info_schema_views
* list - ASSERTIONS,CHARACTER_SETS,CHECK_CONSTRAINTS,...
* insert_operations
* list - INSERT_LITERALS,INSERT_SEARCHED,SELECT_INTO
* inserts_are_detected
* list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
* is_catalog_at_start
* true/false
* isolation_levels
* list - READ_UNCOMMITTED,READ_COMMITTED,...
* local_file_usage
* list - LOCAL_FILE_PER_TABLE,LOCAL_FILES
* locators_update_copy
* true/false
* lock_types
* list - NO_CHANGE,EXCLUSIVE,UNLOCK
* max_binary_literal_length
* number
* max_catalog_name_length
* number
* max_char_literal_length
* number
* max_column_name_length
* number
* max_columns_in_group_by
* number
* max_columns_in_index
* number
* max_columns_in_order_by
* number
* max_columns_in_select
* number
* max_columns_in_table
* number
* max_connections
* number
* max_cursor_name_length
* number
* max_identifier_length
* number
* max_index_length
* number
* max_procedure_name_length
* number
* max_row_size
* number
* max_schema_name_length
* number
* max_statement_length
* number
* max_statements
* number
* max_table_name_length
* number
* max_tables_in_select
* number
* max_user_name_length
* number
* need_long_data_length
* true/false
* null_plus_non_null_is_null
* true/false
* null_sort_order
* list - AT_END,AT_START,HIGH,LOW
* numeric_functions
* list - ABS,ACOS,ASIN,ATAN,ATAN2,CEILING,COS,COT,...
* open_cursors_across
* list - COMMIT,ROLLBACK
* open_statements_across
* list - COMMIT,ROLLBACK
* others_deletes_are_visible
* list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
* others_inserts_are_visible
* list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
* others_updates_are_visible
* list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
* outer_joins
* list - BASIC,FULL,LIMITED
* own_deletes_are_visible
* list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
* own_inserts_are_visible
* list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
* own_updates_are_visible
* list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
* predicates
* list - BETWEEN,COMPARISON,EXISTS,IN,ISNOTNULL,ISNULL,...
* procedure_term
* string
* quoted_identifier_case_storage
* list - LOWER,MIXED,SENSITIVE,UPPER
* relational_join_operators
* list - CORRESPONDING_CLAUSE,CROSS_JOIN,EXCEPT_JOIN,...
* result_set_concurrencies
* list - FORWARD_ONLY/READ_ONLY,FORWARD_ONLY/UPDATABLE,...
* result_set_holdabilities
* list - CLOSE_CURSORS_AT_COMMIT,HOLD_CURSORS_OVER_COMMIT
* result_set_types
* list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
* revoke_clauses
* list - CASCADE,DELETE_TABLE,GRANT_OPTION_FOR,...
* row_id_lifetime
* string
* row_value_constructor_expressions
* list - VALUE_EXPRESSION,NULL,DEFAULT,ROW_SUBQUERY
* schema_term
* string
* schema_usage
* list - DATA_MANIPULATION,INDEX_DEFINITIONS,...
* scroll_concurrencies
* list - READ_ONLY,LOCK,OPT_ROWVER,OPT_VALUES
* search_string_escape
* string
* sql_grammar_levels
* list - CORE,EXTENDED,MINIMUM
* sql_keywords
* list - ACCESS,ADD,ALTER,AUDIT,CLUSTER,COLUMN,COMMENT,...
* sql_state_type
* number
* static_cursor_attributes
* list - NEXT,ABSOLUTE,RELATIVE,BOOKMARK,...
* stored_programs
* list - FUNCTIONS,PROCEDURES
* string_functions
* list - CONCAT,INSERT,LEFT,LTRIM,LENGTH,LOCATE,LCASE,...
* subquery_usage
* list - COMPARISONS,EXISTS,INS,QUANTIFIEDS
* supports_batch_updates
* true/false
* supports_column_aliasing
* true/false
* supports_convert
* true/false
* supports_correlated_subqueries
* true/false
* supports_describe_parameter
* true/false
* supports_expressions_in_order_by
* true/false
* supports_get_generated_keys
* true/false
* supports_integrity_enhancement_facility
* true/false
* supports_like_escape_clause
* true/false
* supports_multiple_result_sets
* true/false
* supports_multiple_transactions
* true/false
* supports_named_parameters
* true/false
* supports_non_nullable_columns
* true/false
* supports_order_by_unrelated
* true/false
* supports_savepoints
* true/false
* supports_select_for_update
* true/false
* supports_transactions
* true/false
* system_functions
* list - USER,DBNAME,IFNULL
* table_correlation_names
* list - BASIC,DIFFERENT
* table_term
* string
* time_date_add_intervals
* list - FRAC_SECOND,SECOND,MINUTE,HOUR,DAY,WEEK,MONTH,...
* time_date_diff_intervals
* list - FRAC_SECOND,SECOND,MINUTE,HOUR,DAY,WEEK,MONTH,...
* time_date_functions
* list - NOW,CURDATE,DAYOFMONTH,DAYOFWEEK,DAYOFYEAR,...
* time_date_literals
* list - DATE,TIME,TIMESTAMP,INTERVAL_YEAR,...
* transaction_ddl_dml
* list - DDL_AND_DML,DML_ONLY
* union_clauses
* list - UNION,UNION_ALL
* updates_are_detected
* list - FORWARD_ONLY,SCROLL_INSENSITIVE,SCROLL_SENSITIVE
* value_expressions
* list - CASE,CAST,COALESCE,NULLIF
* where_current_of_operations
* list - DELETE,UPDATE
Returns the value of the feature as a string, or None if
an error occurred or an invalid feature was requested.
- getDatabaseIsSchema(self)
- Returns true if the backend database equates "database"
with "schema", and false if it equates "database" with
"catalog".
- getDebug(self)
- Returns false if debugging is off and true
if debugging is on.
- getDefaultIsolationLevel(self)
- Returns the database-specific default isolation level,
or None if an error occurred.
- getDefaultTransactionModel(self)
- Returns the database's native transaction model. See
setTranscationModel() for a list of potential return
values. Returns None if an error occurred.
- getInTransaction(self)
- Returns true if the session is currently inside a
transaction, false otherwise.
- getIsolationLevel(self)
- Returns the database-specific isolation level, "unknown"
if the isolation level is unknown, or None if an error
occurred.
- getLastInsertId(self)
- Returns the value of the autoincrement column for the last insert
- getResponseTimeoutMicroseconds(self)
- Gets the response timeout in microseconds.
- getResponseTimeoutSeconds(self)
- Gets the response timeout in seconds.
- getTransactionModel(self)
- Returns the current transaction model. See
setTranscationModel() for a list of potential return
values. Returns None if an error occurred.
- identify(self)
- Returns the type of database:
oracle, postgresql, mysql, etc.
- nextvalFormat(self)
- Returns a string representing the format of the sequence
nextval command used in the database. The format will
contain a %s in place of the sequence name. For example:
(nextval for %s)
next value for %s
nextval('%s')
%s.nextval
Returns an empty string if the database does not support
sequences.
- ping(self)
- Returns true if the database is up and false
if it's down.
- resumeSession(self, port, socket)
- Resumes a session previously left open
using suspendSession().
Returns true on success and false on failure.
- rollback(self)
- Rolls back a transaction. Returns true if the rollback
succeeded, false if it failed.
- selectCatalog(self, catalog)
- Sets the current catalog to "catalog"
- selectDatabase(self, database)
- Sets the current database to "database".
May set the current catalog or schema, depending on
whether the backend database equates "database" with
catalog or schema.
See getDatabaseIsSchema().
- selectSchema(self, schema)
- Sets the current schema to "schema"
- serverVersion(self)
- Returns the version of the sqlrelay server software.
- setBindVariableDelimiters(self, delimiters)
- Sets which delimiters are used to identify bind variables
in countBindVariables() and validateBinds(). Valid
delimiters include ?,:,@, and $. Defaults to "?:@$"
- setClientInfo(self, clientinfo)
- Allows you to set a string that will be passed to the
server and ultimately included in server-side logging
along with queries that were run by this instance of
the client.
- setConnectTimeout(self, timeoutsec, timeoutusec)
- Sets the server connect timeout in seconds and
microseconds. Setting either parameter to -1 disables the
timeout. You can also set this timeout using the
SQLR_CLIENT_CONNECT_TIMEOUT environment variable.
- setDebugFile(self, filename)
- Allows you to specify a file to write debug to.
Setting "filename" to None or an empty string causes debug
to be written to standard output (the default).
- setIsolationLevel(self, isolationlevel)
- Sets the transaction isolation level to "isolationlevel".
The string is the database-specific (native) name and is
matched case-insensitively.
Valid isolation levels include:
For PostgreSQL:
* READ UNCOMMITTED
* READ COMMITTED (default)
* REPEATABLE READ
* SERIALIZABLE
For MySQL/MariaDB:
* READ-UNCOMMITTED
* READ-COMMITTED
* REPEATABLE-READ (default)
* SERIALIZABLE
For Oracle:
* READ COMMITTED (default)
* SERIALIZABLE
For DB2:
* UR (uncommitted read)
* CS (cursor stability, default)
* RS (read stability)
* RR (repeatable read)
For MS SQL Server (via FreeTDS):
* READ UNCOMMITTED
* READ COMMITTED (default)
* REPEATABLE READ
* SERIALIZABLE
* SNAPSHOT
For SAP ASE (Sybase):
* 0 (read uncommitted)
* 1 (read committed, default)
* 2 (repeatable read)
* 3 (serializable)
For Informix:
* dirty read
* committed read (default)
* cursor stability
* repeatable read
For Firebird:
* read committed (default)
* read committed no record version
* read consistency
* snapshot
* snapshot table stability
For SQLite:
* 0 (serializable, default)
* 1 (read uncommitted)
For ODBC:
* SQL_TXN_READ_UNCOMMITTED
* SQL_TXN_READ_COMMITTED
* SQL_TXN_REPEATABLE_READ
* SQL_TXN_SERIALIZABLE
(whether a given level is actually supported depends on
the underlying ODBC driver and target database). The
generic ODBC backend also accepts the database-specific
native names listed above for any of the other backends,
as well as the JDBC TRANSACTION_* names, and maps them
to the closest of the four ODBC levels above.
For other databases, the string is passed through to the
backend as the argument to "set transaction isolation
level".
Returns true if setting the isolation level succeeded,
false if it failed.
- setResponseTimeout(self, timeoutsec, timeoutusec)
- Sets the response timeout (for queries, commits, rollbacks,
pings, etc.) in seconds and microseconds. Setting either
parameter to -1 disables the timeout. You can also set
this timeout using the SQLR_CLIENT_RESPONSE_TIMEOUT
environment variable.
- setTransactionModel(self, txmodel)
- Sets the current transaction model to "txmodel" which should be
one of:
* native - the database's native transaction model
* none - no transactions
* "implicit"
* in a transaction when the session begins
* commit/rollback implicitly starts a new transcaction
* autocommit on/off take effect immediately
* "explicit"
* not in a transaction when the session begins
* begin required to start a new transaction
* commit/rollback does not start a new transcaction
* autocommit on/off take effect immediately
* "explicit-deferred"
* not in a transaction when the session begins
* begin required to start a new transaction
* commit/rollback does not start a new transcaction
* while in a begin-initiated transaction, autocommit
on takes effect at next commit/rollback (deferred)
* while in an autocommit-off-initiated transaction,
autocommit on takes effect immediately
* "explicit-error"
* not in a transaction when the session begins
* begin required to start a new transaction
* commit/rollback does not start a new transcaction
* while in a transaction, autocommit on/off throw error
Returns true on success and false on failure.
- suspendSession(self)
- Disconnects this connection from the current
session but leaves the session open so
that another connection can connect to it
using resumeSession().
Data descriptors defined here:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
|
class sqlrcursor(builtins.object) |
| |
sqlrcursor(sqlrcon)
A wrapper for the sqlrelay cursor API. Closely follows the C++ API.
|
| |
Methods defined here:
- __del__(self)
- __init__(self, sqlrcon)
- Initialize self. See help(type(self)) for accurate signature.
- affectedRows(self)
- Returns the number of rows that were
updated, inserted or deleted by the query.
Not all databases support this call. Don't
use it for applications which are designed
to be portable across databases. 0 is
returned by databases which don't support
this option.
- cacheOff(self)
- Sets query caching off.
- cacheToFile(self, filename)
- Sets query caching on. Future queries
will be cached to the file "filename".
A default time-to-live of 10 minutes is
also set.
Note that once cacheToFile() is called,
the result sets of all future queries will
be cached to that file until another call
to cacheToFile() changes which file to
cache to or a call to cacheOff() turns off
caching.
- clearBinds(self)
- Clears all bind variables.
- closeResultSet(self)
- Closes the current result set, if one is open. Data
that has been fetched already is still available but
no more data may be fetched. Server side resources
for the result set are freed as well.
- colCount(self)
- Returns the number of columns in the current result set.
- countBindVariables(self)
- Parses the previously prepared query,
counts the number of bind variables defined
in it and returns that number.
- defineOutputBindBlob(self, variable)
- Defines a binary lob output bind variable.
- defineOutputBindClob(self, variable)
- Defines a character lob output bind variable.
- defineOutputBindCursor(self, variable)
- Defines a cursor output bind variable.
- defineOutputBindDate(self, variable)
- Defines a date output bind variable.
- defineOutputBindDouble(self, variable)
- Defines a decimal output bind variable.
- defineOutputBindInteger(self, variable)
- Defines an integer output bind variable.
- defineOutputBindString(self, variable, length)
- Defines an output bind variable.
"bufferlength" bytes will be reserved
to store the value.
- dontGetColumnInfo(self)
- Tells the server not to send any column
info (names, types, sizes). If you don't
need that info, you should call this
method to improve performance.
- endOfResultSet(self)
- Returns false if part of the result set is
still pending on the server and true if not.
This method can only return false if
setResultSetBufferSize() has been called
with a parameter other than 0.
- errorMessage(self)
- If a query failed and generated an error,
the error message is available here. If
the query succeeded then this method
returns None.
- errorNumber(self)
- If a query failed and generated an
error, the error number is available here.
If there is no error then this method
returns 0.
- executeQuery(self)
- Execute the query that was previously
prepared and bound.
- fetchFromBindCursor(self)
- Fetch from a cursor that was returned as
an output bind variable.
- firstRowIndex(self)
- Returns the index of the first buffered row.
This is useful when buffering only part of
the result set at a time.
- getCacheFileName(self)
- Returns the name of the file containing the
cached result set.
- getCatalogList(self, wild)
- Generates a result set containing catalogs that match the
pattern "wild".
The result set will contain the following columns:
* Database
If "wild" is empty or None then a result set containing
all catalogs will be returned.
If SQL Relay doesn't support getting a list of catalogs
for the current database backend (or the database doesn't)
then an empty result set will be returned.
- getColumnInfo(self)
- Tells the server to send column info.
- getColumnIsAutoIncrement(self, col)
- Returns true if the specified column
auto-increments and false otherwise.
- getColumnIsBinary(self, col)
- Returns true if the specified column
contains binary data and false
otherwise.
- getColumnIsNullable(self, col)
- Returns true if the specified column can
contain nulls and false otherwise.
- getColumnIsPartOfKey(self, col)
- Returns true if the specified column is
part of a composite key and false otherwise.
- getColumnIsPrimaryKey(self, col)
- Returns true if the specified column is a
primary key and false otherwise.
- getColumnIsUnique(self, col)
- Returns true if the specified column is
unique and false otherwise.
- getColumnIsUnsigned(self, col)
- Returns true if the specified column is
an unsigned number and false otherwise.
- getColumnIsZeroFilled(self, col)
- Returns true if the specified column was
created with the zero-fill flag and false
otherwise.
- getColumnLength(self, col)
- Returns the number of bytes required on
the server to store the data for the specified column
- getColumnList(self, table, wild)
- Generates a result set containing the columns of "table",
which match the pattern "wild".
The result set will contain the following columns:
* column_name
* data_type
* character_maximum_length
* numeric_precision
* numeric_scale
* is_nullable
* column_key
* column_default
* extra
If "wild" is empty or None then a list of all columns
of "table" will be returned.
If SQL Relay doesn't support getting a list of columns
for the current database backend (or the database doesn't)
then an empty result set will be returned.
- getColumnName(self, col)
- Returns the name of the specified column.
- getColumnNames(self)
- Returns a list of column names in the current result set.
- getColumnPrecision(self, col)
- Returns the precision of the specified column.
Precision is the total number of digits in a number.
eg: 123.45 has a precision of 5. For non-numeric
types, it's the number of characters in the string.
- getColumnScale(self, col)
- Returns the scale of the specified column. Scale is
the total number of digits to the right of the decimal
point in a number. eg: 123.45 has a scale of 2.
- getColumnType(self, col)
- Returns the type of the specified column.
- getDatabaseList(self, wild)
- Generates a result set containing databases that match the
pattern "wild".
The result set will contain the following columns:
* Database
If "wild" is empty or None then a result set
containing all databases will be returned.
May actually return a result set of catalogs or schemas,
depending on whether the backend database equates
"database" with catalog or schema.
See getDatabaseIsSchema().
If SQL Relay doesn't support getting a list of databases
for the current database backend (or the database doesn't)
then an empty result set will be returned.
- getField(self, row, col)
- Returns the specified field as a string.
- getFieldAsBoolean(self, row, col)
- Returns the specified field as a boolean.
- getFieldAsBooleanIgnoringCase(self, row, col)
- Returns the specified field as a boolean,
ignoring the case of "col".
- getFieldAsDateDay(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the day component.
- getFieldAsDateDayIgnoringCase(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the day component,
ignoring the case of "col".
- getFieldAsDateHour(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the hour component.
- getFieldAsDateHourIgnoringCase(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the hour component,
ignoring the case of "col".
- getFieldAsDateIsNegative(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns whether the hour component
is negative.
- getFieldAsDateIsNegativeIgnoringCase(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns whether the hour component
is negative, ignoring the case of "col".
- getFieldAsDateMicrosecond(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the microsecond component.
- getFieldAsDateMicrosecondIgnoringCase(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the microsecond component,
ignoring the case of "col".
- getFieldAsDateMinute(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the minute component.
- getFieldAsDateMinuteIgnoringCase(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the minute component,
ignoring the case of "col".
- getFieldAsDateMonth(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the month component.
- getFieldAsDateMonthIgnoringCase(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the month component,
ignoring the case of "col".
- getFieldAsDateSecond(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the second component.
- getFieldAsDateSecondIgnoringCase(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the second component,
ignoring the case of "col".
- getFieldAsDateYear(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the year component.
- getFieldAsDateYearIgnoringCase(self, row, col, ddmm=None, yyyyddmm=None, datedelimiters=None)
- Interprets the specified field as a date
and returns the year component,
ignoring the case of "col".
- getFieldAsDouble(self, row, col)
- Returns the specified field as a decimal.
- getFieldAsDoubleIgnoringCase(self, row, col)
- Returns the specified field as a decimal, ignoring
the case of "col".
- getFieldAsInteger(self, row, col)
- Returns the specified field as an integer.
- getFieldAsIntegerIgnoringCase(self, row, col)
- Returns the specified field as an integer, ignoring
the case of "col".
- getFieldIgnoringCase(self, row, col)
- Returns the specified field as a string,
ignoring the case of "col".
- getFieldLength(self, row, col)
- Returns the length of the specified field.
- getKeyAndIndexList(self, table, wild)
- Generates a result set containing the keys and indexes of
"table", which match the pattern "wild".
The result set will contain the following columns:
* table
* non_unique
* key_name
* seq_in_index
* column_name
* collation
* cardinality
* sub_part
* packed
* null
* index_type
* comment
* index_comment
If "wild" is empty or None then a result set
containing all keys and indexes of "table" will be
returned.
If SQL Relay doesn't support getting a list of keys and
indexes for the current database backend (or the database
doesn't) then an empty result set will be returned.
- getLongest(self, col)
- Returns the length of the longest field
in the specified column.
- getNullsAsEmptyStrings(self)
- Tells the connection to return NULL fields
and output bind variables as empty strings.
This is the default.
- getNullsAsNone(self)
- Tells the connection to return NULL fields
and output bind variables as None rather
than as empty strings.
- getOutputBindBlob(self, variable)
- Get the value stored in a previously
defined binary lob output bind variable.
- getOutputBindClob(self, variable)
- Get the value stored in a previously
defined character lob output bind variable.
- getOutputBindCursor(self, variable)
- Get the cursor associated with a previously
defined output bind variable.
- getOutputBindDateDay(self, variable)
- Get the day from a previously defined
date output bind variable.
- getOutputBindDateHour(self, variable)
- Get the hour from a previously defined
date output bind variable.
- getOutputBindDateIsNegative(self, variable)
- Get whether the value is negative from a
previously defined date output bind variable.
- getOutputBindDateMicrosecond(self, variable)
- Get the microsecond from a previously defined
date output bind variable.
- getOutputBindDateMinute(self, variable)
- Get the minute from a previously defined
date output bind variable.
- getOutputBindDateMonth(self, variable)
- Get the month from a previously defined
date output bind variable.
- getOutputBindDateSecond(self, variable)
- Get the second from a previously defined
date output bind variable.
- getOutputBindDateTz(self, variable)
- Get the time zone from a previously
defined date output bind variable.
- getOutputBindDateYear(self, variable)
- Get the year from a previously defined
date output bind variable.
- getOutputBindDouble(self, variable)
- Get the value stored in a previously
defined decimal output bind variable.
- getOutputBindInteger(self, variable)
- Get the value stored in a previously
defined integer output bind variable.
- getOutputBindLength(self, variable)
- Get the length of the value stored in a
previously defined output bind variable.
- getOutputBindString(self, variable)
- Get the value stored in a previously
defined string output bind variable.
- getPrimaryKeysList(self, table, wild)
- Generates a result set containing the primary keys of
"table", which match the pattern "wild".
The result set will contain the following columns:
* table
* non_unique
* key_name
* seq_in_index
* column_name
* collation
* cardinality
* sub_part
* packed
* null
* index_type
* comment
* index_comment
If "wild" is empty or None then a result set containing
all primary keys of "table" will be returned.
If SQL Relay doesn't support getting a list of primary keys
for the current database backend (or the database doesn't)
then an empty result set will be returned.
- getProcedureList(self, wild)
- Generates a result set containing procedures that match the
pattern "wild".
The result set will contain the following columns:
* routine_catalog
* routine_schema
* routine_name
* data_type
If "wild" is empty or None then a result set
containing all procedures in the current database/schema
will be returned.
If SQL Relay doesn't support getting a list of procedures
for the current database backend (or the database doesn't)
then an empty result set will be returned.
- getProcedureParameterList(self, procedure, wild)
- Generates a result set containing the parameters of
"procedure", which match the pattern "wild".
The result set will contain the following columns:
* parameter_name
* parameter_mode
* data_type
* character_maximum_length
* ordinal_position
If "wild" is empty or None then a result set
containing all parameters of "procedure" will be returned.
If SQL Relay doesn't support getting a list of procedure
parameters for the current database backend (or the
database doesn't) then an empty result set will be
returned.
- getResultSetBufferSize(self)
- Returns the number of result set rows that
will be buffered at a time or 0 for the
entire result set.
- getResultSetId(self)
- Returns the internal ID of this result set.
This parameter may be passed to another
cursor for use in the resumeResultSet()
method.
Note: The value this method returns is only
valid after a call to suspendResultSet().
- getRow(self, row)
- Returns a list of values in the given row.
- getRowDictionary(self, row)
- Returns the requested row as values in a dictionary
with column names for keys.
- getRowLengths(self, row)
- Returns a list of lengths in the given row.
- getRowLengthsDictionary(self, row)
- Returns the requested row lengths as values in a dictionary
with column names for keys.
- getRowLengthsRange(self, beg, end)
- Returns a list of lists of the lengths of rows between beg and end.
Note: this function has no equivalent in other SQL Relay API's.
- getRowRange(self, beg, end)
- Returns a list of lists of the rows between beg and end.
Note: this function has no equivalent in other SQL Relay API's.
- getSchemaList(self, wild)
- Generates a result set containing schemas that match the
pattern "wild".
The result set will contain the following columns:
* Database
(The column name is a bit of a misnomer, the results are
schemas, not databases.)
If "wild" is empty or None then a result set containing
all schemas in the current database will be returned.
If SQL Relay doesn't support getting a list of schemas
for the current database backend (or the database doesn't)
then an empty result set will be returned.
- getTableList(self, wild)
- Generates a result set containing the tables in the current
database and schema that match the pattern "wild".
The result set will contain the following columns:
* Tables_in_xxx
If "wild" is empty or None then a result set containing
all tables in the current database/schema will be returned.
If SQL Relay doesn't support getting a list of tables
for the current database backend (or the database doesn't)
then an empty result set will be returned.
- getTableTypeList(self)
- Generates a result set containing supported table types.
The result set will contain the following columns:
* table_type
If SQL Relay doesn't support getting a list of table types
for the current database backend (or the database doesn't)
then an empty result set will be returned.
- getTypeInfoList(self, type)
- Generates a result set containing data type information for
"type".
The result set will contain the following columns:
* type_name
* data_type
* precision
* literal_prefix
* literal_suffix
* create_params
* nullable
* case_sensitive
* searchable
* unsigned_attribute
* fixed_prec_scale
* auto_increment
* local_type_name
* minumum_scale
* maxiumm_scale
* sql_data_type
* sql_datetime_sub
* num_prec_radix
* interval_precision
If "type" is empty or None then a result set containing
all data types in the current databas/schema will be
returned.
If SQL Relay doesn't support getting type info
for the current database backend (or the database doesn't)
then an empty result set will be returned.
- inputBind(self, variable, value, precision=0, scale=0)
- Define an input bind varaible.
Returns true if the variable was successfully bound or false if the
variable isn't a string, integer or decimal. If the value is a decimal
then precision and scale may also be specified. If you don't have the
precision and scale then set them both to 0. However in that case you
may get unexpected rounding behavior if the server is faking binds.
- inputBindBlob(self, variable, value, length)
- Defines a binary lob input bind variable.
- inputBindClob(self, variable, value, length)
- Defines a character lob input bind variable.
- inputBindDate(self, variable, year, month, day, hour, minute, second, microsecond, tz, isnegative)
- Defines a date input bind variable. "day" and "month"
are 1-based.
Some databases distinguish between date, time, and
datetime types. For those databases...
* The input bind variable will be interpreted as a time type
if year and/or month are negative.
* The input bind variable will be interpreted as a date type
if hour, minute, second, and/or microsecond are negative.
* The input bind variable will be interpreted as a datetime
type if all parts are positive.
"tz" is the timezone abbreviation, and may be left None.
Most databases ignore "tz".
Set "isnegative" may be set to true to represent a negative
time interval. However, few databases support negative
time intervals and ignore "isnegative".
- inputBinds(self, variables, values, precisions=None, scales=None)
- Define input bind variables.
Returns true if the variables were successfully bound or false if one
of the variables wasn't a string, integer or floating point number,
or if precision and scale weren't provided for a floating point number.
- lowerCaseColumnNames(self)
- Columns names are converted to lower case.
- mixedCaseColumnNames(self)
- Columns names are returned in the same
case as they are defined in the database.
This is the default.
- nextResultSet(self)
- Returns true and acts like executeQuery()
when there is another result set available
from the server.
- openCachedResultSet(self, filename)
- Opens a cached result set.
Returns true on success and false on failure.
- prepareFileQuery(self, path, file)
- Prepare to execute the contents
of "path"/"filename". Returns false if the
// file couldn't be opened.
- prepareQuery(self, query)
- Prepare to execute "query".
- prepareQueryWithLength(self, query, length)
- Prepare to execute "query" with length
"length". This method must be used if the
query contains binary data.
- resumeCachedResultSet(self, id, filename)
- Resumes a result set previously left open
using suspendSession() and continues caching
the result set to "filename".
Returns true on success and false on failure.
- resumeResultSet(self, id)
- Resumes a result set previously left open
using suspendSession().
Returns true on success and false on failure.
- rowCount(self)
- Returns the number of rows in the current
result set (if the result set is being
stepped through, this returns the number
of rows processed so far).
- sendFileQuery(self, path, file)
- Sends the query in file "path"/"filename" directly
and gets a result set.
- sendQuery(self, query)
- Sends "query" directly and gets a result set.
- sendQueryWithLength(self, query, length)
- Sends "query" with length "length" directly
and gets a result set. This method must be used
if the query contains binary data.
- setCacheTtl(self, ttl)
- Sets the time-to-live for cached result
sets. The sqlr-cachemanger will remove each
cached result set "ttl" seconds after it's
created, provided it's scanning the directory
containing the cache files.
- setResultSetBufferSize(self, rows)
- Sets the number of rows of the result set
to buffer at a time. 0 (the default)
means buffer the entire result set.
- substitution(self, variable, value, precision=0, scale=0)
- Define a substitution variable.
Returns true if the variable was successfully substituted or false if
the variable isn't a string, integer or floating point number, or if
precision and scale aren't provided for a floating point number.
- substitutions(self, variables, values, precisions=None, scales=None)
- Define substitution variables.
Returns true if the variables were successfully substituted or false if
one of the variables wasn't a string, integer or floating point number,
or if precision and scale weren't provided for a floating point number.
- suspendResultSet(self)
- Tells the server to leave this result
set open when the connection calls
suspendSession() so that another connection
can connect to it using resumeResultSet()
after it calls resumeSession().
- totalRows(self)
- Returns the total number of rows that will
be returned in the result set. Not all
databases support this call. Don't use it
for applications which are designed to be
portable across databases. 0 is returned
by databases which don't support this option.
- upperCaseColumnNames(self)
- Columns names are converted to upper case.
- validBind(self, variable)
- Returns true if "variable" was a valid
bind variable of the query.
- validateBinds(self)
- If you are binding to any variables that
might not actually be in your query, call
this to ensure that the database won't try
to bind them unless they really are in the
query. There is a performance penalty for
calling this method.
Data descriptors defined here:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
| |