@google-cloud/bigquery

constructor

constructor(options?: BigQueryOptions);

property location

location?: string;

property setLogFunction

static setLogFunction: (logger: (msg: string) => void) => void;

property universeDomain

readonly universeDomain: string;

method createDataset

createDataset: {
    (id: string, options?: DatasetResource): Promise<DatasetResponse>;
    (id: string, options: DatasetResource, callback: DatasetCallback): void;
    (id: string, callback: DatasetCallback): void;
};

• Create a dataset.

  See Datasets: insert API Documentation

  Parameter id

  ID of the dataset to create.

  Parameter options

  See a Dataset resource.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request

  Parameter

  {Dataset} callback.dataset The newly created dataset

  Parameter

  {object} callback.apiResponse The full API response.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  
  bigquery.createDataset('my-dataset', function(err, dataset, apiResponse)
  {});
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  bigquery.createDataset('my-dataset').then(function(data) {
    const dataset = data[0];
    const apiResponse = data[1];
  });

method createJob

createJob: {
    (options: JobOptions): Promise<JobResponse>;
    (options: JobOptions, callback: JobCallback): void;
};

• Creates a job. Typically when creating a job you'll have a very specific task in mind. For this we recommend one of the following methods:

  - BigQuery.createQueryJob - Table#createCopyJob - Table#createCopyFromJob - Table#createExtractJob - Table#createLoadJob

  However in the event you need a finer level of control over the job creation, you can use this method to pass in a raw Job resource object.

  See Jobs Overview See Jobs: insert API Documentation

  Parameter options

  Object in the form of a Job resource;

  Parameter

  {string} [options.jobId] Custom job id.

  Parameter

  {string} [options.jobPrefix] Prefix to apply to the job id.

  Parameter

  {string} [options.location] The geographic location of the job. Required except for US and EU.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request.

  Parameter

  {Job} callback.job The newly created job.

  Parameter

  {object} callback.apiResponse The full API response.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  
  const options = {
    configuration: {
      query: {
        query: 'SELECT url FROM `publicdata.samples.github_nested` LIMIT 100'
      }
    }
  };
  
  bigquery.createJob(options, function(err, job) {
    if (err) {
      // Error handling omitted.
    }
  
    job.getQueryResults(function(err, rows) {});
  });
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  bigquery.createJob(options).then(function(data) {
    const job = data[0];
  
    return job.getQueryResults();
  });

method createQueryJob

createQueryJob: {
    (options: Query | string): Promise<JobResponse>;
    (options: string | Query, callback: JobCallback): void;
};

• Run a query as a job. No results are immediately returned. Instead, your callback will be executed with a Job object that you must ping for the results. See the Job documentation for explanations of how to check on the status of the job.

  See Jobs: insert API Documentation

  Parameter options

  The configuration object. This must be in the format of the `configuration.query` property of a Jobs resource. If a string is provided, this is used as the query string, and all other options are defaulted.

  Parameter

  {Table} [options.destination] The table to save the query's results to. If omitted, a new table will be created.

  Parameter

  {boolean} [options.dryRun] If set, don't actually run this job. A valid query will update the job with processing statistics. These can be accessed via job.metadata.

  Parameter

  {object} [options.labels] String key/value pairs to be attached as labels to the newly created Job.

  Parameter

  {string} [options.location] The geographic location of the job. Required except for US and EU.

  Parameter

  {number} [options.jobTimeoutMs] Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job.

  Parameter

  {string} [options.jobId] Custom job id.

  Parameter

  {string} [options.jobPrefix] Prefix to apply to the job id.

  Parameter

  {string} options.query A query string, following the BigQuery query syntax, of the query to execute.

  Parameter

  {boolean} [options.useLegacySql=false] Option to use legacy sql syntax.

  Parameter

  {object} [options.defaultDataset] The dataset. This must be in the format of the `DatasetReference`

  Parameter

  {boolean} [options.wrapIntegers] Optionally wrap INT64 in BigQueryInt or custom INT64 value type.

  Parameter

  {boolean} [options.parseJSON] Optionally parse JSON as a JSON Object.

  Parameter

  {object|array} [options.params] Option to provide query prarameters.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request.

  Parameter

  {Job} callback.job The newly created job for your query.

  Parameter

  {object} callback.apiResponse The full API response.

  Throws

  {Error} If a query is not specified.

  Throws

  {Error} If a Table is not provided as a destination.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  
  const query = 'SELECT url FROM `publicdata.samples.github_nested` LIMIT
  100';
  
  //-
  // You may pass only a query string, having a new table created to store
  the
  // results of the query.
  //-
  bigquery.createQueryJob(query, function(err, job) {});
  
  //-
  // You can also control the destination table by providing a
  // {@link Table} object.
  //-
  bigquery.createQueryJob({
    destination: bigquery.dataset('higher_education').table('institutions'),
    query: query
  }, function(err, job) {});
  
  //-
  // After you have run `createQueryJob`, your query will execute in a job.
  Your
  // callback is executed with a {@link Job} object so that you may
  // check for the results.
  //-
  bigquery.createQueryJob(query, function(err, job) {
    if (!err) {
      job.getQueryResults(function(err, rows, apiResponse) {});
    }
  });
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  bigquery.createQueryJob(query).then(function(data) {
    const job = data[0];
    const apiResponse = data[1];
  
    return job.getQueryResults();
  });

method createQueryStream

createQueryStream: (options?: Query | string) => ResourceStream<any>;

method dataset

dataset: (id: string, options?: DatasetOptions) => Dataset;

• Create a reference to a dataset.

  Parameter id

  ID of the dataset.

  Parameter options

  Dataset options.

  Parameter

  {string} [options.projectId] The GCP project ID.

  Parameter

  {string} [options.location] The geographic location of the dataset. Required except for US and EU.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('higher_education');

method date

static date: (value: BigQueryDateOptions | string) => BigQueryDate;

• The DATE type represents a logical calendar date, independent of time zone. It does not represent a specific 24-hour time period. Rather, a given DATE value represents a different 24-hour period when interpreted in different time zones, and may represent a shorter or longer day during Daylight Savings Time transitions.

  Parameter value

  The date. If a string, this should be in the format the API describes: YYYY-[M]M-[D]D. Otherwise, provide an object.

  Parameter

  {string|number} value.year Four digits.

  Parameter

  {string|number} value.month One or two digits.

  Parameter

  {string|number} value.day One or two digits.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const date = bigquery.date('2017-01-01');
  
  //-
  // Alternatively, provide an object.
  //-
  const date2 = bigquery.date({
    year: 2017,
    month: 1,
    day: 1
  });

• Parameter value

  The date. If a string, this should be in the format the API describes: YYYY-[M]M-[D]D. Otherwise, provide an object.

  Parameter

  {string|number} value.year Four digits.

  Parameter

  {string|number} value.month One or two digits.

  Parameter

  {string|number} value.day One or two digits.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const date = BigQuery.date('2017-01-01');
  
  //-
  // Alternatively, provide an object.
  //-
  const date2 = BigQuery.date({
    year: 2017,
    month: 1,
    day: 1
  });

method datetime

static datetime: (value: BigQueryDatetimeOptions | string) => BigQueryDatetime;

• A DATETIME data type represents a point in time. Unlike a TIMESTAMP, this does not refer to an absolute instance in time. Instead, it is the civil time, or the time that a user would see on a watch or calendar.

  Parameter value

  The time. If a string, this should be in the format the API describes: YYYY-[M]M-[D]D[ [H]H:[M]M:[S]S[.DDDDDD]]. Otherwise, provide an object.

  Parameter

  {string|number} value.year Four digits.

  Parameter

  {string|number} value.month One or two digits.

  Parameter

  {string|number} value.day One or two digits.

  Parameter

  {string|number} [value.hours] One or two digits (00 - 23).

  Parameter

  {string|number} [value.minutes] One or two digits (00 - 59).

  Parameter

  {string|number} [value.seconds] One or two digits (00 - 59).

  Parameter

  {string|number} [value.fractional] Up to six digits for microsecond precision.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const datetime = bigquery.datetime('2017-01-01 13:00:00');
  
  //-
  // Alternatively, provide an object.
  //-
  const datetime = bigquery.datetime({
    year: 2017,
    month: 1,
    day: 1,
    hours: 14,
    minutes: 0,
    seconds: 0
  });

method decodeIntegerValue_

static decodeIntegerValue_: (value: IntegerTypeCastValue) => number;

• Convert an INT64 value to Number.

  Parameter value

  The INT64 value to convert.

method geography

static geography: (value: string) => Geography;

• A geography value represents a surface area on the Earth in Well-known Text (WKT) format.

  Parameter value

  The geospatial data.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const geography = bigquery.geography('POINT(1, 2)');

method getDatasets

getDatasets: {
    (options?: GetDatasetsOptions): Promise<DatasetsResponse>;
    (options: GetDatasetsOptions, callback: DatasetsCallback): void;
    (callback: DatasetsCallback): void;
};

• List all or some of the datasets in a project.

  See Datasets: list API Documentation

  Parameter options

  Configuration object.

  Parameter

  {boolean} [options.all] List all datasets, including hidden ones.

  Parameter

  {string} [options.projectId] The GCP project ID.

  Parameter

  {boolean} [options.autoPaginate] Have pagination handled automatically. Default: true.

  Parameter

  {number} [options.maxApiCalls] Maximum number of API calls to make.

  Parameter

  {number} [options.maxResults] Maximum number of results to return.

  Parameter

  {string} [options.pageToken] Token returned from a previous call, to request the next page of results.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request

  Parameter

  {Dataset[]} callback.datasets The list of datasets in your project.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  
  bigquery.getDatasets(function(err, datasets) {
    if (!err) {
      // datasets is an array of Dataset objects.
    }
  });
  
  //-
  // To control how many API requests are made and page through the results
  // manually, set `autoPaginate` to `false`.
  //-
  function manualPaginationCallback(err, datasets, nextQuery, apiResponse) {
    if (nextQuery) {
      // More results exist.
      bigquery.getDatasets(nextQuery, manualPaginationCallback);
    }
  }
  
  bigquery.getDatasets({
    autoPaginate: false
  }, manualPaginationCallback);
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  bigquery.getDatasets().then(function(datasets) {});

method getDatasetsStream

getDatasetsStream: (options?: GetDatasetsOptions) => ResourceStream<Dataset>;

method getJobs

getJobs: {
    (options?: GetJobsOptions): Promise<GetJobsResponse>;
    (options: GetJobsOptions, callback: GetJobsCallback): void;
    (callback: GetJobsCallback): void;
};

• Get all of the jobs from your project.

  See Jobs: list API Documentation

  Parameter options

  Configuration object.

  Parameter

  {boolean} [options.allUsers] Display jobs owned by all users in the project.

  Parameter

  {boolean} [options.autoPaginate] Have pagination handled automatically. Default: true.

  Parameter

  {number} [options.maxApiCalls] Maximum number of API calls to make.

  Parameter

  {number} [options.maxResults] Maximum number of results to return.

  Parameter

  {string} [options.pageToken] Token returned from a previous call, to request the next page of results.

  Parameter

  {string} [options.projection] Restrict information returned to a set of selected fields. Acceptable values are "full", for all job data, and "minimal", to not include the job configuration.

  Parameter

  {string} [options.stateFilter] Filter for job state. Acceptable values are "done", "pending", and "running". Sending an array to this option performs a disjunction.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request

  Parameter

  {Job[]} callback.jobs The list of jobs in your project.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  
  bigquery.getJobs(function(err, jobs) {
    if (!err) {
      // jobs is an array of Job objects.
    }
  });
  
  //-
  // To control how many API requests are made and page through the results
  // manually, set `autoPaginate` to `false`.
  //-
  function manualPaginationCallback(err, jobs, nextQuery, apiRespose) {
    if (nextQuery) {
      // More results exist.
      bigquery.getJobs(nextQuery, manualPaginationCallback);
    }
  }
  
  bigquery.getJobs({
    autoPaginate: false
  }, manualPaginationCallback);
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  bigquery.getJobs().then(function(data) {
    const jobs = data[0];
  });

method getJobsStream

getJobsStream: (options?: GetJobsOptions) => ResourceStream<Job>;

method getTypeDescriptorFromProvidedType_

static getTypeDescriptorFromProvidedType_: (
    providedType: string | ProvidedTypeStruct | ProvidedTypeArray
) => ValueType;

• Return a value's provided type.

  Parameter providedType

  The type.

  Returns

  {string} The valid type provided.

  Throws

  {error} If the type provided is invalid.

  See Data Type

method getTypeDescriptorFromValue_

static getTypeDescriptorFromValue_: (value: unknown) => ValueType;

• Detect a value's type.

  Parameter value

  The value.

  Returns

  {string} The type detected from the value.

  Throws

  {error} If the type could not be detected.

  See Data Type

method int

static int: (
    value: string | number | IntegerTypeCastValue,
    typeCastOptions?: IntegerTypeCastOptions
) => BigQueryInt;

• A BigQueryInt wraps 'INT64' values. Can be used to maintain precision.

  Parameter value

  The INT64 value to convert.

  Parameter typeCastOptions

  Configuration to convert value. Must provide an integerTypeCastFunction to handle conversion.

  Returns

  {BigQueryInt}

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  
  const largeIntegerValue = Number.MAX_SAFE_INTEGER + 1;
  
  const options = {
    integerTypeCastFunction: value => value.split(),
  };
  
  const bqInteger = bigquery.int(largeIntegerValue, options);
  
  const customValue = bqInteger.valueOf();
  // customValue is the value returned from your `integerTypeCastFunction`.

method job

job: (id: string, options?: JobOptions) => Job;

• Create a reference to an existing job.

  Parameter id

  ID of the job.

  Parameter options

  Configuration object.

  Parameter

  {string} [options.location] The geographic location of the job. Required except for US and EU.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  
  const myExistingJob = bigquery.job('job-id');

method mergeSchemaWithRows_

static mergeSchemaWithRows_: (
    schema: TableSchema | TableField | undefined,
    rows: TableRow[],
    options: {
        wrapIntegers: boolean | IntegerTypeCastOptions;
        selectedFields?: string[];
        parseJSON?: boolean;
    }
) => any[];

• Merge a rowset returned from the API with a table schema.

  Parameter schema

  Parameter rows

  Parameter options

  Parameter

  {boolean|IntegerTypeCastOptions} options.wrapIntegers Wrap values of 'INT64' type in BigQueryInt objects. If a boolean, this will wrap values in BigQueryInt objects. If an object, this will return a value returned by wrapIntegers.integerTypeCastFunction. Please see IntegerTypeCastOptions for options descriptions.

  Parameter

  {array} options.selectedFields List of fields to return. If unspecified, all fields are returned.

  Parameter

  {array} options.parseJSON parse a 'JSON' field into a JSON object.

  Returns

  Fields using their matching names from the table's schema.

method query

query: {
    (query: string, options?: QueryOptions): Promise<QueryRowsResponse>;
    (
        query: Query,
        options?: QueryResultsOptions
    ): Promise<SimpleQueryRowsResponse>;
    (
        query: string,
        options: QueryResultsOptions,
        callback?: QueryRowsCallback
    ): void;
    (
        query: Query,
        options: QueryResultsOptions,
        callback?: SimpleQueryRowsCallback
    ): void;
    (query: string, callback?: QueryRowsCallback): void;
    (query: Query, callback?: SimpleQueryRowsCallback): void;
};

• Run a query scoped to your project. For manual pagination please refer to BigQuery.createQueryJob.

  See Jobs: query API Documentation

  Parameter query

  A string SQL query or configuration object. For all available options, see Jobs: query request body.

  Parameter

  {string} [query.location] The geographic location of the job. Required except for US and EU.

  Parameter

  {string} [query.jobId] Custom id for the underlying job.

  Parameter

  {string} [query.jobPrefix] Prefix to apply to the underlying job id.

  Parameter

  {object|Array<*>} query.params For positional SQL parameters, provide an array of values. For named SQL parameters, provide an object which maps each named parameter to its value. The supported types are integers, floats, BigQuery.date objects, BigQuery.datetime objects, BigQuery.time objects, BigQuery.timestamp objects, Strings, Booleans, and Objects.

  Parameter

  {string} query.query A query string, following the BigQuery query syntax, of the query to execute.

  Parameter

  {object|Array<*>} query.types Provided types for query parameters. For positional SQL parameters, provide an array of types. For named SQL parameters, provide an object which maps each named parameter to its type.

  Parameter

  {boolean} [query.useLegacySql=false] Option to use legacy sql syntax.

  Parameter options

  Configuration object for query results.

  Parameter

  {number} [options.maxResults] Maximum number of results to read.

  Parameter

  {number} [options.timeoutMs] How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, an error will be returned and the 'jobComplete' field in the response will be false.

  Parameter

  {boolean|IntegerTypeCastOptions} [options.wrapIntegers=false] Wrap values of 'INT64' type in BigQueryInt objects. If a boolean, this will wrap values in BigQueryInt objects. If an object, this will return a value returned by wrapIntegers.integerTypeCastFunction. Please see IntegerTypeCastOptions for options descriptions.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request

  Parameter

  {array} callback.rows The list of results from your query.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  
  const query = 'SELECT url FROM `publicdata.samples.github_nested` LIMIT
  100';
  
  bigquery.query(query, function(err, rows) {
    if (!err) {
      // rows is an array of results.
    }
  });
  
  //-
  // Positional SQL parameters are supported.
  //-
  bigquery.query({
    query: [
      'SELECT url',
      'FROM `publicdata.samples.github_nested`',
      'WHERE repository.owner = ?'
    ].join(' '),
  
    params: [
      'google'
    ]
  }, function(err, rows) {});
  
  //-
  // Or if you prefer to name them, that's also supported.
  //-
  bigquery.query({
    query: [
      'SELECT url',
      'FROM `publicdata.samples.github_nested`',
      'WHERE repository.owner = @owner'
    ].join(' '),
    params: {
      owner: 'google'
    }
  }, function(err, rows) {});
  
  //-
  // Providing types for SQL parameters is supported.
  //-
  bigquery.query({
    query: [
      'SELECT url',
      'FROM `publicdata.samples.github_nested`',
      'WHERE repository.owner = ?'
    ].join(' '),
  
    params: [
      null
    ],
  
    types: ['string']
  }, function(err, rows) {});
  
  //-
  // If you need to use a `DATE`, `DATETIME`, `TIME`, or `TIMESTAMP` type in
  // your query, see {@link BigQuery.date}, {@link BigQuery.datetime},
  // {@link BigQuery.time}, and {@link BigQuery.timestamp}.
  //-
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  bigquery.query(query).then(function(data) {
    const rows = data[0];
  });

method queryAsStream_

queryAsStream_: (query: Query, callback?: SimpleQueryRowsCallback) => void;

• This method will be called by createQueryStream(). It is required to properly set the autoPaginate option value.

method range

static range: (
    value: string | BigQueryRangeOptions,
    elementType?: string
) => BigQueryRange;

• A range represents contiguous range between two dates, datetimes, or timestamps. The lower and upper bound for the range are optional. The lower bound is inclusive and the upper bound is exclusive.

  BigQuery.range

  Parameter value

  The range API string or start/end with dates/datetimes/timestamp ranges.

  Parameter elementType

  The range element type - DATE|DATETIME|TIMESTAMP

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const timestampRange = BigQuery.range('[2020-10-01 12:00:00+08, 2020-12-31 12:00:00+08)', 'TIMESTAMP');

• A range represents contiguous range between two dates, datetimes, or timestamps. The lower and upper bound for the range are optional. The lower bound is inclusive and the upper bound is exclusive.

  Parameter value

  The range API string or start/end with dates/datetimes/timestamp ranges.

  Parameter elementType

  The range element type - DATE|DATETIME|TIMESTAMP

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const timestampRange = bigquery.range('[2020-10-01 12:00:00+08, 2020-12-31 12:00:00+08)', 'TIMESTAMP');

method time

static time: (value: BigQueryTimeOptions | string) => BigQueryTime;

• A TIME data type represents a time, independent of a specific date.

  Parameter value

  The time. If a string, this should be in the format the API describes: [H]H:[M]M:[S]S[.DDDDDD]. Otherwise, provide an object.

  Parameter

  {string|number} [value.hours] One or two digits (00 - 23).

  Parameter

  {string|number} [value.minutes] One or two digits (00 - 59).

  Parameter

  {string|number} [value.seconds] One or two digits (00 - 59).

  Parameter

  {string|number} [value.fractional] Up to six digits for microsecond precision.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const time = bigquery.time('14:00:00'); // 2:00 PM
  
  //-
  // Alternatively, provide an object.
  //-
  const time = bigquery.time({
    hours: 14,
    minutes: 0,
    seconds: 0
  });

method timestamp

static timestamp: (
    value: Date | PreciseDate | string | number
) => BigQueryTimestamp;

• A timestamp represents an absolute point in time, independent of any time zone or convention such as Daylight Savings Time.

  The recommended input here is a Date or PreciseDate class. If passing as a string, it should be Timestamp literals: https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#timestamp_literals. When passing a number input, it should be epoch seconds in float representation.

  BigQuery.timestamp

  Parameter value

  The time.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const timestamp = BigQuery.timestamp(new Date());

• A timestamp represents an absolute point in time, independent of any time zone or convention such as Daylight Savings Time.

  The recommended input here is a Date or PreciseDate class. If passing as a string, it should be Timestamp literals: https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#timestamp_literals. When passing a number input, it should be epoch seconds in float representation.

  Parameter value

  The time.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const timestamp = bigquery.timestamp(new Date());

method valueToQueryParameter_

static valueToQueryParameter_: (
    value: any,
    providedType?: string | ProvidedTypeStruct | ProvidedTypeArray
) => bigquery.IQueryParameter;

• Convert a value into a queryParameter object.

  See Jobs.query API Reference Docs (see `queryParameters`)

  Parameter value

  The value.

  Parameter providedType

  Provided query parameter type.

  Returns

  {object} A properly-formed queryParameter object.

constructor

constructor(value: string | BigQueryDateOptions);

property value

value: string;

constructor

constructor(value: string | BigQueryDatetimeOptions);

property value

value: string;

constructor

constructor(
    value: string | number | IntegerTypeCastValue,
    typeCastOptions?: IntegerTypeCastOptions
);

property type

type: string;

property typeCastFunction

typeCastFunction?: Function;

property value

value: string;

method toJSON

toJSON: () => Json;

method valueOf

valueOf: () => any;

constructor

constructor(value: string | BigQueryTimeOptions);

property value

value: string;

constructor

constructor(value: any);

property value

value: string;

method fromFloatValue_

fromFloatValue_: (value: number) => PreciseDate;

constructor

constructor(bigQuery: BigQuery, id: string, options?: DatasetOptions);

property bigQuery

bigQuery: BigQuery;

property location

location?: string;

property projectId

projectId: string;

method createQueryJob

createQueryJob: {
    (options: string | Query): Promise<JobResponse>;
    (options: string | Query, callback: JobCallback): void;
};

• Run a query as a job. No results are immediately returned. Instead, your callback will be executed with a Job object that you must ping for the results. See the Job documentation for explanations of how to check on the status of the job.

  See BigQuery#createQueryJob for full documentation of this method.

  Parameter options

  See BigQuery#createQueryJob for full documentation of this method.

  Parameter callback

  See BigQuery#createQueryJob for full documentation of this method.

  Returns

  {Promise} See BigQuery#createQueryJob for full documentation of this method.

method createQueryStream

createQueryStream: (options: Query | string) => Duplex;

• Run a query scoped to your dataset as a readable object stream.

  See BigQuery#createQueryStream for full documentation of this method.

  Parameter options

  See BigQuery#createQueryStream for full documentation of this method.

  Returns

  {stream}

method createRoutine

createRoutine: {
    (id: string, config: RoutineMetadata): Promise<RoutineResponse>;
    (id: string, config: bigquery.IRoutine, callback: RoutineCallback): void;
};

• Create a Routine.

  See Routines: insert API Documentation

  Parameter id

  The routine ID.

  Parameter config

  A [routine resource]https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#Routine.

  Parameter callback

  The callback function.

  Returns

  {Promise}

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('my-dataset');
  
  const id = 'my-routine';
  const config = {
    arguments: [{
      name: 'x',
      dataType: {
        typeKind: 'INT64'
      }
    }],
    definitionBody: 'x * 3',
    routineType: 'SCALAR_FUNCTION',
    returnType: {
      typeKind: 'INT64'
    }
  };
  
  dataset.createRoutine(id, config, (err, routine, apiResponse) => {
    if (!err) {
      // The routine was created successfully.
    }
  });

  Example 2

  If the callback is omitted a Promise will be returned

  const [routine, apiResponse] = await dataset.createRoutine(id, config);

method createTable

createTable: {
    (id: string, options: TableMetadata): Promise<TableResponse>;
    (id: string, options: TableMetadata, callback: TableCallback): void;
    (id: string, callback: TableCallback): void;
};

• Create a Table given a tableId or configuration object.

  See Tables: insert API Documentation

  Parameter id

  Table id.

  Parameter options

  See a Table resource.

  Parameter

  {string|object} [options.schema] A comma-separated list of name:type pairs. Valid types are "string", "integer", "float", "boolean", and "timestamp". If the type is omitted, it is assumed to be "string". Example: "name:string, age:integer". Schemas can also be specified as a JSON array of fields, which allows for nested and repeated fields. See a Table resource for more detailed information.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request

  Parameter

  {Table} callback.table The newly created table.

  Parameter

  {object} callback.apiResponse The full API response.

  Returns

  {Promise}

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('institutions');
  
  const tableId = 'institution_data';
  
  const options = {
    // From the data.gov CSV dataset (http://goo.gl/kSE7z6):
    schema: 'UNITID,INSTNM,ADDR,CITY,STABBR,ZIP,FIPS,OBEREG,CHFNM,...'
  };
  
  dataset.createTable(tableId, options, (err, table, apiResponse) => {});
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  dataset.createTable(tableId, options).then((data) => {
    const table = data[0];
    const apiResponse = data[1];
  });

method delete

delete: {
    (options?: DatasetDeleteOptions): Promise<[Metadata]>;
    (options: DatasetDeleteOptions, callback: DeleteCallback): void;
    (callback: DeleteCallback): void;
};

• Delete the dataset.

  See Datasets: delete API Documentation

  Parameter options

  The configuration object.

  Parameter

  {boolean} [options.force=false] Force delete dataset and all tables.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request

  Parameter

  {object} callback.apiResponse The full API response.

  Returns

  {Promise}

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('institutions');
  
  //-
  // Delete the dataset, only if it does not have any tables.
  //-
  dataset.delete((err, apiResponse) => {});
  
  //-
  // Delete the dataset and any tables it contains.
  //-
  dataset.delete({ force: true }, (err, apiResponse) => {});
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  dataset.delete().then((data) => {
    const apiResponse = data[0];
  });

method getModels

getModels: {
    (options?: GetModelsOptions): Promise<GetModelsResponse>;
    (options: GetModelsOptions, callback: GetModelsCallback): void;
    (callback: GetModelsCallback): void;
};

• Get a list of Model resources.

  See Models: list API Documentation

  Parameter options

  Configuration object.

  Parameter

  {boolean} [options.autoPaginate=true] Have pagination handled automatically.

  Parameter

  {number} [options.maxApiCalls] Maximum number of API calls to make.

  Parameter

  {number} [options.maxResults] Maximum number of results to return.

  Parameter

  {string} [options.pageToken] Token returned from a previous call, to request the next page of results.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request

  Parameter

  {Model[]} callback.models The list of models from your Dataset.

  Parameter

  {GetModelsOptions} callback.nextQuery If autoPaginate is set to true, this will be a prepared query for the next page of results.

  Parameter

  {object} callback.apiResponse The full API response.

  Returns

  {Promise}

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('institutions');
  
  dataset.getModels((err, models) => {
    // models is an array of `Model` objects.
  });

  Example 2

  To control how many API requests are made and page through the results manually, set autoPaginate to false.

  function manualPaginationCallback(err, models, nextQuery, apiResponse) {
    if (nextQuery) {
      // More results exist.
      dataset.getModels(nextQuery, manualPaginationCallback);
    }
  }
  
  dataset.getModels({
    autoPaginate: false
  }, manualPaginationCallback);

  Example 3

  If the callback is omitted, we'll return a Promise.

  dataset.getModels().then((data) => {
    const models = data[0];
  });

method getModelsStream

getModelsStream: (options?: GetModelsOptions) => ResourceStream<Model>;

method getRoutines

getRoutines: {
    (options?: GetRoutinesOptions): Promise<GetRoutinesResponse>;
    (options: GetRoutinesOptions, callback: GetRoutinesCallback): void;
    (callback: GetRoutinesCallback): void;
};

• Get a list of routines.

  See Routines: list API Documentation

  Parameter options

  Request options.

  Parameter

  {boolean} [options.autoPaginate=true] Have pagination handled automatically.

  Parameter

  {number} [options.maxApiCalls] Maximum number of API calls to make.

  Parameter

  {number} [options.maxResults] Maximum number of results to return.

  Parameter

  {string} [options.pageToken] Token returned from a previous call, to request the next page of results.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request

  Parameter

  {Routine[]} callback.routines The list of models from your Dataset.

  Parameter

  {GetRoutinesOptions} callback.nextQuery If autoPaginate is set to true, this will be a prepared query for the next page of results.

  Parameter

  {object} callback.apiResponse The full API response.

  Returns

  {Promise}

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('institutions');
  
  dataset.getRoutines((err, routines) => {
    // routines is an array of `Routine` objects.
  });

  Example 2

  To control how many API requests are made and page through the results manually, set autoPaginate to false.

  function manualPaginationCallback(err, routines, nextQuery, apiResponse) {
    if (nextQuery) {
      // More results exist.
      dataset.getRoutines(nextQuery, manualPaginationCallback);
    }
  }
  
  dataset.getRoutines({
    autoPaginate: false
  }, manualPaginationCallback);

  Example 3

  If the callback is omitted a Promise will be returned

  const [routines] = await dataset.getRoutines();

method getRoutinesStream

getRoutinesStream: (options?: GetRoutinesOptions) => ResourceStream<Routine>;

method getTables

getTables: {
    (options?: GetTablesOptions): Promise<GetTablesResponse>;
    (options: GetTablesOptions, callback: GetTablesCallback): void;
    (callback: GetTablesCallback): void;
};

• Get a list of Table resources.

  See Tables: list API Documentation

  Parameter options

  Configuration object.

  Parameter

  {boolean} [options.autoPaginate=true] Have pagination handled automatically.

  Parameter

  {number} [options.maxApiCalls] Maximum number of API calls to make.

  Parameter

  {number} [options.maxResults] Maximum number of results to return.

  Parameter

  {string} [options.pageToken] Token returned from a previous call, to request the next page of results.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request

  Parameter

  {Table[]} callback.tables The list of tables from your Dataset.

  Parameter

  {GetTablesOptions} callback.nextQuery If autoPaginate is set to true, this will be a prepared query for the next page of results.

  Parameter

  {object} callback.apiResponse The full API response.

  Returns

  {Promise}

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('institutions');
  
  dataset.getTables((err, tables) => {
    // tables is an array of `Table` objects.
  });
  
  //-
  // To control how many API requests are made and page through the results
  // manually, set `autoPaginate` to `false`.
  //-
  function manualPaginationCallback(err, tables, nextQuery, apiResponse) {
    if (nextQuery) {
      // More results exist.
      dataset.getTables(nextQuery, manualPaginationCallback);
    }
  }
  
  dataset.getTables({
    autoPaginate: false
  }, manualPaginationCallback);
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  dataset.getTables().then((data) => {
    const tables = data[0];
  });

method getTablesStream

getTablesStream: (options?: GetTablesOptions) => ResourceStream<Table>;

method model

model: (id: string) => Model;

• Create a Model object.

  Parameter id

  The ID of the model. {Model}

  Throws

  {TypeError} if model ID is missing.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('institutions');
  
  const model = dataset.model('my-model');

method query

query: {
    (options: Query): Promise<QueryRowsResponse>;
    (options: string): Promise<QueryRowsResponse>;
    (options: Query, callback: SimpleQueryRowsCallback): void;
    (options: string, callback: SimpleQueryRowsCallback): void;
};

• Run a query scoped to your dataset.

  See BigQuery#query for full documentation of this method.

  Parameter options

  See BigQuery#query for full documentation of this method.

  Parameter callback

  See BigQuery#query for full documentation of this method.

  Returns

  {Promise} See BigQuery#query for full documentation of this method.

method routine

routine: (id: string) => Routine;

• Create a Routine object.

  Parameter id

  The ID of the routine.

  Returns

  {Routine}

  Throws

  {TypeError} if routine ID is missing.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('institutions');
  
  const routine = dataset.routine('my_routine');

method table

table: (id: string, options?: TableOptions) => Table;

• Create a Table object.

  Parameter id

  The ID of the table.

  Parameter options

  Table options.

  Parameter

  {string} [options.location] The geographic location of the table, by default this value is inherited from the dataset. This can be used to configure the location of all jobs created through a table instance. It cannot be used to set the actual location of the table. This value will be superseded by any API responses containing location data for the table. {Table}

  Throws

  {TypeError} if table ID is missing.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('institutions');
  
  const institutions = dataset.table('institution_data');

constructor

constructor(value: string);

property value

value: string;

constructor

constructor(bigQuery: BigQuery, id: string, options?: JobOptions);

property bigQuery

bigQuery: BigQuery;

property location

location?: string;

method cancel

cancel: { (): Promise<CancelResponse>; (callback: CancelCallback): void };

• Cancel a job. Use Job#getMetadata to see if the cancel completes successfully. See an example implementation below.

  See Jobs: get API Documentation

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request.

  Parameter

  {object} callback.apiResponse The full API response.

  Returns

  {Promise}

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  
  const job = bigquery.job('job-id');
  
  job.cancel((err, apiResponse) =>{
    // Check to see if the job completes successfully.
    job.on('error', (err) => {});
    job.on('complete', (metadata) => {});
  });
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  job.cancel().then((data) => {
    const apiResponse = data[0];
  });

method getQueryResults

getQueryResults: {
    (options?: QueryResultsOptions): Promise<QueryRowsResponse>;
    (options: QueryResultsOptions, callback: QueryRowsCallback): void;
    (callback: QueryRowsCallback): void;
};

• Get the results of a job.

  See Jobs: getQueryResults API Documentation

  Parameter options

  Configuration object.

  Parameter

  {boolean} [options.autoPaginate=true] Have pagination handled automatically.

  Parameter

  {number} [options.maxApiCalls] Maximum number of API calls to make.

  Parameter

  {number} [options.maxResults] Maximum number of results to read.

  Parameter

  {string} [options.pageToken] Page token, returned by a previous call, to request the next page of results. Note: This is automatically added to the nextQuery argument of your callback.

  Parameter

  {number} [options.startIndex] Zero-based index of the starting row.

  Parameter

  {number} [options.timeoutMs] How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, an error will be returned and the 'jobComplete' field in the response will be false.

  Parameter

  {boolean|IntegerTypeCastOptions} [options.wrapIntegers=false] Wrap values of 'INT64' type in BigQueryInt objects. If a boolean, this will wrap values in BigQueryInt objects. If an object, this will return a value returned by wrapIntegers.integerTypeCastFunction.

  Parameter callback

  The callback function. If autoPaginate is set to false a ManualQueryResultsCallback should be used.

  Returns

  {Promise}

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  
  const job = bigquery.job('job-id');
  
  //-
  // Get all of the results of a query.
  //-
  job.getQueryResults((err, rows) => {
    if (!err) {
      // rows is an array of results.
    }
  });
  
  //-
  // Customize the results you want to fetch.
  //-
  job.getQueryResults({
    maxResults: 100
  }, (err, rows) => {});
  
  //-
  // To control how many API requests are made and page through the results
  // manually, set `autoPaginate` to `false`.
  //-
  function manualPaginationCallback(err, rows, nextQuery, apiResponse) {
    if (nextQuery) {
      // More results exist.
      job.getQueryResults(nextQuery, manualPaginationCallback);
    }
  }
  
  job.getQueryResults({
    autoPaginate: false
  }, manualPaginationCallback);
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  job.getQueryResults().then((data) => {
    const rows = data[0];
  });

method getQueryResultsAsStream_

getQueryResultsAsStream_: (
    options: QueryResultsOptions,
    callback: QueryRowsCallback
) => void;

• This method will be called by getQueryResultsStream(). It is required to properly set the autoPaginate option value.

method getQueryResultsStream

getQueryResultsStream: (options?: QueryResultsOptions) => ResourceStream<any>;

method poll_

poll_: (callback: MetadataCallback) => void;

• Poll for a status update. Execute the callback:

  - callback(err): Job failed - callback(): Job incomplete - callback(null, metadata): Job complete

  Parameter callback

constructor

constructor(dataset: Dataset, id: string);

property bigQuery

bigQuery: BigQuery;

property dataset

dataset: Dataset;

method createExtractJob

createExtractJob: {
    (
        destination: string | File,
        options?: CreateExtractJobOptions
    ): Promise<JobResponse>;
    (
        destination: string | File,
        options: CreateExtractJobOptions,
        callback: JobCallback
    ): void;
    (destination: string | File, callback: JobCallback): void;
};

• Export model to Cloud Storage.

  See Jobs: insert API Documentation

  Parameter destination

  Where the model should be exported to. A string or object.

  Parameter options

  The configuration object. For all extract job options, see [CreateExtractJobOptions]https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationExtract.

  Parameter

  {string} [options.format] The format to export the data in. Allowed options are "ML_TF_SAVED_MODEL" or "ML_XGBOOST_BOOSTER". Default: "ML_TF_SAVED_MODEL".

  Parameter

  {string} [options.jobId] Custom job id.

  Parameter

  {string} [options.jobPrefix] Prefix to apply to the job id.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request.

  Parameter

  {Job} callback.job The job used to export the model.

  Parameter

  {object} callback.apiResponse The full API response.

  Returns

  {Promise}

  Throws

  {Error} If a destination isn't a string or File object.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('my-dataset');
  const model = dataset.model('my-model');
  
  const extractedModel = 'gs://my-bucket/extracted-model';
  
  function callback(err, job, apiResponse) {
    // `job` is a Job object that can be used to check the status of the
    // request.
  }
  
  //-
  // To use the default options, just pass a string or a {@link
  https://googleapis.dev/nodejs/storage/latest/File.html File}
  object.
  //
  // Note: The default format is 'ML_TF_SAVED_MODEL'.
  //-
  model.createExtractJob(extractedModel, callback);
  
  //-
  // If you need more customization, pass an `options` object.
  //-
  const options = {
    format: 'ML_TF_SAVED_MODEL',
    jobId: '123abc'
  };
  
  model.createExtractJob(extractedModel, options, callback);
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  model.createExtractJob(extractedModel, options).then((data) => {
    const job = data[0];
    const apiResponse = data[1];
  });

method extract

extract: {
    (
        destination: string | File,
        options?: CreateExtractJobOptions
    ): Promise<JobMetadataResponse>;
    (
        destination: string | File,
        options: CreateExtractJobOptions,
        callback?: JobMetadataCallback
    ): void;
    (destination: string | File, callback?: JobMetadataCallback): void;
};

• Export model to Cloud Storage.

  Parameter destination

  Where the model should be exported to. A string or object.

  Parameter options

  The configuration object. For all extract job options, see [CreateExtractJobOptions]https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationExtract.

  Parameter

  {string} [options.format] The format to export the data in. Allowed options are "ML_TF_SAVED_MODEL" or "ML_XGBOOST_BOOSTER". Default: "ML_TF_SAVED_MODEL".

  Parameter

  {string} [options.jobId] Custom id for the underlying job.

  Parameter

  {string} [options.jobPrefix] Prefix to apply to the underlying job id.

  Parameter callback

  The callback function.

  Parameter

  {?error} callback.err An error returned while making this request

  Parameter

  {object} callback.apiResponse The full API response.

  Returns

  {Promise}

  Throws

  {Error} If destination isn't a string or File object.

  Example 1

  const {BigQuery} = require('@google-cloud/bigquery');
  const bigquery = new BigQuery();
  const dataset = bigquery.dataset('my-dataset');
  const model = dataset.model('my-model');
  
  const extractedModel = 'gs://my-bucket/extracted-model';
  
  
  //-
  function callback(err, job, apiResponse) {
    // `job` is a Job object that can be used to check the status of the
    // request.
  }
  
  //-
  // To use the default options, just pass a string or a {@link
  https://googleapis.dev/nodejs/storage/latest/File.html File}
  object.
  //
  // Note: The default format is 'ML_TF_SAVED_MODEL'.
  //-
  model.createExtractJob(extractedModel, callback);
  
  //-
  // If you need more customization, pass an `options` object.
  //-
  const options = {
    format: 'ML_TF_SAVED_MODEL',
    jobId: '123abc'
  };
  
  model.createExtractJob(extractedModel, options, callback);
  
  //-
  // If the callback is omitted, we'll return a Promise.
  //-
  model.createExtractJob(extractedModel, options).then((data) => {
    const job = data[0];
    const apiResponse = data[1];
  });

constructor

constructor(dataset: Dataset, id: string);

method setMetadata

setMetadata: {
    (metadata: RoutineMetadata): Promise<SetMetadataResponse>;
    (metadata: bigquery.IRoutine, callback: ResponseCallback): void;
};

constructor

constructor(options: RowBatchOptions);

property batchOptions

batchOptions: RowBatchOptions;

property bytes

bytes: number;

property callbacks

callbacks: InsertRowsCallback[];

property created

created: number;

property rows

rows: any[];

method add

add: (row: RowMetadata, callback?: InsertRowsCallback) => void;

• Adds a row to the current batch.

  Parameter row

  The row to insert.

  Parameter callback

  The callback function.

method canFit

canFit: (row: RowMetadata) => boolean;

• Indicates if a given row can fit in the batch.

  Parameter row

  The row in question.

  Returns

  {boolean}

method isAtMax

isAtMax: () => boolean;

• Checks to see if this batch is at the maximum allowed payload size.

  Returns

  {boolean}

method isFull

isFull: () => boolean;

• Indicates if the batch is at capacity.

  Returns

  {boolean}

constructor

constructor(table: Table, dup: Stream, options?: InsertStreamOptions);

property batch

batch: RowBatch;

property batchOptions

batchOptions?: RowBatchOptions;

property inFlight

inFlight: boolean;

property insertRowsOptions

insertRowsOptions: InsertRowsOptions;

property pending

pending?: number;

property stream

stream: Stream;

property table

table: Table;

method add

add: (row: RowMetadata, callback: InsertRowsCallback) => void;

• Adds a row to the queue.

  Parameter row

  The row to insert.

  Parameter callback

  The insert callback.

method getOptionDefaults

getOptionDefaults: () => RowBatchOptions;

method insert

insert: (callback?: InsertRowsCallback) => void;

• Cancels any pending inserts and calls _insert immediately.

method setOptions

setOptions: (options?: RowBatchOptions) => void;

• Sets the batching options.

  Parameter options

  The batching options.

constructor

constructor(dataset: Dataset, id: string, options?: TableOptions);