API Reference¶
phoenixdb module¶
-
phoenixdb.
connect
(url, max_retries=None, **kwargs)¶ Connects to a Phoenix query server.
Parameters: - url – URL to the Phoenix query server, e.g.
http://localhost:8765/
- autocommit – Switch the connection to autocommit mode.
- readonly – Switch the connection to readonly mode.
- max_retries – The maximum number of retries in case there is a connection error.
- cursor_factory – If specified, the connection’s
cursor_factory
is set to it.
Returns: Connection
object.- url – URL to the Phoenix query server, e.g.
-
phoenixdb.
Date
(year, month, day)¶ Constructs an object holding a date value.
-
phoenixdb.
Time
(hour, minute, second)¶ Constructs an object holding a time value.
-
phoenixdb.
Timestamp
(year, month, day, hour, minute, second)¶ Constructs an object holding a datetime/timestamp value.
-
phoenixdb.
DateFromTicks
(ticks)¶ Constructs an object holding a date value from the given UNIX timestamp.
-
phoenixdb.
TimeFromTicks
(ticks)¶ Constructs an object holding a time value from the given UNIX timestamp.
-
phoenixdb.
TimestampFromTicks
(ticks)¶ Constructs an object holding a datetime/timestamp value from the given UNIX timestamp.
-
phoenixdb.
Binary
(value)¶ Constructs an object capable of holding a binary (long) string value.
-
class
phoenixdb.
TypeHelper
¶ -
static
from_class
(klass)¶ Retrieves a Rep and functions to cast to/from based on the Java class.
Parameters: klass – The string of the Java class for the column or parameter. Returns: tuple (field_name, rep, mutate_to, cast_from)
WHEREfield_name
is the attribute incommon_pb2.TypedValue
rep
is the common_pb2.Rep enummutate_to
is the function to cast values into Phoenix values, if anycast_from
is the function to cast from the Phoenix value to the Python value, if anyRaises: NotImplementedError
-
static
-
exception
phoenixdb.
Warning
¶ Not used by this package, only defined for compatibility with DB API 2.0.
-
exception
phoenixdb.
Error
(message, code=None, sqlstate=None, cause=None)¶ Exception that is the base class of all other error exceptions. You can use this to catch all errors with one single except statement.
-
cause
¶
-
code
¶
-
message
¶
-
sqlstate
¶
-
-
exception
phoenixdb.
InterfaceError
(message, code=None, sqlstate=None, cause=None)¶ Exception raised for errors that are related to the database interface rather than the database itself.
-
exception
phoenixdb.
DatabaseError
(message, code=None, sqlstate=None, cause=None)¶ Exception raised for errors that are related to the database.
-
exception
phoenixdb.
DataError
(message, code=None, sqlstate=None, cause=None)¶ Exception raised for errors that are due to problems with the processed data like division by zero, numeric value out of range, etc.
-
exception
phoenixdb.
OperationalError
(message, code=None, sqlstate=None, cause=None)¶ Raised for errors that are related to the database’s operation and not necessarily under the control of the programmer, e.g. an unexpected disconnect occurs, the data source name is not found, a transaction could not be processed, a memory allocation error occurred during processing, etc.
-
exception
phoenixdb.
IntegrityError
(message, code=None, sqlstate=None, cause=None)¶ Raised when the relational integrity of the database is affected, e.g. a foreign key check fails.
-
exception
phoenixdb.
InternalError
(message, code=None, sqlstate=None, cause=None)¶ Raised when the database encounters an internal problem.
-
exception
phoenixdb.
ProgrammingError
(message, code=None, sqlstate=None, cause=None)¶ Raises for programming errors, e.g. table not found, syntax error, etc.
-
exception
phoenixdb.
NotSupportedError
(message, code=None, sqlstate=None, cause=None)¶ Raised when using an API that is not supported by the database.
phoenixdb.connection module¶
-
class
phoenixdb.connection.
Connection
(client, cursor_factory=None, **kwargs)¶ Database connection.
You should not construct this object manually, use
connect()
instead.-
exception
DataError
(message, code=None, sqlstate=None, cause=None)¶ Exception raised for errors that are due to problems with the processed data like division by zero, numeric value out of range, etc.
-
exception
DatabaseError
(message, code=None, sqlstate=None, cause=None)¶ Exception raised for errors that are related to the database.
-
exception
Error
(message, code=None, sqlstate=None, cause=None)¶ Exception that is the base class of all other error exceptions. You can use this to catch all errors with one single except statement.
-
cause
¶
-
code
¶
-
message
¶
-
sqlstate
¶
-
-
exception
IntegrityError
(message, code=None, sqlstate=None, cause=None)¶ Raised when the relational integrity of the database is affected, e.g. a foreign key check fails.
-
exception
InterfaceError
(message, code=None, sqlstate=None, cause=None)¶ Exception raised for errors that are related to the database interface rather than the database itself.
-
exception
InternalError
(message, code=None, sqlstate=None, cause=None)¶ Raised when the database encounters an internal problem.
-
exception
NotSupportedError
(message, code=None, sqlstate=None, cause=None)¶ Raised when using an API that is not supported by the database.
-
exception
OperationalError
(message, code=None, sqlstate=None, cause=None)¶ Raised for errors that are related to the database’s operation and not necessarily under the control of the programmer, e.g. an unexpected disconnect occurs, the data source name is not found, a transaction could not be processed, a memory allocation error occurred during processing, etc.
-
exception
ProgrammingError
(message, code=None, sqlstate=None, cause=None)¶ Raises for programming errors, e.g. table not found, syntax error, etc.
-
exception
Warning
¶ Not used by this package, only defined for compatibility with DB API 2.0.
-
autocommit
¶ Read/write attribute for switching the connection’s autocommit mode.
-
close
()¶ Closes the connection. No further operations are allowed, either on the connection or any of its cursors, once the connection is closed.
If the connection is used in a
with
statement, this method will be automatically called at the end of thewith
block.
-
closed
¶ Read-only attribute specifying if the connection is closed or not.
-
commit
()¶ Commits pending database changes.
Currently, this does nothing, because the RPC does not support transactions. Only defined for DB API 2.0 compatibility. You need to use
autocommit
mode.
-
cursor
(cursor_factory=None)¶ Creates a new cursor.
Parameters: cursor_factory – This argument can be used to create non-standard cursors. The class returned must be a subclass of Cursor
(for exampleDictCursor
). A default factory for the connection can also be specified using thecursor_factory
attribute.Returns: A Cursor
object.
-
cursor_factory
= None¶
-
open
()¶ Opens the connection.
-
readonly
¶ Read/write attribute for switching the connection’s readonly mode.
-
set_session
(autocommit=None, readonly=None)¶ Sets one or more parameters in the current connection.
Parameters: - autocommit – Switch the connection to autocommit mode. With the current
version, you need to always enable this, because
commit()
is not implemented. - readonly – Switch the connection to read-only mode.
- autocommit – Switch the connection to autocommit mode. With the current
version, you need to always enable this, because
-
transactionisolation
¶
-
exception
phoenixdb.cursor module¶
-
class
phoenixdb.cursor.
Cursor
(connection, id=None)¶ Database cursor for executing queries and iterating over results.
You should not construct this object manually, use
Connection.cursor()
instead.-
arraysize
= 1¶
-
close
()¶ Closes the cursor. No further operations are allowed once the cursor is closed.
If the cursor is used in a
with
statement, this method will be automatically called at the end of thewith
block.
-
closed
¶ Read-only attribute specifying if the cursor is closed or not.
-
connection
¶ Read-only attribute providing access to the
Connection
object this cursor was created from.
-
description
¶
-
execute
(operation, parameters=None)¶
-
executemany
(operation, seq_of_parameters)¶
-
fetchall
()¶
-
fetchmany
(size=None)¶
-
fetchone
()¶
-
itersize
= 2000¶
-
next
()¶
-
rowcount
¶ Read-only attribute specifying the number of rows affected by the last executed DML statement or -1 if the number cannot be determined. Note that this will always be set to -1 for select queries.
-
rownumber
¶ Read-only attribute providing the current 0-based index of the cursor in the result set or
None
if the index cannot be determined.The index can be seen as index of the cursor in a sequence (the result set). The next fetch operation will fetch the row indexed by
rownumber
in that sequence.
-
setinputsizes
(sizes)¶
-
setoutputsize
(size, column=None)¶
-
-
class
phoenixdb.cursor.
ColumnDescription
(name, type_code, display_size, internal_size, precision, scale, null_ok)¶ -
display_size
¶ Alias for field number 2
-
internal_size
¶ Alias for field number 3
-
name
¶ Alias for field number 0
-
null_ok
¶ Alias for field number 6
-
precision
¶ Alias for field number 4
-
scale
¶ Alias for field number 5
-
type_code
¶ Alias for field number 1
-
-
class
phoenixdb.cursor.
DictCursor
(connection, id=None)¶ A cursor which returns results as a dictionary