Class Connection (3.18.0)

Version 3.18.0

• 3.27.0 (latest)
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.1
• 3.22.0
• 3.21.0
• 3.20.1
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.0
• 3.15.0
• 3.14.1
• 3.13.0
• 3.12.0
• 3.11.4
• 3.4.0
• 3.3.6
• 3.2.0
• 3.1.0
• 3.0.1
• 2.34.4
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.1
• 2.29.0
• 2.28.1
• 2.27.1
• 2.26.0
• 2.25.2
• 2.24.1
• 2.23.3
• 2.22.1
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.0
• 2.0.0
• 1.28.2
• 1.27.2
• 1.26.1
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0

Connection(client=None, bqstorage_client=None)

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). If both clients are available, bqstorage_client is used for fetching query results.

Methods

close

close()

Close the connection and any cursors created from it.

Any BigQuery clients explicitly passed to the constructor are not closed, only those created by the connection instance itself.

commit

commit()

No-op, but for consistency raise an error if connection is closed.

cursor

cursor()

Return a new cursor object.

Returns
Type	Description
google.cloud.bigquery.dbapi.Cursor	A DB-API cursor that uses this connection.