Package @google-cloud/bigquery (5.9.3)

Classes

BigQuery

In the following examples from this page and the other modules (Dataset, Table, etc.), we are going to be using a dataset from data.gov of higher education institutions.

We will create a table with the correct schema, import the public CSV file into that table, and query it for data.

See What is BigQuery?

BigQueryDate

Date class for BigQuery.

BigQueryDatetime

Datetime class for BigQuery.

BigQueryInt

Build a BigQueryInt object. For long integers, a string can be provided.

BigQueryTime

Time class for BigQuery.

BigQueryTimestamp

Timestamp class for BigQuery.

Dataset

Interact with your BigQuery dataset. Create a Dataset instance with or .

Geography

Geography class for BigQuery.

Job

Job objects are returned from various places in the BigQuery API:

They can be used to check the status of a running job or fetching the results of a previously-executed one.

Model

Model objects are returned by methods such as and .

Routine

Routine objects are returned by methods such as , , and .

Table

Table objects are returned by methods such as , , and .

Interfaces

BigQueryDateOptions

BigQueryDatetimeOptions

BigQueryOptions

BigQueryTimeOptions

DatasetDeleteOptions

DatasetOptions

File

InsertRow

IntegerTypeCastOptions

Json

PagedCallback

PartialInsertFailure

ProvidedTypeStruct

RequestCallback

ResourceCallback

TableOptions

Variables

PROTOCOL_REGEX

PROTOCOL_REGEX: RegExp

Type Aliases

CancelCallback

export declare type CancelCallback = RequestCallback

CancelResponse

export declare type CancelResponse = [bigquery.IJobCancelResponse];

CopyTableMetadata

export declare type CopyTableMetadata = JobRequest

CreateCopyJobMetadata

export declare type CreateCopyJobMetadata = CopyTableMetadata;

CreateDatasetOptions

export declare type CreateDatasetOptions = bigquery.IDataset;

CreateExtractJobOptions

export declare type CreateExtractJobOptions = JobRequest

DatasetCallback

export declare type DatasetCallback = ResourceCallback

DatasetResource

export declare type DatasetResource = bigquery.IDataset;

DatasetResponse

export declare type DatasetResponse = [Dataset, bigquery.IDataset];

DatasetsCallback

export declare type DatasetsCallback = PagedCallback

DatasetsResponse

export declare type DatasetsResponse = PagedResponse

FormattedMetadata

export declare type FormattedMetadata = bigquery.ITable;

GetDatasetsOptions

export declare type GetDatasetsOptions = PagedRequest

GetJobsCallback

export declare type GetJobsCallback = PagedCallback

GetJobsOptions

export declare type GetJobsOptions = PagedRequest

GetJobsResponse

export declare type GetJobsResponse = PagedResponse

GetModelsCallback

export declare type GetModelsCallback = PagedCallback

GetModelsOptions

export declare type GetModelsOptions = PagedRequest

GetModelsResponse

export declare type GetModelsResponse = PagedResponse

GetPolicyOptions

export declare type GetPolicyOptions = bigquery.IGetPolicyOptions;

GetRoutinesCallback

export declare type GetRoutinesCallback = PagedCallback

GetRoutinesOptions

export declare type GetRoutinesOptions = PagedRequest

GetRoutinesResponse

export declare type GetRoutinesResponse = PagedResponse

GetRowsOptions

export declare type GetRowsOptions = PagedRequest

GetTablesCallback

export declare type GetTablesCallback = PagedCallback

GetTablesOptions

export declare type GetTablesOptions = PagedRequest

GetTablesResponse

export declare type GetTablesResponse = PagedResponse

InsertRowsCallback

export declare type InsertRowsCallback = RequestCallback

InsertRowsOptions

export declare type InsertRowsOptions = bigquery.ITableDataInsertAllRequest & {
    createInsertId?: boolean;
    partialRetries?: number;
    raw?: boolean;
    schema?: string | {};
};

InsertRowsResponse

export declare type InsertRowsResponse = [bigquery.ITableDataInsertAllResponse | bigquery.ITable];

IntegerTypeCastValue

export declare type IntegerTypeCastValue = {
    integerValue: string | number;
    schemaFieldName?: string;
};

JobCallback

export declare type JobCallback = ResourceCallback

JobLoadMetadata

export declare type JobLoadMetadata = JobRequest

JobMetadata

export declare type JobMetadata = bigquery.IJob;

JobMetadataCallback

export declare type JobMetadataCallback = RequestCallback

JobMetadataResponse

export declare type JobMetadataResponse = [JobMetadata];

JobOptions

export declare type JobOptions = JobRequest

JobRequest

export declare type JobRequest
Type Parameter
TypeDescription
J

JobResponse

export declare type JobResponse = [Job, bigquery.IJob];

PagedRequest

export declare type PagedRequest
 = P & {
    autoPaginate?: boolean;
    maxApiCalls?: number;
};
Type Parameter
TypeDescription
P

PagedResponse

export declare type PagedResponse
Type Parameters
TypeDescription
T
Q
R

PermissionsCallback

export declare type PermissionsCallback = RequestCallback

PermissionsResponse

export declare type PermissionsResponse = [bigquery.ITestIamPermissionsResponse];

Policy

export declare type Policy = bigquery.IPolicy;

PolicyCallback

export declare type PolicyCallback = RequestCallback

PolicyRequest

export declare type PolicyRequest = bigquery.IGetIamPolicyRequest;

PolicyResponse

export declare type PolicyResponse = [Policy];

ProvidedTypeArray

export declare type ProvidedTypeArray = Array

Query

export declare type Query = JobRequest

QueryOptions

export declare type QueryOptions = QueryResultsOptions;

QueryParameter

export declare type QueryParameter = bigquery.IQueryParameter;

QueryResultsOptions

export declare type QueryResultsOptions = {
    job?: Job;
    wrapIntegers?: boolean | IntegerTypeCastOptions;
} & PagedRequest

QueryRowsCallback

export declare type QueryRowsCallback = PagedCallback

QueryRowsResponse

export declare type QueryRowsResponse = PagedResponse

QueryStreamOptions

export declare type QueryStreamOptions = {
    wrapIntegers?: boolean | IntegerTypeCastOptions;
};

RoutineCallback

export declare type RoutineCallback = ResourceCallback

RoutineMetadata

export declare type RoutineMetadata = bigquery.IRoutine;

RoutineResponse

export declare type RoutineResponse = [Routine, bigquery.IRoutine];

RowMetadata

export declare type RowMetadata = any;

RowsCallback

export declare type RowsCallback = PagedCallback

RowsResponse

export declare type RowsResponse = PagedResponse

SetPolicyOptions

export declare type SetPolicyOptions = Omit

SetTableMetadataOptions

export declare type SetTableMetadataOptions = TableMetadata;

SimpleQueryRowsCallback

export declare type SimpleQueryRowsCallback = ResourceCallback

SimpleQueryRowsResponse

export declare type SimpleQueryRowsResponse = [RowMetadata[], bigquery.IJob];

TableCallback

export declare type TableCallback = ResourceCallback

TableField

export declare type TableField = bigquery.ITableFieldSchema;

TableMetadata

export declare type TableMetadata = bigquery.ITable & {
    name?: string;
    schema?: string | TableField[] | TableSchema;
    partitioning?: string;
    view?: string | ViewDefinition;
};

TableResponse

export declare type TableResponse = [Table, bigquery.ITable];

TableRow

export declare type TableRow = bigquery.ITableRow;

TableRowField

export declare type TableRowField = bigquery.ITableCell;

TableRowValue

export declare type TableRowValue = string | TableRow;

TableSchema

export declare type TableSchema = bigquery.ITableSchema;

ValueType

export declare type ValueType = bigquery.IQueryParameterType;

ViewDefinition

export declare type ViewDefinition = bigquery.IViewDefinition;