BigQuery

Integration with Google BigQuery using the BigQuery Emulator

This integration uses the official Google Cloud BigQuery Python Client for testing against the BigQuery Emulator. The emulator is a third-party project that provides a local development environment that mimics the behavior of BigQuery, allowing you to test your application without connecting to the actual service.

Installation

pip install pytest-databases[bigquery]

Usage Example

from google.cloud import bigquery
from pytest_databases.docker.bigquery import BigQueryService

pytest_plugins = ["pytest_databases.docker.bigquery"]

def test(bigquery_service: BigQueryService) -> None:
    client = bigquery.Client(
        project=bigquery_service.project,
        client_options=bigquery_service.client_options,
        credentials=bigquery_service.credentials,
    )

    job = client.query(query="SELECT 1 as one")
    resp = list(job.result())
    assert resp[0].one == 1

def test(bigquery_client: bigquery.Client) -> None:
    assert isinstance(bigquery_client, bigquery.Client)

Available Fixtures

• bigquery_image: The Docker image to use for BigQuery.

• bigquery_service: A fixture that provides a BigQuery service.

• bigquery_client: A fixture that provides a BigQuery client.

Service API

pytest_databases.docker.bigquery.xdist_bigquery_isolation_level()

Return type:

Literal['database', 'server']

pytest_databases.docker.bigquery.bigquery_image()

Return type:

str

class pytest_databases.docker.bigquery.BigQueryService(host, port, project, dataset, credentials)

Bases: ServiceContainer

project: str

dataset: str

credentials: Credentials

property endpoint: str

property client_options: ClientOptions

__init__(host, port, project, dataset, credentials)

pytest_databases.docker.bigquery.bigquery_service(docker_service, xdist_bigquery_isolation_level, bigquery_image)

Return type:

Generator[BigQueryService, None, None]

pytest_databases.docker.bigquery.bigquery_client(bigquery_service)

Return type:

Generator[Client, None, None]