Package @google-cloud/bigquery (7.0.0)
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_2
InsertRow
InsertStreamOptions
IntegerTypeCastOptions
Json
PagedCallback
PartialInsertFailure
ProvidedTypeStruct
RequestCallback
ResourceCallback
TableOptions
Variables
PROTOCOL_REGEX
PROTOCOL_REGEX:RegExpType Aliases
CancelCallback
exporttypeCancelCallback=RequestCallbackCancelResponse
exporttypeCancelResponse=[bigquery.IJobCancelResponse];CopyTableMetadata
exporttypeCopyTableMetadata=JobRequestCreateCopyJobMetadata
exporttypeCreateCopyJobMetadata=CopyTableMetadata;CreateDatasetOptions
exporttypeCreateDatasetOptions=bigquery.IDataset;CreateExtractJobOptions
exporttypeCreateExtractJobOptions=JobRequestDatasetCallback
exporttypeDatasetCallback=ResourceCallbackDatasetResource
exporttypeDatasetResource=bigquery.IDataset;DatasetResponse
exporttypeDatasetResponse=[Dataset,bigquery.IDataset];DatasetsCallback
exporttypeDatasetsCallback=PagedCallbackDatasetsResponse
exporttypeDatasetsResponse=PagedResponseFormattedMetadata
exporttypeFormattedMetadata=bigquery.ITable;GetDatasetsOptions
exporttypeGetDatasetsOptions=PagedRequestGetJobsCallback
exporttypeGetJobsCallback=PagedCallbackGetJobsOptions
exporttypeGetJobsOptions=PagedRequestGetJobsResponse
exporttypeGetJobsResponse=PagedResponseGetModelsCallback
exporttypeGetModelsCallback=PagedCallbackGetModelsOptions
exporttypeGetModelsOptions=PagedRequestGetModelsResponse
exporttypeGetModelsResponse=PagedResponseGetPolicyOptions
exporttypeGetPolicyOptions=bigquery.IGetPolicyOptions;GetRoutinesCallback
exporttypeGetRoutinesCallback=PagedCallbackGetRoutinesOptions
exporttypeGetRoutinesOptions=PagedRequestGetRoutinesResponse
exporttypeGetRoutinesResponse=PagedResponseGetRowsOptions
exporttypeGetRowsOptions=PagedRequestGetTablesCallback
exporttypeGetTablesCallback=PagedCallbackGetTablesOptions
exporttypeGetTablesOptions=PagedRequestGetTablesResponse
exporttypeGetTablesResponse=PagedResponseInsertRowsCallback
exporttypeInsertRowsCallback=RequestCallbackInsertRowsOptions
exporttypeInsertRowsOptions=bigquery.ITableDataInsertAllRequest &{createInsertId?:boolean;partialRetries?:number;raw?:boolean;schema?:string|{};};InsertRowsResponse
exporttypeInsertRowsResponse=[bigquery.ITableDataInsertAllResponse|bigquery.ITable];InsertRowsStreamResponse
exporttypeInsertRowsStreamResponse=bigquery.ITableDataInsertAllResponse;IntegerTypeCastValue
exporttypeIntegerTypeCastValue={integerValue:string|number;schemaFieldName?:string;};JobCallback
exporttypeJobCallback=ResourceCallbackJobLoadMetadata
exporttypeJobLoadMetadata=JobRequestJobMetadata
exporttypeJobMetadata=bigquery.IJob;JobMetadataCallback
exporttypeJobMetadataCallback=RequestCallbackJobMetadataResponse
exporttypeJobMetadataResponse=[JobMetadata];JobOptions
exporttypeJobOptions=JobRequestJobRequest
exporttypeJobRequest| Type Parameter | |
|---|---|
| Type | Description |
J | |
JobResponse
exporttypeJobResponse=[Job,bigquery.IJob];PagedRequest
exporttypePagedRequest
=P &{autoPaginate?:boolean;maxApiCalls?:number;};
| Type Parameter | |
|---|---|
| Type | Description |
P | |
PagedResponse
exporttypePagedResponse| Type Parameters | |
|---|---|
| Type | Description |
T | |
Q | |
R | |
PermissionsCallback
exporttypePermissionsCallback=RequestCallbackPermissionsResponse
exporttypePermissionsResponse=[bigquery.ITestIamPermissionsResponse];Policy
exporttypePolicy=bigquery.IPolicy;PolicyCallback
exporttypePolicyCallback=RequestCallbackPolicyRequest
exporttypePolicyRequest=bigquery.IGetIamPolicyRequest;PolicyResponse
exporttypePolicyResponse=[Policy];ProvidedTypeArray
exporttypeProvidedTypeArray=ArrayQuery
exporttypeQuery=JobRequestQueryOptions
exporttypeQueryOptions=QueryResultsOptions;QueryParameter
exporttypeQueryParameter=bigquery.IQueryParameter;QueryResultsOptions
exporttypeQueryResultsOptions={job?:Job;wrapIntegers?:boolean|IntegerTypeCastOptions;} &PagedRequestQueryRowsCallback
exporttypeQueryRowsCallback=PagedCallbackQueryRowsResponse
exporttypeQueryRowsResponse=PagedResponseQueryStreamOptions
exporttypeQueryStreamOptions={wrapIntegers?:boolean|IntegerTypeCastOptions;};RoutineCallback
exporttypeRoutineCallback=ResourceCallbackRoutineMetadata
exporttypeRoutineMetadata=bigquery.IRoutine;RoutineResponse
exporttypeRoutineResponse=[Routine,bigquery.IRoutine];RowMetadata
exporttypeRowMetadata=any;RowsCallback
exporttypeRowsCallback=PagedCallbackRowsResponse
exporttypeRowsResponse=PagedResponseSetPolicyOptions
exporttypeSetPolicyOptions=OmitSetTableMetadataOptions
exporttypeSetTableMetadataOptions=TableMetadata;SimpleQueryRowsCallback
exporttypeSimpleQueryRowsCallback=ResourceCallbackSimpleQueryRowsResponse
exporttypeSimpleQueryRowsResponse=[RowMetadata[],bigquery.IJob];TableCallback
exporttypeTableCallback=ResourceCallbackTableField
exporttypeTableField=bigquery.ITableFieldSchema;TableMetadata
exporttypeTableMetadata=bigquery.ITable &{name?:string;schema?:string|TableField[]|TableSchema;partitioning?:string;view?:string|ViewDefinition;};TableResponse
exporttypeTableResponse=[Table,bigquery.ITable];TableRow
exporttypeTableRow=bigquery.ITableRow;TableRowField
exporttypeTableRowField=bigquery.ITableCell;TableRowValue
exporttypeTableRowValue=string|TableRow;TableSchema
exporttypeTableSchema=bigquery.ITableSchema;ValueType
exporttypeValueType=bigquery.IQueryParameterType;ViewDefinition
exporttypeViewDefinition=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.