Source code for google.cloud.bigquery.dbapi.connection
# Copyright 2017 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Connection for the Google BigQuery DB-API."""
from google.cloud import bigquery
from google.cloud.bigquery.dbapi import cursor
[docs]class Connection(object):
"""DB-API Connection to Google BigQuery.
:type client: :class:`~google.cloud.bigquery.Client`
:param client: A client used to connect to BigQuery.
"""
def __init__(self, client):
self._client = client
[docs] def close(self):
"""No-op."""
[docs] def commit(self):
"""No-op."""
[docs] def cursor(self):
"""Return a new cursor object.
:rtype: :class:`~google.cloud.bigquery.dbapi.Cursor`
:returns: A DB-API cursor that uses this connection.
"""
return cursor.Cursor(self)
[docs]def connect(client=None):
"""Construct a DB-API connection to Google BigQuery.
:type client: :class:`~google.cloud.bigquery.Client`
:param client:
(Optional) A client used to connect to BigQuery. If not passed, a
client is created using default options inferred from the environment.
:rtype: :class:`~google.cloud.bigquery.dbapi.Connection`
:returns: A new DB-API connection to BigQuery.
"""
if client is None:
client = bigquery.Client()
return Connection(client)