Package @google-cloud/bigquery (6.0.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 fromdata.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.
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 .
RowBatch
Call used to help batch rows.
RowQueue
Standard row queue used for inserting rows.
Table
Table objects are returned by methods such as , , and .
Interfaces
BigQueryDateOptions
BigQueryDatetimeOptions
BigQueryOptions
BigQueryTimeOptions
DatasetDeleteOptions
DatasetOptions
File
InsertRow
InsertStreamOptions
IntegerTypeCastOptions
Json
PagedCallback
PartialInsertFailure
ProvidedTypeStruct
RequestCallback
ResourceCallback
TableOptions
Variables
PROTOCOL_REGEX
PROTOCOL_REGEX:RegExpType Aliases
CancelCallback
exportdeclaretypeCancelCallback=RequestCallbackCancelResponse
exportdeclaretypeCancelResponse=[bigquery.IJobCancelResponse];CopyTableMetadata
exportdeclaretypeCopyTableMetadata=JobRequestCreateCopyJobMetadata
exportdeclaretypeCreateCopyJobMetadata=CopyTableMetadata;CreateDatasetOptions
exportdeclaretypeCreateDatasetOptions=bigquery.IDataset;CreateExtractJobOptions
exportdeclaretypeCreateExtractJobOptions=JobRequestDatasetCallback
exportdeclaretypeDatasetCallback=ResourceCallbackDatasetResource
exportdeclaretypeDatasetResource=bigquery.IDataset;DatasetResponse
exportdeclaretypeDatasetResponse=[Dataset,bigquery.IDataset];DatasetsCallback
exportdeclaretypeDatasetsCallback=PagedCallbackDatasetsResponse
exportdeclaretypeDatasetsResponse=PagedResponseFormattedMetadata
exportdeclaretypeFormattedMetadata=bigquery.ITable;GetDatasetsOptions
exportdeclaretypeGetDatasetsOptions=PagedRequestGetJobsCallback
exportdeclaretypeGetJobsCallback=PagedCallbackGetJobsOptions
exportdeclaretypeGetJobsOptions=PagedRequestGetJobsResponse
exportdeclaretypeGetJobsResponse=PagedResponseGetModelsCallback
exportdeclaretypeGetModelsCallback=PagedCallbackGetModelsOptions
exportdeclaretypeGetModelsOptions=PagedRequestGetModelsResponse
exportdeclaretypeGetModelsResponse=PagedResponseGetPolicyOptions
exportdeclaretypeGetPolicyOptions=bigquery.IGetPolicyOptions;GetRoutinesCallback
exportdeclaretypeGetRoutinesCallback=PagedCallbackGetRoutinesOptions
exportdeclaretypeGetRoutinesOptions=PagedRequestGetRoutinesResponse
exportdeclaretypeGetRoutinesResponse=PagedResponseGetRowsOptions
exportdeclaretypeGetRowsOptions=PagedRequestGetTablesCallback
exportdeclaretypeGetTablesCallback=PagedCallbackGetTablesOptions
exportdeclaretypeGetTablesOptions=PagedRequestGetTablesResponse
exportdeclaretypeGetTablesResponse=PagedResponseInsertRowsCallback
exportdeclaretypeInsertRowsCallback=RequestCallbackInsertRowsOptions
exportdeclaretypeInsertRowsOptions=bigquery.ITableDataInsertAllRequest &{createInsertId?:boolean;partialRetries?:number;raw?:boolean;schema?:string|{};};InsertRowsResponse
exportdeclaretypeInsertRowsResponse=[bigquery.ITableDataInsertAllResponse|bigquery.ITable];InsertRowsStreamResponse
exportdeclaretypeInsertRowsStreamResponse=bigquery.ITableDataInsertAllResponse;IntegerTypeCastValue
exportdeclaretypeIntegerTypeCastValue={integerValue:string|number;schemaFieldName?:string;};JobCallback
exportdeclaretypeJobCallback=ResourceCallbackJobLoadMetadata
exportdeclaretypeJobLoadMetadata=JobRequestJobMetadata
exportdeclaretypeJobMetadata=bigquery.IJob;JobMetadataCallback
exportdeclaretypeJobMetadataCallback=RequestCallbackJobMetadataResponse
exportdeclaretypeJobMetadataResponse=[JobMetadata];JobOptions
exportdeclaretypeJobOptions=JobRequestJobRequest
exportdeclaretypeJobRequest| Type Parameter | |
|---|---|
| Type | Description |
J | |
JobResponse
exportdeclaretypeJobResponse=[Job,bigquery.IJob];PagedRequest
exportdeclaretypePagedRequest
=P &{autoPaginate?:boolean;maxApiCalls?:number;};
| Type Parameter | |
|---|---|
| Type | Description |
P | |
PagedResponse
exportdeclaretypePagedResponse| Type Parameters | |
|---|---|
| Type | Description |
T | |
Q | |
R | |
PermissionsCallback
exportdeclaretypePermissionsCallback=RequestCallbackPermissionsResponse
exportdeclaretypePermissionsResponse=[bigquery.ITestIamPermissionsResponse];Policy
exportdeclaretypePolicy=bigquery.IPolicy;PolicyCallback
exportdeclaretypePolicyCallback=RequestCallbackPolicyRequest
exportdeclaretypePolicyRequest=bigquery.IGetIamPolicyRequest;PolicyResponse
exportdeclaretypePolicyResponse=[Policy];ProvidedTypeArray
exportdeclaretypeProvidedTypeArray=ArrayQuery
exportdeclaretypeQuery=JobRequestQueryOptions
exportdeclaretypeQueryOptions=QueryResultsOptions;QueryParameter
exportdeclaretypeQueryParameter=bigquery.IQueryParameter;QueryResultsOptions
exportdeclaretypeQueryResultsOptions={job?:Job;wrapIntegers?:boolean|IntegerTypeCastOptions;} &PagedRequestQueryRowsCallback
exportdeclaretypeQueryRowsCallback=PagedCallbackQueryRowsResponse
exportdeclaretypeQueryRowsResponse=PagedResponseQueryStreamOptions
exportdeclaretypeQueryStreamOptions={wrapIntegers?:boolean|IntegerTypeCastOptions;};RoutineCallback
exportdeclaretypeRoutineCallback=ResourceCallbackRoutineMetadata
exportdeclaretypeRoutineMetadata=bigquery.IRoutine;RoutineResponse
exportdeclaretypeRoutineResponse=[Routine,bigquery.IRoutine];RowMetadata
exportdeclaretypeRowMetadata=any;RowsCallback
exportdeclaretypeRowsCallback=PagedCallbackRowsResponse
exportdeclaretypeRowsResponse=PagedResponseSetPolicyOptions
exportdeclaretypeSetPolicyOptions=OmitSetTableMetadataOptions
exportdeclaretypeSetTableMetadataOptions=TableMetadata;SimpleQueryRowsCallback
exportdeclaretypeSimpleQueryRowsCallback=ResourceCallbackSimpleQueryRowsResponse
exportdeclaretypeSimpleQueryRowsResponse=[RowMetadata[],bigquery.IJob];TableCallback
exportdeclaretypeTableCallback=ResourceCallbackTableField
exportdeclaretypeTableField=bigquery.ITableFieldSchema;TableMetadata
exportdeclaretypeTableMetadata=bigquery.ITable &{name?:string;schema?:string|TableField[]|TableSchema;partitioning?:string;view?:string|ViewDefinition;};TableResponse
exportdeclaretypeTableResponse=[Table,bigquery.ITable];TableRow
exportdeclaretypeTableRow=bigquery.ITableRow;TableRowField
exportdeclaretypeTableRowField=bigquery.ITableCell;TableRowValue
exportdeclaretypeTableRowValue=string|TableRow;TableSchema
exportdeclaretypeTableSchema=bigquery.ITableSchema;ValueType
exportdeclaretypeValueType=bigquery.IQueryParameterType;ViewDefinition
exportdeclaretypeViewDefinition=bigquery.IViewDefinition;Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.