Package dbapi (3.36.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(data)

Contruct a DB-API binary value.

Parameter
Name Description
data bytes-like

An object containing binary data and that can be converted to bytes with the bytes builtin.

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
Name Description
ticks float

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

(Optional) time zone to use for conversion

TimestampFromTicks

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

connect

connect(client=None, bqstorage_client=None, prefer_bqstorage_client=True)

Construct a DB-API connection to Google BigQuery.

Parameters
Name Description
client Optional[google.cloud.bigquery.Client]

A REST API client used to connect to BigQuery. If not passed, a client is created using default options inferred from the environment.
bqstorage_client Optional[google.cloud.bigquery_storage_v1.BigQueryReadClient]

A client that uses the faster BigQuery Storage API to fetch rows from BigQuery. If not passed, it is created using the same credentials as client (provided that BigQuery Storage dependencies are installed).
prefer_bqstorage_client Optional[bool]

Prefer the BigQuery Storage client over the REST client. If Storage client isn't available, fall back to the REST client. Defaults to True.