Skip to content

feat(drivers): add an option to skip connection test probes in bigquery, aurora, postgres(redshift), snowflake #8841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

feat(drivers): add an option to skip connection test probes in bigquery, aurora, postgres(redshift), snowflake #8841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions packages/cubejs-bigquery-driver/src/BigQueryDriver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,15 @@ export class BigQueryDriver extends BaseDriver implements DriverInterface {
testConnectionTimeout?: number,
} = {}
) {
super({
testConnectionTimeout: config.testConnectionTimeout,
});

const dataSource =
config.dataSource ||
assertDataSource('default');

super({
testConnectionTimeout: config.testConnectionTimeout,
isTestConnectionDisabled: getEnv('dbDisableTestConnection', { dataSource }),
});

this.options = {
scopes: [
'https://www.googleapis.com/auth/bigquery',
Expand Down Expand Up @@ -155,6 +156,10 @@ export class BigQueryDriver extends BaseDriver implements DriverInterface {
}

public async testConnection() {
if (this.isTestConnectionDisabled()) {
return;
}

await this.bigquery.query({
query: 'SELECT ? AS number',
params: ['1'],
Expand Down
17 changes: 11 additions & 6 deletions packages/cubejs-mysql-aurora-serverless-driver/driver/AuroraServerlessMySqlDriver.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,15 @@ class AuroraServerlessMySqlDriver extends BaseDriver {
* Class constructor.
*/
constructor(config = {}) {
super({
testConnectionTimeout: config.testConnectionTimeout,
});

const dataSource =
config.dataSource ||
assertDataSource('default');


super({
testConnectionTimeout: config.testConnectionTimeout,
isTestConnectionDisabled: getEnv('dbDisableTestConnection', { dataSource }),
});

this.config = {
secretArn:
config.secretArn ||
Expand All @@ -66,7 +67,11 @@ class AuroraServerlessMySqlDriver extends BaseDriver {
}

async testConnection() {
return this.dataApi.query('SELECT 1');
if (this.isTestConnectionDisabled()) {
return;
}

await this.dataApi.query('SELECT 1');
}

positionBindings(sql) {
Expand Down
17 changes: 11 additions & 6 deletions packages/cubejs-postgres-driver/src/PostgresDriver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,15 @@ export class PostgresDriver<Config extends PostgresDriverConfiguration = Postgre
testConnectionTimeout?: number,
} = {}
) {
const dataSource =
config.dataSource ||
assertDataSource('default');

super({
testConnectionTimeout: config.testConnectionTimeout,
isTestConnectionDisabled: getEnv('dbDisableTestConnection', { dataSource }),
});

const dataSource =
config.dataSource ||
assertDataSource('default');

this.pool = new Pool({
idleTimeoutMillis: 30000,
max:
Expand Down Expand Up @@ -146,9 +147,9 @@ export class PostgresDriver<Config extends PostgresDriverConfiguration = Postgre
}

protected primaryKeysQuery(conditionString?: string): string | null {
return `SELECT
return `SELECT
columns.table_schema as ${this.quoteIdentifier('table_schema')},
columns.table_name as ${this.quoteIdentifier('table_name')},
columns.table_name as ${this.quoteIdentifier('table_name')},
columns.column_name as ${this.quoteIdentifier('column_name')}
FROM information_schema.table_constraints tc
JOIN information_schema.constraint_column_usage AS ccu USING (constraint_schema, constraint_name)
Expand Down Expand Up @@ -225,6 +226,10 @@ export class PostgresDriver<Config extends PostgresDriverConfiguration = Postgre
}

public async testConnection(): Promise<void> {
if (this.isTestConnectionDisabled()) {
return;
}

try {
await this.pool.query('SELECT $1::int AS number', ['1']);
} catch (e) {
Expand Down
13 changes: 9 additions & 4 deletions packages/cubejs-snowflake-driver/src/SnowflakeDriver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,14 +241,15 @@ export class SnowflakeDriver extends BaseDriver implements DriverInterface {
testConnectionTimeout?: number,
} = {}
) {
super({
testConnectionTimeout: config.testConnectionTimeout,
});

const dataSource =
config.dataSource ||
assertDataSource('default');

super({
testConnectionTimeout: config.testConnectionTimeout,
isTestConnectionDisabled: getEnv('dbDisableTestConnection', { dataSource }),
});

let privateKey = getEnv('snowflakePrivateKey', { dataSource });
if (privateKey && !privateKey.endsWith('\n')) {
privateKey += '\n';
Expand Down Expand Up @@ -420,6 +421,10 @@ export class SnowflakeDriver extends BaseDriver implements DriverInterface {
* Test driver's connection.
*/
public async testConnection() {
if (this.isTestConnectionDisabled()) {
return;
}

const connection = await this.createConnection();

await new Promise(
Expand Down
Loading