Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@google-cloud/bigquery
Advanced tools
@google-cloud/bigquery - npm Package Compare versions
Comparing version 5.7.1 to 5.8.0
@@ -252,2 +252,3 @@ /*! | ||
| * @param {string|number} value.day One or two digits. | ||
| * @returns {BigQueryDate} | ||
| * | ||
@@ -285,2 +286,3 @@ * @example | ||
| * precision. | ||
| * @returns {BigQueryDatetime} | ||
| * | ||
@@ -352,2 +354,3 @@ * @example | ||
| * precision. | ||
| * @returns {BigQueryTime} | ||
| * | ||
@@ -413,2 +416,3 @@ * @example | ||
| * @param {Date|string} value The time. | ||
| * @returns {BigQueryTimestamp} | ||
| * | ||
@@ -429,2 +433,3 @@ * @example | ||
| * value. Must provide an `integerTypeCastFunction` to handle conversion. | ||
| * @returns {BigQueryInt} | ||
| * | ||
@@ -465,2 +470,3 @@ * @example | ||
| * @param {string} value The geospatial data. | ||
| * @returns {Geography} | ||
| * | ||
@@ -467,0 +473,0 @@ * @example |
@@ -115,15 +115,6 @@ /*! | ||
| model(id: string): Model; | ||
| /** | ||
| * Run a query scoped to your dataset. | ||
| * | ||
| * See {@link BigQuery#query} for full documentation of this method. | ||
| * | ||
| * @param {object} options See {@link BigQuery#query} for full documentation of this method. | ||
| * @param {function} [callback] See {@link BigQuery#query} for full documentation of this method. | ||
| * @returns {Promise} See {@link BigQuery#query} for full documentation of this method. | ||
| */ | ||
| query(options: Query): Promise<QueryRowsResponse>; | ||
| query(options: Query, callback: SimpleQueryRowsCallback): void; | ||
| /** | ||
| * Create a Routine object. | ||
| * Create a {@link Routine} object. | ||
| * | ||
@@ -144,3 +135,3 @@ * @throws {TypeError} if routine ID is missing. | ||
| /** | ||
| * Create a Table object. | ||
| * Create a {@link Table} object. | ||
| * | ||
@@ -147,0 +138,0 @@ * @throws {TypeError} if table ID is missing. |
@@ -46,11 +46,22 @@ "use strict"; | ||
| /** | ||
| * @callback CreateDatasetCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {Dataset} dataset The newly created dataset. | ||
| * @param {object} apiResponse The full API response. | ||
| */ | ||
| /** | ||
| * @typedef {array} CreateDatasetResponse | ||
| * @property {Dataset} 0 The newly created dataset. | ||
| * @property {object} 1 The full API response body. | ||
| */ | ||
| /** | ||
| * Create a dataset. | ||
| * | ||
| * @method Dataset#create | ||
| * @param {function} [callback] The callback function. | ||
| * @param {CreateDatasetCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
| * request. | ||
| * @param {Dataset} callback.dataset The created dataset. | ||
| * @param {Dataset} callback.dataset The newly created dataset. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise} | ||
| * @returns {Promise<CreateDatasetResponse>} | ||
| * | ||
@@ -77,10 +88,19 @@ * @example | ||
| /** | ||
| * @callback DatasetExistsCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {boolean} exists Indicates if the dataset exists. | ||
| */ | ||
| /** | ||
| * @typedef {array} DatasetExistsResponse | ||
| * @property {boolean} 0 Indicates if the dataset exists. | ||
| */ | ||
| /** | ||
| * Check if the dataset exists. | ||
| * | ||
| * @method Dataset#exists | ||
| * @param {function} [callback] The callback function. | ||
| * @param {DatasetExistsCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
| * request. | ||
| * @param {boolean} callback.exists Whether the dataset exists or not. | ||
| * @returns {Promise} | ||
| * @returns {Promise<DatasetExistsResponse>} | ||
| * | ||
@@ -102,2 +122,13 @@ * @example | ||
| /** | ||
| * @callback GetDatasetCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {Dataset} dataset The dataset. | ||
| * @param {object} apiResponse The full API response body. | ||
| */ | ||
| /** | ||
| * @typedef {array} GetDatasetResponse | ||
| * @property {Dataset} 0 The dataset. | ||
| * @property {object} 1 The full API response body. | ||
| */ | ||
| /** | ||
| * Get a dataset if it exists. | ||
@@ -114,7 +145,8 @@ * | ||
| * object if it does not exist. | ||
| * @param {function} [callback] The callback function. | ||
| * @param {GetDatasetCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
| * request. | ||
| * @param {Dataset} callback.dataset The dataset. | ||
| * @returns {Promise} | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise<GetDatasetResponse>} | ||
| * | ||
@@ -141,2 +173,13 @@ * @example | ||
| /** | ||
| * @callback GetDatasetMetadataCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {object} metadata The dataset metadata. | ||
| * @param {object} apiResponse The full API response. | ||
| */ | ||
| /** | ||
| * @typedef {array} GetDatasetMetadataResponse | ||
| * @property {object} 0 The dataset metadata. | ||
| * @property {object} 1 The full API response. | ||
| */ | ||
| /** | ||
| * Get the metadata for the Dataset. | ||
@@ -147,3 +190,3 @@ * | ||
| * @method Dataset#getMetadata | ||
| * @param {function} [callback] The callback function. | ||
| * @param {GetDatasetMetadataCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
@@ -153,3 +196,3 @@ * request. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise} | ||
| * @returns {Promise<GetDatasetMetadataResponse>} | ||
| * | ||
@@ -172,2 +215,11 @@ * @example | ||
| /** | ||
| * @callback SetDatasetMetadataCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {object} apiResponse The full API response. | ||
| */ | ||
| /** | ||
| * @typedef {array} SetDatasetMetadataResponse | ||
| * @property {object} 0 The full API response. | ||
| */ | ||
| /** | ||
| * Sets the metadata of the Dataset object. | ||
@@ -179,7 +231,7 @@ * | ||
| * @param {object} metadata Metadata to save on the Dataset. | ||
| * @param {function} [callback] The callback function. | ||
| * @param {SetDatasetMetadataCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
| * request. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise} | ||
| * @returns {Promise<SetDatasetMetadataResponse>} | ||
| * | ||
@@ -236,5 +288,6 @@ * @example | ||
| /** | ||
| * List all or some of the {module:bigquery/model} objects in your project | ||
| * List all or some of the {@link Model} objects in your project | ||
| * as a readable object stream. | ||
| * | ||
| * @method Dataset#getModelsStream | ||
| * @param {object} [options] Configuration object. See | ||
@@ -291,5 +344,6 @@ * {@link Dataset#getModels} for a complete list of options. | ||
| /** | ||
| * List all or some of the {module:bigquery/table} objects in your project | ||
| * List all or some of the {@link Table} objects in your project | ||
| * as a readable object stream. | ||
| * | ||
| * @method Dataset#getTablesStream | ||
| * @param {object} [options] Configuration object. See | ||
@@ -331,4 +385,4 @@ * {@link Dataset#getTables} for a complete list of options. | ||
| * @param {object} options See {@link BigQuery#createQueryJob} for full documentation of this method. | ||
| * @param {function} [callback] See {@link BigQuery#createQueryJob} for full documentation of this method. | ||
| * @returns {Promise} See {@link BigQuery#createQueryJob} for full documentation of this method. | ||
| * @param {JobCallback} [callback] See {@link BigQuery#createQueryJob} for full documentation of this method. | ||
| * @returns {Promise<JobResponse>} See {@link BigQuery#createQueryJob} for full documentation of this method. | ||
| */ | ||
@@ -385,3 +439,3 @@ createQueryJob(options, callback) { | ||
| /** | ||
| * Create a routine. | ||
| * Create a {@link Routine}. | ||
| * | ||
@@ -447,3 +501,14 @@ * @see [Routines: insert API Documentation]{@link https://cloud.google.com/bigquery/docs/reference/rest/v2/routines/insert} | ||
| /** | ||
| * Create a table given a tableId or configuration object. | ||
| * @callback TableCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {Table} table The table. | ||
| * @param {object} apiResponse The full API response body. | ||
| */ | ||
| /** | ||
| * @typedef {array} TableResponse | ||
| * @property {Table} 0 The table. | ||
| * @property {object} 1 The full API response body. | ||
| */ | ||
| /** | ||
| * Create a {@link Table} given a tableId or configuration object. | ||
| * | ||
@@ -462,7 +527,7 @@ * @see [Tables: insert API Documentation]{@link https://cloud.google.com/bigquery/docs/reference/v2/tables/insert} | ||
| * a [Table resource](http://goo.gl/sl8Dmg) for more detailed information. | ||
| * @param {function} [callback] The callback function. | ||
| * @param {TableCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this request | ||
| * @param {Table} callback.table The newly created table. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise} | ||
| * @returns {Promise<TableResponse>} | ||
| * | ||
@@ -518,2 +583,11 @@ * @example | ||
| /** | ||
| * @callback DeleteCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {object} apiResponse The full API response body. | ||
| */ | ||
| /** | ||
| * @typedef {array} Metadata | ||
| * @property {object} 0 The full API response body. | ||
| */ | ||
| /** | ||
| * Delete the dataset. | ||
@@ -525,6 +599,6 @@ * | ||
| * @param {boolean} [options.force=false] Force delete dataset and all tables. | ||
| * @param {function} [callback] The callback function. | ||
| * @param {DeleteCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this request | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise} | ||
| * @returns {Promise<Metadata>} | ||
| * | ||
@@ -567,7 +641,31 @@ * @example | ||
| /** | ||
| * Get a list of models. | ||
| * @typedef {object} GetModelsOptions | ||
| * @property {boolean} [autoPaginate=true] Have pagination handled | ||
| * automatically. | ||
| * @property {number} [maxApiCalls] Maximum number of API calls to make. | ||
| * @property {number} [maxResults] Maximum number of results to return. | ||
| * @property {string} [pageToken] Token returned from a previous call, to | ||
| * request the next page of results. | ||
| */ | ||
| /** | ||
| * @callback GetModelsCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {Model[]} models List of model objects. | ||
| * @param {GetModelsOptions} nextQuery If `autoPaginate` is set to true, | ||
| * this will be a prepared query for the next page of results. | ||
| * @param {object} response The full API response. | ||
| */ | ||
| /** | ||
| * @typedef {array} GetModelsResponse | ||
| * @property {Model[]} 0 A list of the dataset's {@link Model} objects. | ||
| * @property {GetModelsOptions} 1 If `autoPaginate` is set to true, this | ||
| * will be a prepared query for the next page of results. | ||
| * @property {object} 2 The full API response. | ||
| */ | ||
| /** | ||
| * Get a list of {@link Model} resources. | ||
| * | ||
| * @see [Models: list API Documentation]{@link https://cloud.google.com/bigquery/docs/reference/rest/v2/models/list} | ||
| * | ||
| * @param {object} [options] Configuration object. | ||
| * @param {GetModelsOptions} [options] Configuration object. | ||
| * @param {boolean} [options.autoPaginate=true] Have pagination handled | ||
@@ -579,7 +677,10 @@ * automatically. | ||
| * request the next page of results. | ||
| * @param {function} [callback] The callback function. | ||
| * @param {GetModelsCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this request | ||
| * @param {Model[]} callback.models The list of models from | ||
| * your Dataset. | ||
| * @returns {Promise} | ||
| * @param {GetModelsOptions} callback.nextQuery If `autoPaginate` is set to true, this | ||
| * will be a prepared query for the next page of results. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise<GetModelsResponse>} | ||
| * | ||
@@ -656,3 +757,3 @@ * @example | ||
| * @typedef {array} GetRoutinesResponse | ||
| * @property {Routine[]} 0 List of routine objects. | ||
| * @property {Routine[]} 0 List of {@link Routine} objects. | ||
| * @property {GetRoutinesOptions} 1 If `autoPaginate` is set to true, this | ||
@@ -668,3 +769,15 @@ * will be a prepared query for the next page of results. | ||
| * @param {GetRoutinesOptions} [options] Request options. | ||
| * @param {boolean} [options.autoPaginate=true] Have pagination handled | ||
| * automatically. | ||
| * @param {number} [options.maxApiCalls] Maximum number of API calls to make. | ||
| * @param {number} [options.maxResults] Maximum number of results to return. | ||
| * @param {string} [options.pageToken] Token returned from a previous call, to | ||
| * request the next page of results. | ||
| * @param {GetRoutinesCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this request | ||
| * @param {Routine[]} callback.routines The list of models from | ||
| * your Dataset. | ||
| * @param {GetRoutinesOptions} callback.nextQuery If `autoPaginate` is set to true, this | ||
| * will be a prepared query for the next page of results. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise<GetRoutinesResponse>} | ||
@@ -722,7 +835,31 @@ * | ||
| /** | ||
| * Get a list of tables. | ||
| * @typedef {object} GetTablesOptions | ||
| * @property {boolean} [autoPaginate=true] Have pagination handled | ||
| * automatically. | ||
| * @property {number} [maxApiCalls] Maximum number of API calls to make. | ||
| * @property {number} [maxResults] Maximum number of results to return. | ||
| * @property {string} [pageToken] Token returned from a previous call, to | ||
| * request the next page of results. | ||
| */ | ||
| /** | ||
| * @callback GetTablesCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {Table[]} tables List of {@link Table} objects. | ||
| * @param {GetTablesOptions} nextQuery If `autoPaginate` is set to true, | ||
| * this will be a prepared query for the next page of results. | ||
| * @param {object} response The full API response. | ||
| */ | ||
| /** | ||
| * @typedef {array} GetTablesResponse | ||
| * @property {Table[]} 0 List of {@link Table} objects. | ||
| * @property {GetTablesOptions} 1 If `autoPaginate` is set to true, this | ||
| * will be a prepared query for the next page of results. | ||
| * @property {object} 2 The full API response. | ||
| */ | ||
| /** | ||
| * Get a list of {@link Table} resources. | ||
| * | ||
| * @see [Tables: list API Documentation]{@link https://cloud.google.com/bigquery/docs/reference/v2/tables/list} | ||
| * | ||
| * @param {object} [options] Configuration object. | ||
| * @param {GetTablesOptions} options Configuration object. | ||
| * @param {boolean} [options.autoPaginate=true] Have pagination handled automatically. | ||
@@ -733,7 +870,10 @@ * @param {number} [options.maxApiCalls] Maximum number of API calls to make. | ||
| * request the next page of results. | ||
| * @param {function} [callback] The callback function. | ||
| * @param {GetTablesCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this request | ||
| * @param {Table[]} callback.tables The list of tables from | ||
| * your Dataset. | ||
| * @returns {Promise} | ||
| * @param {GetTablesOptions} callback.nextQuery If `autoPaginate` is set to true, this | ||
| * will be a prepared query for the next page of results. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise<GetTablesResponse>} | ||
| * | ||
@@ -820,2 +960,12 @@ * @example | ||
| } | ||
| /** | ||
| * Run a query scoped to your dataset. | ||
| * | ||
| * See {@link BigQuery#query} for full documentation of this method. | ||
| * | ||
| * @param {object} options See {@link BigQuery#query} for full documentation of this method. | ||
| * @param {function} [callback] See {@link BigQuery#query} for full documentation of this method. | ||
| * @returns {Promise<SimpleQueryRowsResponse>} | ||
| * @returns {Promise<QueryRowsResponse>} See {@link BigQuery#query} for full documentation of this method. | ||
| */ | ||
| query(options, callback) { | ||
@@ -836,3 +986,3 @@ if (typeof options === 'string') { | ||
| /** | ||
| * Create a Routine object. | ||
| * Create a {@link Routine} object. | ||
| * | ||
@@ -858,3 +1008,3 @@ * @throws {TypeError} if routine ID is missing. | ||
| /** | ||
| * Create a Table object. | ||
| * Create a {@link Table} object. | ||
| * | ||
@@ -861,0 +1011,0 @@ * @throws {TypeError} if table ID is missing. |
@@ -99,10 +99,19 @@ "use strict"; | ||
| /** | ||
| * @callback JobExistsCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {boolean} exists Indicates if the job exists. | ||
| */ | ||
| /** | ||
| * @typedef {array} JobExistsResponse | ||
| * @property {boolean} 0 Indicates if the job exists. | ||
| */ | ||
| /** | ||
| * Check if the job exists. | ||
| * | ||
| * @method Job#exists | ||
| * @param {function} [callback] The callback function. | ||
| * @param {JobExistsCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
| * request. | ||
| * @param {boolean} callback.exists Whether the job exists or not. | ||
| * @returns {Promise} | ||
| * @returns {Promise<JobExistsResponse>} | ||
| * | ||
@@ -126,10 +135,21 @@ * @example | ||
| /** | ||
| * @callback GetJobCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {Model} model The job. | ||
| * @param {object} apiResponse The full API response body. | ||
| */ | ||
| /** | ||
| * @typedef {array} GetJobResponse | ||
| * @property {Model} 0 The job. | ||
| * @property {object} 1 The full API response body. | ||
| */ | ||
| /** | ||
| * Get a job if it exists. | ||
| * | ||
| * @method Job#get | ||
| * @param {function} [callback] The callback function. | ||
| * @param {GetJobCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
| * request. | ||
| * @param {Job} callback.job The job. | ||
| * @returns {Promise} | ||
| * @returns {Promise<GetJobResponse>} | ||
| * | ||
@@ -158,2 +178,13 @@ * @example | ||
| /** | ||
| * @callback GetJobMetadataCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {object} metadata The job metadata. | ||
| * @param {object} apiResponse The full API response. | ||
| */ | ||
| /** | ||
| * @typedef {array} GetJobMetadataResponse | ||
| * @property {object} 0 The job metadata. | ||
| * @property {object} 1 The full API response. | ||
| */ | ||
| /** | ||
| * Get the metadata of the job. This will mostly be useful for checking | ||
@@ -165,3 +196,3 @@ * the status of a previously-run job. | ||
| * @method Job#getMetadata | ||
| * @param {function} [callback] The callback function. | ||
| * @param {GetJobMetadataCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
@@ -171,3 +202,3 @@ * request. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise} | ||
| * @returns {Promise<GetJobMetadataResponse>} | ||
| * | ||
@@ -242,2 +273,13 @@ * @example | ||
| /** | ||
| * @callback CancelCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {object} metadata The job metadata. | ||
| * @param {object} apiResponse The full API response. | ||
| */ | ||
| /** | ||
| * @typedef {array} CancelResponse | ||
| * @property {object} 0 The job metadata. | ||
| * @property {object} 1 The full API response. | ||
| */ | ||
| /** | ||
| * Cancel a job. Use {@link Job#getMetadata} to see if the cancel | ||
@@ -248,6 +290,6 @@ * completes successfully. See an example implementation below. | ||
| * | ||
| * @param {function} [callback] The callback function. | ||
| * @param {CancelCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this request. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise} | ||
| * @returns {Promise<CancelResponse>} | ||
| * | ||
@@ -310,3 +352,3 @@ * @example | ||
| * {@link ManualQueryResultsCallback} should be used. | ||
| * @returns {Promise} | ||
| * @returns {Promise<QueryResultsCallback>} | ||
| * | ||
@@ -313,0 +355,0 @@ * @example |
@@ -49,2 +49,7 @@ "use strict"; | ||
| /** | ||
| * @callback DeleteModelCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {object} apiResponse The full API response. | ||
| */ | ||
| /** | ||
| * Delete the model. | ||
@@ -55,3 +60,3 @@ * | ||
| * @method Model#delete | ||
| * @param {function} [callback] The callback function. | ||
| * @param {DeleteModelCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
@@ -72,13 +77,23 @@ * request. | ||
| * const [apiResponse] = await model.delete(); | ||
| * @example <caption>If successful, the response body is empty.</caption> | ||
| */ | ||
| delete: true, | ||
| /** | ||
| * @callback ModelExistsCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {boolean} exists Indicates if the model exists. | ||
| */ | ||
| /** | ||
| * @typedef {array} ModelExistsResponse | ||
| * @property {boolean} 0 Indicates if the model exists. | ||
| */ | ||
| /** | ||
| * Check if the model exists. | ||
| * | ||
| * @method Model#exists | ||
| * @param {function} [callback] The callback function. | ||
| * @param {ModelExistsCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
| * request. | ||
| * @param {boolean} callback.exists Whether the model exists or not. | ||
| * @returns {Promise} | ||
| * @returns {Promise<ModelExistsResponse>} | ||
| * | ||
@@ -98,2 +113,13 @@ * @example | ||
| /** | ||
| * @callback GetModelCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {Model} model The model. | ||
| * @param {object} apiResponse The full API response body. | ||
| */ | ||
| /** | ||
| * @typedef {array} GetModelResponse | ||
| * @property {Model} 0 The model. | ||
| * @property {object} 1 The full API response body. | ||
| */ | ||
| /** | ||
| * Get a model if it exists. | ||
@@ -104,3 +130,3 @@ * | ||
| * @method Model#get: | ||
| * @param {function} [callback] The callback function. | ||
| * @param {GetModelCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
@@ -110,3 +136,3 @@ * request. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise} | ||
| * @returns {Promise<GetModelResponse>} | ||
| * | ||
@@ -130,2 +156,13 @@ * @example | ||
| /** | ||
| * @callback GetModelMetadataCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {object} metadata The model metadata. | ||
| * @param {object} apiResponse The full API response. | ||
| */ | ||
| /** | ||
| * @typedef {array} GetModelMetadataResponse | ||
| * @property {object} 0 The model metadata. | ||
| * @property {object} 1 The full API response. | ||
| */ | ||
| /** | ||
| * Return the metadata associated with the model. | ||
@@ -136,3 +173,3 @@ * | ||
| * @method Model#getMetadata | ||
| * @param {function} [callback] The callback function. | ||
| * @param {GetModelMetadataCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
@@ -142,3 +179,3 @@ * request. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise} | ||
| * @returns {Promise<GetModelMetadataResponse>} | ||
| * | ||
@@ -158,2 +195,13 @@ * @example | ||
| /** | ||
| * @callback SetModelMetadataCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {object} metadata The model metadata. | ||
| * @param {object} apiResponse The full API response. | ||
| */ | ||
| /** | ||
| * @typedef {array} SetModelMetadataResponse | ||
| * @property {object} 0 The model metadata. | ||
| * @property {object} 1 The full API response. | ||
| */ | ||
| /** | ||
| * @see [Models: patch API Documentation]{@link https://cloud.google.com/bigquery/docs/reference/rest/v2/models/patch} | ||
@@ -163,3 +211,3 @@ * | ||
| * @param {object} metadata The metadata key/value object to set. | ||
| * @param {function} [callback] The callback function. | ||
| * @param {SetModelMetadataCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this | ||
@@ -169,3 +217,3 @@ * request. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise} | ||
| * @returns {Promise<SetModelMetadataResponse>} | ||
| * | ||
@@ -199,2 +247,13 @@ * @example | ||
| /** | ||
| * @callback JobCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {object} Job The [Job]{@link https://cloud.google.com/bigquery/docs/reference/v2/Job} resource. | ||
| * @param {object} apiResponse The full API response. | ||
| */ | ||
| /** | ||
| * @typedef {array} JobResponse | ||
| * @property {object} 0 The [Job]{@link https://cloud.google.com/bigquery/docs/reference/v2/Job} resource. | ||
| * @property {object} 1 The full API response. | ||
| */ | ||
| /** | ||
| * Export model to Cloud Storage. | ||
@@ -208,3 +267,3 @@ * | ||
| * object. | ||
| * @param {object} [options] The configuration object. | ||
| * @param {object} [options] The configuration object. For all extract job options, see [CreateExtractJobOptions]{@link https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationExtract}. | ||
| * @param {string} [options.format] The format to export the data in. | ||
@@ -215,6 +274,7 @@ * Allowed options are "ML_TF_SAVED_MODEL" or "ML_XGBOOST_BOOSTER". | ||
| * @param {string} [options.jobPrefix] Prefix to apply to the job id. | ||
| * @param {function} [callback] The callback function. | ||
| * @param {JobCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this request. | ||
| * @param {Job} callback.job The job used to export the model. | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise<JobResponse>} | ||
| * | ||
@@ -310,2 +370,13 @@ * @throws {Error} If a destination isn't a string or File object. | ||
| /** | ||
| * @callback JobMetadataCallback | ||
| * @param {?Error} err Request error, if any. | ||
| * @param {object} metadata The job metadata. | ||
| * @param {object} apiResponse The full API response. | ||
| */ | ||
| /** | ||
| * @typedef {array} JobMetadataResponse | ||
| * @property {object} 0 The job metadata. | ||
| * @property {object} 1 The full API response. | ||
| */ | ||
| /** | ||
| * Export model to Cloud Storage. | ||
@@ -317,3 +388,3 @@ * | ||
| * object. | ||
| * @param {object} [options] The configuration object. | ||
| * @param {object} [options] The configuration object. For all extract job options, see [CreateExtractJobOptions]{@link https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationExtract}. | ||
| * @param {string} [options.format] The format to export | ||
@@ -324,6 +395,6 @@ * the data in. Allowed options are "ML_TF_SAVED_MODEL" or | ||
| * @param {string} [options.jobPrefix] Prefix to apply to the underlying job id. | ||
| * @param {function} [callback] The callback function. | ||
| * @param {JobMetadataCallback} [callback] The callback function. | ||
| * @param {?error} callback.err An error returned while making this request | ||
| * @param {object} callback.apiResponse The full API response. | ||
| * @returns {Promise} | ||
| * @returns {Promise<JobMetadataResponse>} | ||
| * | ||
@@ -330,0 +401,0 @@ * @throws {Error} If destination isn't a string or File object. |
@@ -105,3 +105,7 @@ "use strict"; | ||
| * | ||
| * routine.delete((err, apiResponse) => {}); | ||
| * routine.delete((err, apiResponse) => { | ||
| * if (!err) { | ||
| * // The routine was deleted successfully. | ||
| * } | ||
| * }); | ||
| * | ||
@@ -108,0 +112,0 @@ * @example <caption>If the callback is omitted a Promise will be returned</caption> |
@@ -7,2 +7,9 @@ # Changelog | ||
| ## [5.8.0](https://www.github.com/googleapis/nodejs-bigquery/compare/v5.7.1...v5.8.0) (2021-08-23) | ||
| ### Features | ||
| * add support for loading Firestore export file ([#991](https://www.github.com/googleapis/nodejs-bigquery/issues/991)) ([c17a44e](https://www.github.com/googleapis/nodejs-bigquery/commit/c17a44ec97af6acff24a712a519355a0957999a3)) | ||
| ### [5.7.1](https://www.github.com/googleapis/nodejs-bigquery/compare/v5.7.0...v5.7.1) (2021-08-10) | ||
@@ -9,0 +16,0 @@ |
| { | ||
| "name": "@google-cloud/bigquery", | ||
| "description": "Google BigQuery Client Library for Node.js", | ||
| "version": "5.7.1", | ||
| "version": "5.8.0", | ||
| "license": "Apache-2.0", | ||
@@ -6,0 +6,0 @@ "author": "Google LLC", |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by3.37%
552628
- Lines of code
- increased by3.64%
11088
No dependency changes