Skip to content
This repository was archived by the owner on Feb 7, 2026. It is now read-only.

Commit 86c63fb

Browse files
alvarowolfxalvarowolfx
authored
feat: support create/list datasets on a different project (#1230)
1 parent cd11447 commit 86c63fb

6 files changed

Lines changed: 145 additions & 62 deletions

File tree

‎samples/listDatasets.js‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,22 @@
1414

1515
'use strict';
1616

17-
function main() {
17+
function main(projectId) {
1818
// [START bigquery_list_datasets]
1919
// Import the Google Cloud client library
2020
const {BigQuery} = require('@google-cloud/bigquery');
2121
const bigquery = new BigQuery();
2222

2323
async function listDatasets() {
24-
// Lists all datasets in current GCP project.
24+
/**
25+
* TODO(developer): Uncomment the following lines before running the sample.
26+
*/
27+
// const projectId = "my_project_id";
2528

26-
// Lists all datasets in the specified project
27-
const [datasets] = await bigquery.getDatasets();
29+
// Lists all datasets in the specified project.
30+
// If projectId is not specified, this method will take
31+
// the projectId from the authenticated BigQuery Client.
32+
const [datasets] = await bigquery.getDatasets({projectId});
2833
console.log('Datasets:');
2934
datasets.forEach(dataset => console.log(dataset.id));
3035
}

‎samples/test/datasets.test.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,12 @@ describe('Datasets', () => {
9898
assert.match(output, new RegExp(datasetId));
9999
});
100100

101+
it('should list datasets on a different project', async () => {
102+
const output = execSync('node listDatasets.js bigquery-public-data');
103+
assert.match(output, /Datasets:/);
104+
assert.match(output, new RegExp('usa_names'));
105+
});
106+
101107
it('should retrieve a dataset if it exists', async () => {
102108
const output = execSync(`node getDataset.js ${datasetId}`);
103109
assert.include(output, 'Dataset:');

‎src/bigquery.ts‎

Lines changed: 70 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,15 @@ export type QueryStreamOptions = {
125125
wrapIntegers?: boolean | IntegerTypeCastOptions;
126126
parseJSON?: boolean;
127127
};
128-
export type DatasetResource = bigquery.IDataset;
128+
export type DatasetResource = bigquery.IDataset & {
129+
projectId?: string;
130+
};
129131
export type ValueType = bigquery.IQueryParameterType;
130132

131-
export type GetDatasetsOptions = PagedRequest<bigquery.datasets.IListParams>;
133+
export type GetDatasetsOptions = PagedRequest<bigquery.datasets.IListParams> & {
134+
projectId?: string;
135+
};
136+
132137
export type DatasetsResponse = PagedResponse<
133138
Dataset,
134139
GetDatasetsOptions,
@@ -1257,35 +1262,36 @@ export class BigQuery extends Service {
12571262
const callback =
12581263
typeof optionsOrCallback === 'function' ? optionsOrCallback : cb;
12591264

1260-
this.request(
1261-
{
1262-
method: 'POST',
1263-
uri: '/datasets',
1264-
json: extend(
1265-
true,
1266-
{
1267-
location: this.location,
1265+
const reqOpts: DecorateRequestOptions = {
1266+
method: 'POST',
1267+
uri: '/datasets',
1268+
json: extend(
1269+
true,
1270+
{
1271+
location: this.location,
1272+
},
1273+
options,
1274+
{
1275+
datasetReference: {
1276+
datasetId: id,
12681277
},
1269-
options,
1270-
{
1271-
datasetReference: {
1272-
datasetId: id,
1273-
},
1274-
}
1275-
),
1276-
},
1277-
(err, resp) => {
1278-
if (err) {
1279-
callback!(err, null, resp);
1280-
return;
12811278
}
1279+
),
1280+
};
1281+
if (options.projectId) {
1282+
reqOpts.projectId = options.projectId;
1283+
}
1284+
this.request(reqOpts, (err, resp) => {
1285+
if (err) {
1286+
callback!(err, null, resp);
1287+
return;
1288+
}
12821289

1283-
const dataset = this.dataset(id);
1284-
dataset.metadata = resp;
1290+
const dataset = this.dataset(id, options);
1291+
dataset.metadata = resp;
12851292

1286-
callback!(null, dataset, resp);
1287-
}
1288-
);
1293+
callback!(null, dataset, resp);
1294+
});
12891295
}
12901296

12911297
/**
@@ -1664,6 +1670,7 @@ export class BigQuery extends Service {
16641670
*
16651671
* @param {string} id ID of the dataset.
16661672
* @param {object} [options] Dataset options.
1673+
* @param {string} [options.projectId] The GCP project ID.
16671674
* @param {string} [options.location] The geographic location of the dataset.
16681675
* Required except for US and EU.
16691676
*
@@ -1686,12 +1693,13 @@ export class BigQuery extends Service {
16861693
}
16871694

16881695
/**
1689-
* List all or some of the datasets in your project.
1696+
* List all or some of the datasets in a project.
16901697
*
16911698
* See {@link https://cloud.google.com/bigquery/docs/reference/v2/datasets/list| Datasets: list API Documentation}
16921699
*
16931700
* @param {object} [options] Configuration object.
16941701
* @param {boolean} [options.all] List all datasets, including hidden ones.
1702+
* @param {string} [options.projectId] The GCP project ID.
16951703
* @param {boolean} [options.autoPaginate] Have pagination handled automatically.
16961704
* Default: true.
16971705
* @param {number} [options.maxApiCalls] Maximum number of API calls to make.
@@ -1746,40 +1754,45 @@ export class BigQuery extends Service {
17461754
const callback =
17471755
typeof optionsOrCallback === 'function' ? optionsOrCallback : cb;
17481756

1749-
this.request(
1750-
{
1751-
uri: '/datasets',
1752-
qs: options,
1753-
},
1754-
(err, resp) => {
1755-
if (err) {
1756-
callback!(err, null, null, resp);
1757-
return;
1758-
}
1757+
const reqOpts: DecorateRequestOptions = {
1758+
uri: '/datasets',
1759+
qs: options,
1760+
};
1761+
if (options.projectId) {
1762+
reqOpts.projectId = options.projectId;
1763+
}
1764+
this.request(reqOpts, (err, resp) => {
1765+
if (err) {
1766+
callback!(err, null, null, resp);
1767+
return;
1768+
}
17591769

1760-
let nextQuery: GetDatasetsOptions | null = null;
1770+
let nextQuery: GetDatasetsOptions | null = null;
17611771

1762-
if (resp.nextPageToken) {
1763-
nextQuery = Object.assign({}, options, {
1764-
pageToken: resp.nextPageToken,
1765-
});
1766-
}
1772+
if (resp.nextPageToken) {
1773+
nextQuery = Object.assign({}, options, {
1774+
pageToken: resp.nextPageToken,
1775+
});
1776+
}
17671777

1768-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
1769-
const datasets = (resp.datasets || []).map(
1770-
(dataset: bigquery.IDataset) => {
1771-
const ds = this.dataset(dataset.datasetReference!.datasetId!, {
1772-
location: dataset.location!,
1773-
});
1774-
1775-
ds.metadata = dataset!;
1776-
return ds;
1778+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
1779+
const datasets = (resp.datasets || []).map(
1780+
(dataset: bigquery.IDataset) => {
1781+
const dsOpts: DatasetOptions = {
1782+
location: dataset.location!,
1783+
};
1784+
if (options.projectId) {
1785+
dsOpts.projectId = options.projectId;
17771786
}
1778-
);
1787+
const ds = this.dataset(dataset.datasetReference!.datasetId!, dsOpts);
17791788

1780-
callback!(null, datasets, nextQuery, resp);
1781-
}
1782-
);
1789+
ds.metadata = dataset!;
1790+
return ds;
1791+
}
1792+
);
1793+
1794+
callback!(null, datasets, nextQuery, resp);
1795+
});
17831796
}
17841797

17851798
/**

‎src/dataset.ts‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ export type TableCallback = ResourceCallback<Table, bigquery.ITable>;
109109
* @param {BigQuery} bigQuery {@link BigQuery} instance.
110110
* @param {string} id The ID of the Dataset.
111111
* @param {object} [options] Dataset options.
112+
* @param {string} [options.projectId] The GCP project ID.
112113
* @param {string} [options.location] The geographic location of the dataset.
113114
* Defaults to US.
114115
*
@@ -372,7 +373,12 @@ class Dataset extends ServiceObject {
372373
typeof optionsOrCallback === 'function'
373374
? (optionsOrCallback as DatasetCallback)
374375
: cb;
375-
options = extend({}, options, {location: this.location});
376+
if (this.location) {
377+
options = extend({}, options, {location: this.location});
378+
}
379+
if (this.projectId) {
380+
options = extend({}, options, {projectId: this.projectId});
381+
}
376382
return bigQuery.createDataset(id, options, callback!);
377383
},
378384
});

‎test/bigquery.ts‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ afterEach(() => sandbox.restore());
148148
describe('BigQuery', () => {
149149
const JOB_ID = 'JOB_ID';
150150
const PROJECT_ID = 'test-project';
151+
const ANOTHER_PROJECT_ID = 'another-test-project';
151152
const LOCATION = 'asia-northeast1';
152153

153154
// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -1592,6 +1593,30 @@ describe('BigQuery', () => {
15921593
bq.createDataset(DATASET_ID, assert.ifError);
15931594
});
15941595

1596+
it('should create a dataset on a different project', done => {
1597+
bq.makeAuthenticatedRequest = (reqOpts: DecorateRequestOptions) => {
1598+
assert.strictEqual(reqOpts.method, 'POST');
1599+
assert.strictEqual(reqOpts.projectId, ANOTHER_PROJECT_ID);
1600+
assert.strictEqual(
1601+
reqOpts.uri,
1602+
`https://bigquery.googleapis.com/bigquery/v2/projects/${ANOTHER_PROJECT_ID}/datasets`
1603+
);
1604+
assert.deepStrictEqual(reqOpts.json.datasetReference, {
1605+
datasetId: DATASET_ID,
1606+
});
1607+
1608+
done();
1609+
};
1610+
1611+
bq.createDataset(
1612+
DATASET_ID,
1613+
{
1614+
projectId: ANOTHER_PROJECT_ID,
1615+
},
1616+
assert.ifError
1617+
);
1618+
});
1619+
15951620
it('should send the location if available', done => {
15961621
const bq = new BigQuery({
15971622
projectId: PROJECT_ID,
@@ -2514,6 +2539,20 @@ describe('BigQuery', () => {
25142539
done();
25152540
});
25162541
});
2542+
2543+
it('should fetch datasets from a different project', done => {
2544+
const queryObject = {projectId: ANOTHER_PROJECT_ID};
2545+
2546+
bq.makeAuthenticatedRequest = (reqOpts: DecorateRequestOptions) => {
2547+
assert.strictEqual(
2548+
reqOpts.uri,
2549+
`https://bigquery.googleapis.com/bigquery/v2/projects/${ANOTHER_PROJECT_ID}/datasets`
2550+
);
2551+
done();
2552+
};
2553+
2554+
bq.getDatasets(queryObject, assert.ifError);
2555+
});
25172556
});
25182557

25192558
describe('getJobs', () => {

‎test/dataset.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,20 @@ describe('BigQuery/Dataset', () => {
203203
ds.location = LOCATION;
204204
config.createMethod(DATASET_ID, done);
205205
});
206+
207+
it('should pass the projectId', done => {
208+
bq.createDataset = (
209+
id: string,
210+
options: DatasetOptions,
211+
callback: Function
212+
) => {
213+
assert.strictEqual(options.projectId, 'project-id');
214+
callback(); // the done fn
215+
};
216+
217+
ds.projectId = 'project-id';
218+
config.createMethod(DATASET_ID, done);
219+
});
206220
});
207221

208222
describe('projectId override interceptor', () => {

0 commit comments

Comments
 (0)