Package dbapi (1.19.0)

API documentation for bigquery.dbapi package.

Classes

Connection

DB-API Connection to Google BigQuery.

Cursor

DB-API Cursor to Google BigQuery.

DataError

DB-API error due to problems with the processed data.

DatabaseError

DB-API error related to the database.

Error

Exception representing all non-warning DB-API errors.

IntegrityError

DB-API error when integrity of the database is affected.

InterfaceError

DB-API error related to the database interface.

InternalError

DB-API error when the database encounters an internal error.

NotSupportedError

DB-API error for operations not supported by the database or API.

OperationalError

DB-API error related to the database operation.

These errors are not necessarily under the control of the programmer.

ProgrammingError

DB-API exception raised for programming errors.

Warning

Exception raised for important DB-API warnings.

Packages Functions

Binary

Binary(string)

Contruct a DB-API binary value.

Parameter
NameDescription
string

A string to encode as a binary value.

DateFromTicks

DateFromTicks(timestamp, /)

Create a date from a POSIX timestamp.

The timestamp is a number, e.g. created via time.time(), that is interpreted as local time.

TimeFromTicks

TimeFromTicks(ticks, tz=None)

Construct a DB-API time value from the given ticks value.

Parameters
NameDescription
ticks

a number of seconds since the epoch; see the documentation of the standard Python time module for details.

tz

(Optional) time zone to use for conversion

TimestampFromTicks

timestamp[, tz] -> tz's local time from POSIX timestamp.

connect

connect(client=None)

Construct a DB-API connection to Google BigQuery.

Parameter
NameDescription
client

(Optional) A client used to connect to BigQuery. If not passed, a client is created using default options inferred from the environment.