Skip to content

feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)#7

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
ihistand wants to merge 1 commit into from
Closed

feat(postgres-adapter): implement IDbAdapter contract (Phase 3a) #7

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
7 changes: 2 additions & 5 deletions cli/api/BUILD
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,6 @@ ts_library(
exclude = [
"utils/**/*.*",
"**/*_test.ts",
# Postgres adapter — relocated from api/ in Phase 2.
# Excluded until Phase 3 (interface alignment + proto IJDBC →
# PostgresConnection rewrite) makes it compile against the
# current IDbAdapter contract.
"dbadapters/postgres.ts",
],
),
deps = [
Expand All@@ -38,6 +33,7 @@ ts_library(
"@npm//@types/js-yaml",
"@npm//@types/long",
"@npm//@types/node",
"@npm//@types/pg",
"@npm//@types/semver",
"@npm//@types/tmp",
"@npm//deepmerge",
Expand All@@ -46,6 +42,7 @@ ts_library(
"@npm//google-sql-syntax-ts",
"@npm//js-beautify",
"@npm//js-yaml",
"@npm//pg",
"@npm//promise-pool-executor",
"@npm//protobufjs",
"@npm//semver",
Expand Down
224 changes: 124 additions & 100 deletions cli/api/dbadapters/postgres.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,110 @@
import * as pg from "pg";

import { Credentials } from "sa/cli/api/commands/credentials";
import { IDbAdapter, IDbClient } from "sa/cli/api/dbadapters/index";
import { collectEvaluationQueries, QueryOrAction } from "sa/cli/api/dbadapters/execution_sql";
import {
IDbAdapter,
IDbClient,
IExecutionResult,
IExecutionResultRaw,
OnCancel
} from "sa/cli/api/dbadapters/index";
import { parsePostgresEvalError } from "sa/cli/api/utils/error_parsing";
import { convertFieldType, PgPoolExecutor } from "sa/cli/api/utils/postgres";
import { ErrorWithCause } from "sa/common/errors/errors";
import { sqlanvil } from "sa/protos/ts";

interface IPostgresAdapterOptions {
sshTunnel?: SSHTunnelProxy;
}
const INTERNAL_SCHEMAS = new Set(["information_schema", "pg_catalog", "pg_internal", "pg_toast"]);

export class PostgresDbAdapter implements IDbAdapter {
public static async create(
credentials: Credentials,
credentials: sqlanvil.IPostgresConnection,
options?: { concurrencyLimit?: number; disableSslForTestsOnly?: boolean }
) {
const jdbcCredentials = credentials as sqlanvil.IJDBC;
const baseClientConfig: Partial<pg.ClientConfig> = {
user: jdbcCredentials.username,
password: jdbcCredentials.password,
database: jdbcCredentials.databaseName,
ssl: options?.disableSslForTestsOnly
? false
: {
rejectUnauthorized: false,
ca: jdbcCredentials.ssl?.serverCertificate,
cert: jdbcCredentials.ssl?.clientCertificate,
key: jdbcCredentials.ssl?.clientPrivateKey
): Promise<PostgresDbAdapter> {
const sslMode = (credentials.sslMode || "").toLowerCase();
const sslEnabled = !options?.disableSslForTestsOnly && sslMode !== "disable";
const clientConfig: pg.ClientConfig = {
host: credentials.host,
port: credentials.port,
database: credentials.database,
user: credentials.user,
password: credentials.password,
ssl: sslEnabled
? {
// Supabase and most managed Postgres providers serve certs signed
// by their own CA. Skipping verification is the documented path
// for `sslmode=require`. Stricter `verify-ca` / `verify-full`
// requires a CA bundle that we don't ship today.
rejectUnauthorized: sslMode === "verify-ca" || sslMode === "verify-full"
}
: false
};
if (jdbcCredentials.sshTunnel) {
const sshTunnel = await SSHTunnelProxy.create(jdbcCredentials.sshTunnel, {
host: jdbcCredentials.host,
port: jdbcCredentials.port
});
const queryExecutor = new PgPoolExecutor(
{
...baseClientConfig,
host: "127.0.0.1",
port: sshTunnel.localPort
},
options
);
return new PostgresDbAdapter(queryExecutor, { sshTunnel });
} else {
const clientConfig: pg.ClientConfig = {
...baseClientConfig,
host: jdbcCredentials.host,
port: jdbcCredentials.port
};
const queryExecutor = new PgPoolExecutor(clientConfig, options);
return new PostgresDbAdapter(queryExecutor, {});
}
const queryExecutor = new PgPoolExecutor(clientConfig, options);
return new PostgresDbAdapter(queryExecutor);
}

private constructor(
private readonly queryExecutor: PgPoolExecutor,
private readonly options: IPostgresAdapterOptions
) {}
private constructor(private readonly queryExecutor: PgPoolExecutor) {}

public async execute(
statement: string,
options: {
params?: any[];
onCancel?: (handleCancel: () => void) => void;
onCancel?: OnCancel;
rowLimit?: number;
byteLimit?: number;
includeQueryInError?: boolean;
} = { rowLimit: 1000, byteLimit: 1024 * 1024 }
) {
return await this.withClientLock(executor => executor.execute(statement, options));
): Promise<IExecutionResult> {
return await this.withClientLock(client => client.execute(statement, options));
}

public async executeRaw(
statement: string,
options: {
params?: any[];
rowLimit?: number;
} = { rowLimit: 1000 }
): Promise<IExecutionResultRaw> {
const result = await this.execute(statement, options);
return { ...result, schema: [] };
}

public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>) {
public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>): Promise<T> {
return await this.queryExecutor.withClientLock(client =>
callback({
execute: async (
statement: string,
options: {
stmt: string,
opts: {
params?: any[];
onCancel?: OnCancel;
rowLimit?: number;
byteLimit?: number;
includeQueryInError?: boolean;
} = { rowLimit: 1000, byteLimit: 1024 * 1024 }
) => {
): Promise<IExecutionResult> => {
try {
const rows = await client.execute(statement, options);
const rows = await client.execute(stmt, opts);
return { rows, metadata: {} };
} catch (e) {
if (options.includeQueryInError) {
throw new Error(`Error encountered while running "${statement}": ${e.message}`);
if (opts.includeQueryInError) {
throw new Error(`Error encountered while running "${stmt}": ${e.message}`);
}
throw new ErrorWithCause(`Error executing postgres query: ${e.message}`, e);
}
},
executeRaw: async (
stmt: string,
opts: { params?: { [name: string]: any }; rowLimit?: number } = { rowLimit: 1000 }
): Promise<IExecutionResultRaw> => {
// Convert named param object to positional array — pg uses $1, $2 etc.
const positional = opts.params ? Object.values(opts.params) : undefined;
const rows = await client.execute(stmt, { params: positional, rowLimit: opts.rowLimit });
return { rows, schema: [], metadata: {} };
}
})
);
}

public async evaluate(queryOrAction: QueryOrAction) {
public async evaluate(queryOrAction: QueryOrAction): Promise<sqlanvil.IQueryEvaluation[]> {
const validationQueries = collectEvaluationQueries(queryOrAction, false, (query: string) =>
!!query ? `explain ${query}` : ""
).map((validationQuery, index) => ({ index, validationQuery }));
Expand All@@ -115,7 +120,7 @@ export class PostgresDbAdapter implements IDbAdapter {
} catch (e) {
evaluationResponse = {
status: sqlanvil.QueryEvaluation.QueryEvaluationStatus.FAILURE,
error: parseRedshiftEvalError(validationQuery.query, e)
error: parsePostgresEvalError(validationQuery.query, e)
};
}
queryEvaluations.push(
Expand All@@ -129,33 +134,45 @@ export class PostgresDbAdapter implements IDbAdapter {
return queryEvaluations;
}

public async tables(): Promise<sqlanvil.ITarget[]> {
public async tables(
_database: string,
schema?: string
): Promise<sqlanvil.ITableMetadata[]> {
const params: any[] = [];
let schemaClause = "";
if (schema) {
schemaClause = "and table_schema = $1";
params.push(schema);
}
const queryResult = await this.execute(
`select table_name, table_schema
from information_schema.tables
where table_schema != 'information_schema'
and table_schema != 'pg_catalog'
and table_schema != 'pg_internal'`,
{ rowLimit: 10000, includeQueryInError: true }
from information_schema.tables
where table_schema not in ('information_schema', 'pg_catalog', 'pg_internal', 'pg_toast')
${schemaClause}`,
{ params, rowLimit: 10000, includeQueryInError: true }
);
const { rows } = queryResult;
return rows.map(row => ({
schema: row.table_schema,
name: row.table_name
const targets = queryResult.rows.map(row => ({
schema: row.table_schema as string,
name: row.table_name as string
}));
// Hydrate full metadata for each target — IDbAdapter.tables returns
// ITableMetadata[], not ITarget[].
return await Promise.all(targets.map(target => this.table(target)));
}

public async search(
searchText: string,
options: { limit: number } = { limit: 1000 }
): Promise<sqlanvil.ITableMetadata[]> {
// TODO: It would be nice to extend this to search through table/column descriptions. However, this involves
// a somewhat crazy 5-way join.
const results = await this.execute(
`select tables.table_schema as table_schema, tables.table_name as table_name
from information_schema.tables as tables
left join information_schema.columns columns on tables.table_schema = columns.table_schema and tables.table_name = columns.table_name
where tables.table_schema ilike $1 or tables.table_name ilike $1 or columns.column_name ilike $1
left join information_schema.columns columns
on tables.table_schema = columns.table_schema
and tables.table_name = columns.table_name
where tables.table_schema ilike $1
or tables.table_name ilike $1
or columns.column_name ilike $1
group by 1, 2`,
{
params: [`%${searchText}%`],
Expand DownExpand Up@@ -186,13 +203,13 @@ export class PostgresDbAdapter implements IDbAdapter {
{ params, includeQueryInError: true }
),
this.execute(
`
select objsubid as column_number, description from pg_description
where objoid = (
select oid from pg_class where relname = $2 and relnamespace = (
select oid from pg_namespace where nspname = $1
)
)`,
`select objsubid as column_number, description
from pg_description
where objoid = (
select oid from pg_class where relname = $2 and relnamespace = (
select oid from pg_namespace where nspname = $1
)
)`,
{ params, includeQueryInError: true }
)
]);
Expand DownExpand Up@@ -220,38 +237,42 @@ export class PostgresDbAdapter implements IDbAdapter {
});
}

public async preview(target: sqlanvil.ITarget, limitRows: number = 10): Promise<any[]> {
const { rows } = await this.execute(
`SELECT * FROM "${target.schema}"."${target.name}" LIMIT ${limitRows}`
public async deleteTable(target: sqlanvil.ITarget): Promise<void> {
const metadata = await this.table(target);
if (!metadata) {
return;
}
const kind = metadata.type === sqlanvil.TableMetadata.Type.VIEW ? "view" : "table";
await this.execute(
`drop ${kind} if exists "${target.schema}"."${target.name}" cascade`,
{ includeQueryInError: true }
);
return rows;
}

public async schemas(): Promise<string[]> {
const schemas = await this.execute(`select nspname from pg_namespace`, {
public async schemas(_database: string): Promise<string[]> {
const result = await this.execute(`select nspname from pg_namespace`, {
includeQueryInError: true
});
return schemas.rows.map(row => row.nspname);
}

public async createSchema(_: string, schema: string): Promise<void> {
await this.execute(`create schema if not exists "${schema}"`, { includeQueryInError: true });
return result.rows
.map(row => row.nspname as string)
.filter(name => !INTERNAL_SCHEMAS.has(name) && !name.startsWith("pg_"));
}

public async close() {
await this.queryExecutor.close();
if (this.options.sshTunnel) {
await this.options.sshTunnel.close();
}
public async createSchema(_database: string, schema: string): Promise<void> {
await this.execute(`create schema if not exists "${schema}"`, {
includeQueryInError: true
});
}

public async setMetadata(action: sqlanvil.IExecutionAction): Promise<void> {
const { target, actionDescriptor, tableType } = action;

const actualMetadata = await this.table(target);
if (!actualMetadata) {
return;
}

const queries: Array<Promise<any>> = [];
if (actionDescriptor.description) {
const queries: Array<Promise<unknown>> = [];
if (actionDescriptor?.description) {
queries.push(
this.execute(
`comment on ${tableType === "view" ? "view" : "table"} "${target.schema}"."${
Expand All@@ -260,7 +281,7 @@ export class PostgresDbAdapter implements IDbAdapter {
)
);
}
if (actionDescriptor.columns?.length > 0) {
if (actionDescriptor?.columns?.length > 0) {
actionDescriptor.columns
.filter(
column =>
Expand All@@ -277,7 +298,10 @@ export class PostgresDbAdapter implements IDbAdapter {
);
});
}

await Promise.all(queries);
}

public async close(): Promise<void> {
await this.queryExecutor.close();
}
}
11 changes: 4 additions & 7 deletions cli/api/utils/BUILD
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,19 +4,16 @@ load("//tools:ts_library.bzl", "ts_library")

ts_library(
name = "utils",
srcs = glob(
["**/*.ts"],
# Postgres helper — relocated from api/utils/ in Phase 2.
# Excluded until Phase 3 wires it through cli/api's BUILD with
# the right pg/pg-query-stream deps and an updated import surface.
exclude = ["postgres.ts"],
),
srcs = glob(["**/*.ts"]),
deps = [
"//common/protos",
"//common/strings",
"//core",
"//protos:ts",
"@npm//@types/node",
"@npm//@types/pg",
"@npm//object-sizeof",
"@npm//pg",
"@npm//pg-query-stream",
],
)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a) by ihistand · Pull Request #7 · SQLAnvil/sqlanvil · GitHub
Skip to content
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)#7

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

ihistand
wants to merge
1
commit into

from

 Closed


feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)
#7
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


7 changes: 2 additions & 5 deletions
cli/api/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,6 @@ ts_library(
 exclude = [
 "utils/**/*.*",
 "**/*_test.ts",
 # Postgres adapter — relocated from api/ in Phase 2.
 # Excluded until Phase 3 (interface alignment + proto IJDBC →
 # PostgresConnection rewrite) makes it compile against the
 # current IDbAdapter contract.
 "dbadapters/postgres.ts",
 ],
 ),
 deps = [
Expand All@@ -38,6 +33,7 @@ ts_library(
 "@npm//@types/js-yaml",
 "@npm//@types/long",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//@types/semver",
 "@npm//@types/tmp",
 "@npm//deepmerge",
Expand All@@ -46,6 +42,7 @@ ts_library(
 "@npm//google-sql-syntax-ts",
 "@npm//js-beautify",
 "@npm//js-yaml",
 "@npm//pg",
 "@npm//promise-pool-executor",
 "@npm//protobufjs",
 "@npm//semver",
Expand Down

224 changes: 124 additions & 100 deletions
cli/api/dbadapters/postgres.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,105 +1,110 @@
import * as pg from "pg";

import { Credentials } from "sa/cli/api/commands/credentials";
import { IDbAdapter, IDbClient } from "sa/cli/api/dbadapters/index";
import { collectEvaluationQueries, QueryOrAction } from "sa/cli/api/dbadapters/execution_sql";
import {
 IDbAdapter,
 IDbClient,
 IExecutionResult,
 IExecutionResultRaw,
 OnCancel
} from "sa/cli/api/dbadapters/index";
import { parsePostgresEvalError } from "sa/cli/api/utils/error_parsing";
import { convertFieldType, PgPoolExecutor } from "sa/cli/api/utils/postgres";
import { ErrorWithCause } from "sa/common/errors/errors";
import { sqlanvil } from "sa/protos/ts";

interface IPostgresAdapterOptions {
 sshTunnel?: SSHTunnelProxy;
}
const INTERNAL_SCHEMAS = new Set(["information_schema", "pg_catalog", "pg_internal", "pg_toast"]);

export class PostgresDbAdapter implements IDbAdapter {
 public static async create(
 credentials: Credentials,
 credentials: sqlanvil.IPostgresConnection,
 options?: { concurrencyLimit?: number; disableSslForTestsOnly?: boolean }
 ) {
 const jdbcCredentials = credentials as sqlanvil.IJDBC;
 const baseClientConfig: Partial<pg.ClientConfig> = {
 user: jdbcCredentials.username,
 password: jdbcCredentials.password,
 database: jdbcCredentials.databaseName,
 ssl: options?.disableSslForTestsOnly
 ? false
 : {
 rejectUnauthorized: false,
 ca: jdbcCredentials.ssl?.serverCertificate,
 cert: jdbcCredentials.ssl?.clientCertificate,
 key: jdbcCredentials.ssl?.clientPrivateKey
 ): Promise<PostgresDbAdapter> {
 const sslMode = (credentials.sslMode || "").toLowerCase();
 const sslEnabled = !options?.disableSslForTestsOnly && sslMode !== "disable";
 const clientConfig: pg.ClientConfig = {
 host: credentials.host,
 port: credentials.port,
 database: credentials.database,
 user: credentials.user,
 password: credentials.password,
 ssl: sslEnabled
 ? {
 // Supabase and most managed Postgres providers serve certs signed
 // by their own CA. Skipping verification is the documented path
 // for `sslmode=require`. Stricter `verify-ca` / `verify-full`
 // requires a CA bundle that we don't ship today.
 rejectUnauthorized: sslMode === "verify-ca" || sslMode === "verify-full"
 }
 : false
 };
 if (jdbcCredentials.sshTunnel) {
 const sshTunnel = await SSHTunnelProxy.create(jdbcCredentials.sshTunnel, {
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 });
 const queryExecutor = new PgPoolExecutor(
 {
 ...baseClientConfig,
 host: "127.0.0.1",
 port: sshTunnel.localPort
 },
 options
 );
 return new PostgresDbAdapter(queryExecutor, { sshTunnel });
 } else {
 const clientConfig: pg.ClientConfig = {
 ...baseClientConfig,
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 };
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor, {});
 }
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor);
 }

 private constructor(
 private readonly queryExecutor: PgPoolExecutor,
 private readonly options: IPostgresAdapterOptions
 ) {}
 private constructor(private readonly queryExecutor: PgPoolExecutor) {}

 public async execute(
 statement: string,
 options: {
 params?: any[];
 onCancel?: (handleCancel: () => void) => void;
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) {
 return await this.withClientLock(executor => executor.execute(statement, options));
 ): Promise<IExecutionResult> {
 return await this.withClientLock(client => client.execute(statement, options));
 }

 public async executeRaw(
 statement: string,
 options: {
 params?: any[];
 rowLimit?: number;
 } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> {
 const result = await this.execute(statement, options);
 return { ...result, schema: [] };
 }

 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>) {
 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>): Promise<T> {
 return await this.queryExecutor.withClientLock(client =>
 callback({
 execute: async (
statement: string,
options: {
stmt: string,
opts: {
 params?: any[];
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) => {
 ): Promise<IExecutionResult> => {
 try {
 const rows = await client.execute(statement, options);
 const rows = await client.execute(stmt, opts);
 return { rows, metadata: {} };
 } catch (e) {
 if (options.includeQueryInError) {
 throw new Error(`Error encountered while running "${statement}": ${e.message}`);
 if (opts.includeQueryInError) {
 throw new Error(`Error encountered while running "${stmt}": ${e.message}`);
 }
 throw new ErrorWithCause(`Error executing postgres query: ${e.message}`, e);
 }
 },
 executeRaw: async (
 stmt: string,
 opts: { params?: { [name: string]: any }; rowLimit?: number } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> => {
 // Convert named param object to positional array — pg uses $1, $2 etc.
 const positional = opts.params ? Object.values(opts.params) : undefined;
 const rows = await client.execute(stmt, { params: positional, rowLimit: opts.rowLimit });
 return { rows, schema: [], metadata: {} };
 }
 })
 );
 }

 public async evaluate(queryOrAction: QueryOrAction) {
 public async evaluate(queryOrAction: QueryOrAction): Promise<sqlanvil.IQueryEvaluation[]> {
 const validationQueries = collectEvaluationQueries(queryOrAction, false, (query: string) =>
 !!query ? `explain ${query}` : ""
 ).map((validationQuery, index) => ({ index, validationQuery }));
Expand All@@ -115,7 +120,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 } catch (e) {
 evaluationResponse = {
 status: sqlanvil.QueryEvaluation.QueryEvaluationStatus.FAILURE,
 error: parseRedshiftEvalError(validationQuery.query, e)
 error: parsePostgresEvalError(validationQuery.query, e)
 };
 }
 queryEvaluations.push(
Expand All@@ -129,33 +134,45 @@ export class PostgresDbAdapter implements IDbAdapter {
 return queryEvaluations;
 }

 public async tables(): Promise<sqlanvil.ITarget[]> {
 public async tables(
 _database: string,
 schema?: string
 ): Promise<sqlanvil.ITableMetadata[]> {
 const params: any[] = [];
 let schemaClause = "";
 if (schema) {
 schemaClause = "and table_schema = $1";
 params.push(schema);
 }
 const queryResult = await this.execute(
 `select table_name, table_schema
 from information_schema.tables
 where table_schema != 'information_schema'
 and table_schema != 'pg_catalog'
 and table_schema != 'pg_internal'`,
 { rowLimit: 10000, includeQueryInError: true }
 from information_schema.tables
 where table_schema not in ('information_schema', 'pg_catalog', 'pg_internal', 'pg_toast')
 ${schemaClause}`,
 { params, rowLimit: 10000, includeQueryInError: true }
 );
 const { rows } = queryResult;
 return rows.map(row => ({
 schema: row.table_schema,
 name: row.table_name
 const targets = queryResult.rows.map(row => ({
 schema: row.table_schema as string,
 name: row.table_name as string
 }));
 // Hydrate full metadata for each target — IDbAdapter.tables returns
 // ITableMetadata[], not ITarget[].
 return await Promise.all(targets.map(target => this.table(target)));
 }

 public async search(
 searchText: string,
 options: { limit: number } = { limit: 1000 }
 ): Promise<sqlanvil.ITableMetadata[]> {
 // TODO: It would be nice to extend this to search through table/column descriptions. However, this involves
 // a somewhat crazy 5-way join.
 const results = await this.execute(
 `select tables.table_schema as table_schema, tables.table_name as table_name
 from information_schema.tables as tables
 left join information_schema.columns columns on tables.table_schema = columns.table_schema and tables.table_name = columns.table_name
 where tables.table_schema ilike $1 or tables.table_name ilike $1 or columns.column_name ilike $1
 left join information_schema.columns columns
 on tables.table_schema = columns.table_schema
 and tables.table_name = columns.table_name
 where tables.table_schema ilike $1
 or tables.table_name ilike $1
 or columns.column_name ilike $1
 group by 1, 2`,
 {
 params: [`%${searchText}%`],
Expand DownExpand Up@@ -186,13 +203,13 @@ export class PostgresDbAdapter implements IDbAdapter {
 { params, includeQueryInError: true }
 ),
 this.execute(
 `
select objsubid as column_number, description from pg_description
 where objoid = (
 select oid from pg_class where relname = $2 and relnamespace = (
 select oid from pg_namespace where nspname = $1
 )
 )`,
 `select objsubid as column_number, description
 from pg_description
where objoid = (
select oid from pg_class where relname = $2 and relnamespace = (
select oid from pg_namespace where nspname = $1
)
)`,
 { params, includeQueryInError: true }
 )
 ]);
Expand DownExpand Up@@ -220,38 +237,42 @@ export class PostgresDbAdapter implements IDbAdapter {
 });
 }

 public async preview(target: sqlanvil.ITarget, limitRows: number = 10): Promise<any[]> {
 const { rows } = await this.execute(
 `SELECT * FROM "${target.schema}"."${target.name}" LIMIT ${limitRows}`
 public async deleteTable(target: sqlanvil.ITarget): Promise<void> {
 const metadata = await this.table(target);
 if (!metadata) {
 return;
 }
 const kind = metadata.type === sqlanvil.TableMetadata.Type.VIEW ? "view" : "table";
 await this.execute(
 `drop ${kind} if exists "${target.schema}"."${target.name}" cascade`,
 { includeQueryInError: true }
 );
 return rows;
 }

 public async schemas(): Promise<string[]> {
 const schemas = await this.execute(`select nspname from pg_namespace`, {
 public async schemas(_database: string): Promise<string[]> {
 const result = await this.execute(`select nspname from pg_namespace`, {
 includeQueryInError: true
 });
 return schemas.rows.map(row => row.nspname);
 }

 public async createSchema(_: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, { includeQueryInError: true });
 return result.rows
 .map(row => row.nspname as string)
 .filter(name => !INTERNAL_SCHEMAS.has(name) && !name.startsWith("pg_"));
 }

 public async close() {
 await this.queryExecutor.close();
 if (this.options.sshTunnel) {
 await this.options.sshTunnel.close();
 }
 public async createSchema(_database: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, {
 includeQueryInError: true
 });
 }

 public async setMetadata(action: sqlanvil.IExecutionAction): Promise<void> {
 const { target, actionDescriptor, tableType } = action;

 const actualMetadata = await this.table(target);
 if (!actualMetadata) {
 return;
 }

 const queries: Array<Promise<any>> = [];
 if (actionDescriptor.description) {
 const queries: Array<Promise<unknown>> = [];
 if (actionDescriptor?.description) {
 queries.push(
 this.execute(
 `comment on ${tableType === "view" ? "view" : "table"} "${target.schema}"."${
Expand All@@ -260,7 +281,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 )
 );
 }
 if (actionDescriptor.columns?.length > 0) {
 if (actionDescriptor?.columns?.length > 0) {
 actionDescriptor.columns
 .filter(
 column =>
Expand All@@ -277,7 +298,10 @@ export class PostgresDbAdapter implements IDbAdapter {
 );
 });
 }

 await Promise.all(queries);
 }

 public async close(): Promise<void> {
 await this.queryExecutor.close();
 }
}

11 changes: 4 additions & 7 deletions
cli/api/utils/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,19 +4,16 @@ load("//tools:ts_library.bzl", "ts_library")

ts_library(
 name = "utils",
 srcs = glob(
 ["**/*.ts"],
 # Postgres helper — relocated from api/utils/ in Phase 2.
 # Excluded until Phase 3 wires it through cli/api's BUILD with
 # the right pg/pg-query-stream deps and an updated import surface.
 exclude = ["postgres.ts"],
 ),
 srcs = glob(["**/*.ts"]),
 deps = [
 "//common/protos",
 "//common/strings",
 "//core",
 "//protos:ts",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//object-sizeof",
 "@npm//pg",
 "@npm//pg-query-stream",
 ],
)
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a) by ihistand · Pull Request #7 · SQLAnvil/sqlanvil · GitHub
Skip to content
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)#7

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

ihistand
wants to merge
1
commit into

from

 Closed


feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)
#7
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


7 changes: 2 additions & 5 deletions
cli/api/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,6 @@ ts_library(
 exclude = [
 "utils/**/*.*",
 "**/*_test.ts",
 # Postgres adapter — relocated from api/ in Phase 2.
 # Excluded until Phase 3 (interface alignment + proto IJDBC →
 # PostgresConnection rewrite) makes it compile against the
 # current IDbAdapter contract.
 "dbadapters/postgres.ts",
 ],
 ),
 deps = [
Expand All@@ -38,6 +33,7 @@ ts_library(
 "@npm//@types/js-yaml",
 "@npm//@types/long",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//@types/semver",
 "@npm//@types/tmp",
 "@npm//deepmerge",
Expand All@@ -46,6 +42,7 @@ ts_library(
 "@npm//google-sql-syntax-ts",
 "@npm//js-beautify",
 "@npm//js-yaml",
 "@npm//pg",
 "@npm//promise-pool-executor",
 "@npm//protobufjs",
 "@npm//semver",
Expand Down

224 changes: 124 additions & 100 deletions
cli/api/dbadapters/postgres.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,105 +1,110 @@
import * as pg from "pg";

import { Credentials } from "sa/cli/api/commands/credentials";
import { IDbAdapter, IDbClient } from "sa/cli/api/dbadapters/index";
import { collectEvaluationQueries, QueryOrAction } from "sa/cli/api/dbadapters/execution_sql";
import {
 IDbAdapter,
 IDbClient,
 IExecutionResult,
 IExecutionResultRaw,
 OnCancel
} from "sa/cli/api/dbadapters/index";
import { parsePostgresEvalError } from "sa/cli/api/utils/error_parsing";
import { convertFieldType, PgPoolExecutor } from "sa/cli/api/utils/postgres";
import { ErrorWithCause } from "sa/common/errors/errors";
import { sqlanvil } from "sa/protos/ts";

interface IPostgresAdapterOptions {
 sshTunnel?: SSHTunnelProxy;
}
const INTERNAL_SCHEMAS = new Set(["information_schema", "pg_catalog", "pg_internal", "pg_toast"]);

export class PostgresDbAdapter implements IDbAdapter {
 public static async create(
 credentials: Credentials,
 credentials: sqlanvil.IPostgresConnection,
 options?: { concurrencyLimit?: number; disableSslForTestsOnly?: boolean }
 ) {
 const jdbcCredentials = credentials as sqlanvil.IJDBC;
 const baseClientConfig: Partial<pg.ClientConfig> = {
 user: jdbcCredentials.username,
 password: jdbcCredentials.password,
 database: jdbcCredentials.databaseName,
 ssl: options?.disableSslForTestsOnly
 ? false
 : {
 rejectUnauthorized: false,
 ca: jdbcCredentials.ssl?.serverCertificate,
 cert: jdbcCredentials.ssl?.clientCertificate,
 key: jdbcCredentials.ssl?.clientPrivateKey
 ): Promise<PostgresDbAdapter> {
 const sslMode = (credentials.sslMode || "").toLowerCase();
 const sslEnabled = !options?.disableSslForTestsOnly && sslMode !== "disable";
 const clientConfig: pg.ClientConfig = {
 host: credentials.host,
 port: credentials.port,
 database: credentials.database,
 user: credentials.user,
 password: credentials.password,
 ssl: sslEnabled
 ? {
 // Supabase and most managed Postgres providers serve certs signed
 // by their own CA. Skipping verification is the documented path
 // for `sslmode=require`. Stricter `verify-ca` / `verify-full`
 // requires a CA bundle that we don't ship today.
 rejectUnauthorized: sslMode === "verify-ca" || sslMode === "verify-full"
 }
 : false
 };
 if (jdbcCredentials.sshTunnel) {
 const sshTunnel = await SSHTunnelProxy.create(jdbcCredentials.sshTunnel, {
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 });
 const queryExecutor = new PgPoolExecutor(
 {
 ...baseClientConfig,
 host: "127.0.0.1",
 port: sshTunnel.localPort
 },
 options
 );
 return new PostgresDbAdapter(queryExecutor, { sshTunnel });
 } else {
 const clientConfig: pg.ClientConfig = {
 ...baseClientConfig,
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 };
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor, {});
 }
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor);
 }

 private constructor(
 private readonly queryExecutor: PgPoolExecutor,
 private readonly options: IPostgresAdapterOptions
 ) {}
 private constructor(private readonly queryExecutor: PgPoolExecutor) {}

 public async execute(
 statement: string,
 options: {
 params?: any[];
 onCancel?: (handleCancel: () => void) => void;
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) {
 return await this.withClientLock(executor => executor.execute(statement, options));
 ): Promise<IExecutionResult> {
 return await this.withClientLock(client => client.execute(statement, options));
 }

 public async executeRaw(
 statement: string,
 options: {
 params?: any[];
 rowLimit?: number;
 } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> {
 const result = await this.execute(statement, options);
 return { ...result, schema: [] };
 }

 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>) {
 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>): Promise<T> {
 return await this.queryExecutor.withClientLock(client =>
 callback({
 execute: async (
statement: string,
options: {
stmt: string,
opts: {
 params?: any[];
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) => {
 ): Promise<IExecutionResult> => {
 try {
 const rows = await client.execute(statement, options);
 const rows = await client.execute(stmt, opts);
 return { rows, metadata: {} };
 } catch (e) {
 if (options.includeQueryInError) {
 throw new Error(`Error encountered while running "${statement}": ${e.message}`);
 if (opts.includeQueryInError) {
 throw new Error(`Error encountered while running "${stmt}": ${e.message}`);
 }
 throw new ErrorWithCause(`Error executing postgres query: ${e.message}`, e);
 }
 },
 executeRaw: async (
 stmt: string,
 opts: { params?: { [name: string]: any }; rowLimit?: number } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> => {
 // Convert named param object to positional array — pg uses $1, $2 etc.
 const positional = opts.params ? Object.values(opts.params) : undefined;
 const rows = await client.execute(stmt, { params: positional, rowLimit: opts.rowLimit });
 return { rows, schema: [], metadata: {} };
 }
 })
 );
 }

 public async evaluate(queryOrAction: QueryOrAction) {
 public async evaluate(queryOrAction: QueryOrAction): Promise<sqlanvil.IQueryEvaluation[]> {
 const validationQueries = collectEvaluationQueries(queryOrAction, false, (query: string) =>
 !!query ? `explain ${query}` : ""
 ).map((validationQuery, index) => ({ index, validationQuery }));
Expand All@@ -115,7 +120,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 } catch (e) {
 evaluationResponse = {
 status: sqlanvil.QueryEvaluation.QueryEvaluationStatus.FAILURE,
 error: parseRedshiftEvalError(validationQuery.query, e)
 error: parsePostgresEvalError(validationQuery.query, e)
 };
 }
 queryEvaluations.push(
Expand All@@ -129,33 +134,45 @@ export class PostgresDbAdapter implements IDbAdapter {
 return queryEvaluations;
 }

 public async tables(): Promise<sqlanvil.ITarget[]> {
 public async tables(
 _database: string,
 schema?: string
 ): Promise<sqlanvil.ITableMetadata[]> {
 const params: any[] = [];
 let schemaClause = "";
 if (schema) {
 schemaClause = "and table_schema = $1";
 params.push(schema);
 }
 const queryResult = await this.execute(
 `select table_name, table_schema
 from information_schema.tables
 where table_schema != 'information_schema'
 and table_schema != 'pg_catalog'
 and table_schema != 'pg_internal'`,
 { rowLimit: 10000, includeQueryInError: true }
 from information_schema.tables
 where table_schema not in ('information_schema', 'pg_catalog', 'pg_internal', 'pg_toast')
 ${schemaClause}`,
 { params, rowLimit: 10000, includeQueryInError: true }
 );
 const { rows } = queryResult;
 return rows.map(row => ({
 schema: row.table_schema,
 name: row.table_name
 const targets = queryResult.rows.map(row => ({
 schema: row.table_schema as string,
 name: row.table_name as string
 }));
 // Hydrate full metadata for each target — IDbAdapter.tables returns
 // ITableMetadata[], not ITarget[].
 return await Promise.all(targets.map(target => this.table(target)));
 }

 public async search(
 searchText: string,
 options: { limit: number } = { limit: 1000 }
 ): Promise<sqlanvil.ITableMetadata[]> {
 // TODO: It would be nice to extend this to search through table/column descriptions. However, this involves
 // a somewhat crazy 5-way join.
 const results = await this.execute(
 `select tables.table_schema as table_schema, tables.table_name as table_name
 from information_schema.tables as tables
 left join information_schema.columns columns on tables.table_schema = columns.table_schema and tables.table_name = columns.table_name
 where tables.table_schema ilike $1 or tables.table_name ilike $1 or columns.column_name ilike $1
 left join information_schema.columns columns
 on tables.table_schema = columns.table_schema
 and tables.table_name = columns.table_name
 where tables.table_schema ilike $1
 or tables.table_name ilike $1
 or columns.column_name ilike $1
 group by 1, 2`,
 {
 params: [`%${searchText}%`],
Expand DownExpand Up@@ -186,13 +203,13 @@ export class PostgresDbAdapter implements IDbAdapter {
 { params, includeQueryInError: true }
 ),
 this.execute(
 `
select objsubid as column_number, description from pg_description
 where objoid = (
 select oid from pg_class where relname = $2 and relnamespace = (
 select oid from pg_namespace where nspname = $1
 )
 )`,
 `select objsubid as column_number, description
 from pg_description
where objoid = (
select oid from pg_class where relname = $2 and relnamespace = (
select oid from pg_namespace where nspname = $1
)
)`,
 { params, includeQueryInError: true }
 )
 ]);
Expand DownExpand Up@@ -220,38 +237,42 @@ export class PostgresDbAdapter implements IDbAdapter {
 });
 }

 public async preview(target: sqlanvil.ITarget, limitRows: number = 10): Promise<any[]> {
 const { rows } = await this.execute(
 `SELECT * FROM "${target.schema}"."${target.name}" LIMIT ${limitRows}`
 public async deleteTable(target: sqlanvil.ITarget): Promise<void> {
 const metadata = await this.table(target);
 if (!metadata) {
 return;
 }
 const kind = metadata.type === sqlanvil.TableMetadata.Type.VIEW ? "view" : "table";
 await this.execute(
 `drop ${kind} if exists "${target.schema}"."${target.name}" cascade`,
 { includeQueryInError: true }
 );
 return rows;
 }

 public async schemas(): Promise<string[]> {
 const schemas = await this.execute(`select nspname from pg_namespace`, {
 public async schemas(_database: string): Promise<string[]> {
 const result = await this.execute(`select nspname from pg_namespace`, {
 includeQueryInError: true
 });
 return schemas.rows.map(row => row.nspname);
 }

 public async createSchema(_: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, { includeQueryInError: true });
 return result.rows
 .map(row => row.nspname as string)
 .filter(name => !INTERNAL_SCHEMAS.has(name) && !name.startsWith("pg_"));
 }

 public async close() {
 await this.queryExecutor.close();
 if (this.options.sshTunnel) {
 await this.options.sshTunnel.close();
 }
 public async createSchema(_database: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, {
 includeQueryInError: true
 });
 }

 public async setMetadata(action: sqlanvil.IExecutionAction): Promise<void> {
 const { target, actionDescriptor, tableType } = action;

 const actualMetadata = await this.table(target);
 if (!actualMetadata) {
 return;
 }

 const queries: Array<Promise<any>> = [];
 if (actionDescriptor.description) {
 const queries: Array<Promise<unknown>> = [];
 if (actionDescriptor?.description) {
 queries.push(
 this.execute(
 `comment on ${tableType === "view" ? "view" : "table"} "${target.schema}"."${
Expand All@@ -260,7 +281,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 )
 );
 }
 if (actionDescriptor.columns?.length > 0) {
 if (actionDescriptor?.columns?.length > 0) {
 actionDescriptor.columns
 .filter(
 column =>
Expand All@@ -277,7 +298,10 @@ export class PostgresDbAdapter implements IDbAdapter {
 );
 });
 }

 await Promise.all(queries);
 }

 public async close(): Promise<void> {
 await this.queryExecutor.close();
 }
}

11 changes: 4 additions & 7 deletions
cli/api/utils/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,19 +4,16 @@ load("//tools:ts_library.bzl", "ts_library")

ts_library(
 name = "utils",
 srcs = glob(
 ["**/*.ts"],
 # Postgres helper — relocated from api/utils/ in Phase 2.
 # Excluded until Phase 3 wires it through cli/api's BUILD with
 # the right pg/pg-query-stream deps and an updated import surface.
 exclude = ["postgres.ts"],
 ),
 srcs = glob(["**/*.ts"]),
 deps = [
 "//common/protos",
 "//common/strings",
 "//core",
 "//protos:ts",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//object-sizeof",
 "@npm//pg",
 "@npm//pg-query-stream",
 ],
)
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a) by ihistand · Pull Request #7 · SQLAnvil/sqlanvil · GitHub
Skip to content
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)#7

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

ihistand
wants to merge
1
commit into

from

 Closed


feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)
#7
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


7 changes: 2 additions & 5 deletions
cli/api/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,6 @@ ts_library(
 exclude = [
 "utils/**/*.*",
 "**/*_test.ts",
 # Postgres adapter — relocated from api/ in Phase 2.
 # Excluded until Phase 3 (interface alignment + proto IJDBC →
 # PostgresConnection rewrite) makes it compile against the
 # current IDbAdapter contract.
 "dbadapters/postgres.ts",
 ],
 ),
 deps = [
Expand All@@ -38,6 +33,7 @@ ts_library(
 "@npm//@types/js-yaml",
 "@npm//@types/long",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//@types/semver",
 "@npm//@types/tmp",
 "@npm//deepmerge",
Expand All@@ -46,6 +42,7 @@ ts_library(
 "@npm//google-sql-syntax-ts",
 "@npm//js-beautify",
 "@npm//js-yaml",
 "@npm//pg",
 "@npm//promise-pool-executor",
 "@npm//protobufjs",
 "@npm//semver",
Expand Down

224 changes: 124 additions & 100 deletions
cli/api/dbadapters/postgres.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,105 +1,110 @@
import * as pg from "pg";

import { Credentials } from "sa/cli/api/commands/credentials";
import { IDbAdapter, IDbClient } from "sa/cli/api/dbadapters/index";
import { collectEvaluationQueries, QueryOrAction } from "sa/cli/api/dbadapters/execution_sql";
import {
 IDbAdapter,
 IDbClient,
 IExecutionResult,
 IExecutionResultRaw,
 OnCancel
} from "sa/cli/api/dbadapters/index";
import { parsePostgresEvalError } from "sa/cli/api/utils/error_parsing";
import { convertFieldType, PgPoolExecutor } from "sa/cli/api/utils/postgres";
import { ErrorWithCause } from "sa/common/errors/errors";
import { sqlanvil } from "sa/protos/ts";

interface IPostgresAdapterOptions {
 sshTunnel?: SSHTunnelProxy;
}
const INTERNAL_SCHEMAS = new Set(["information_schema", "pg_catalog", "pg_internal", "pg_toast"]);

export class PostgresDbAdapter implements IDbAdapter {
 public static async create(
 credentials: Credentials,
 credentials: sqlanvil.IPostgresConnection,
 options?: { concurrencyLimit?: number; disableSslForTestsOnly?: boolean }
 ) {
 const jdbcCredentials = credentials as sqlanvil.IJDBC;
 const baseClientConfig: Partial<pg.ClientConfig> = {
 user: jdbcCredentials.username,
 password: jdbcCredentials.password,
 database: jdbcCredentials.databaseName,
 ssl: options?.disableSslForTestsOnly
 ? false
 : {
 rejectUnauthorized: false,
 ca: jdbcCredentials.ssl?.serverCertificate,
 cert: jdbcCredentials.ssl?.clientCertificate,
 key: jdbcCredentials.ssl?.clientPrivateKey
 ): Promise<PostgresDbAdapter> {
 const sslMode = (credentials.sslMode || "").toLowerCase();
 const sslEnabled = !options?.disableSslForTestsOnly && sslMode !== "disable";
 const clientConfig: pg.ClientConfig = {
 host: credentials.host,
 port: credentials.port,
 database: credentials.database,
 user: credentials.user,
 password: credentials.password,
 ssl: sslEnabled
 ? {
 // Supabase and most managed Postgres providers serve certs signed
 // by their own CA. Skipping verification is the documented path
 // for `sslmode=require`. Stricter `verify-ca` / `verify-full`
 // requires a CA bundle that we don't ship today.
 rejectUnauthorized: sslMode === "verify-ca" || sslMode === "verify-full"
 }
 : false
 };
 if (jdbcCredentials.sshTunnel) {
 const sshTunnel = await SSHTunnelProxy.create(jdbcCredentials.sshTunnel, {
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 });
 const queryExecutor = new PgPoolExecutor(
 {
 ...baseClientConfig,
 host: "127.0.0.1",
 port: sshTunnel.localPort
 },
 options
 );
 return new PostgresDbAdapter(queryExecutor, { sshTunnel });
 } else {
 const clientConfig: pg.ClientConfig = {
 ...baseClientConfig,
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 };
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor, {});
 }
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor);
 }

 private constructor(
 private readonly queryExecutor: PgPoolExecutor,
 private readonly options: IPostgresAdapterOptions
 ) {}
 private constructor(private readonly queryExecutor: PgPoolExecutor) {}

 public async execute(
 statement: string,
 options: {
 params?: any[];
 onCancel?: (handleCancel: () => void) => void;
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) {
 return await this.withClientLock(executor => executor.execute(statement, options));
 ): Promise<IExecutionResult> {
 return await this.withClientLock(client => client.execute(statement, options));
 }

 public async executeRaw(
 statement: string,
 options: {
 params?: any[];
 rowLimit?: number;
 } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> {
 const result = await this.execute(statement, options);
 return { ...result, schema: [] };
 }

 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>) {
 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>): Promise<T> {
 return await this.queryExecutor.withClientLock(client =>
 callback({
 execute: async (
statement: string,
options: {
stmt: string,
opts: {
 params?: any[];
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) => {
 ): Promise<IExecutionResult> => {
 try {
 const rows = await client.execute(statement, options);
 const rows = await client.execute(stmt, opts);
 return { rows, metadata: {} };
 } catch (e) {
 if (options.includeQueryInError) {
 throw new Error(`Error encountered while running "${statement}": ${e.message}`);
 if (opts.includeQueryInError) {
 throw new Error(`Error encountered while running "${stmt}": ${e.message}`);
 }
 throw new ErrorWithCause(`Error executing postgres query: ${e.message}`, e);
 }
 },
 executeRaw: async (
 stmt: string,
 opts: { params?: { [name: string]: any }; rowLimit?: number } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> => {
 // Convert named param object to positional array — pg uses $1, $2 etc.
 const positional = opts.params ? Object.values(opts.params) : undefined;
 const rows = await client.execute(stmt, { params: positional, rowLimit: opts.rowLimit });
 return { rows, schema: [], metadata: {} };
 }
 })
 );
 }

 public async evaluate(queryOrAction: QueryOrAction) {
 public async evaluate(queryOrAction: QueryOrAction): Promise<sqlanvil.IQueryEvaluation[]> {
 const validationQueries = collectEvaluationQueries(queryOrAction, false, (query: string) =>
 !!query ? `explain ${query}` : ""
 ).map((validationQuery, index) => ({ index, validationQuery }));
Expand All@@ -115,7 +120,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 } catch (e) {
 evaluationResponse = {
 status: sqlanvil.QueryEvaluation.QueryEvaluationStatus.FAILURE,
 error: parseRedshiftEvalError(validationQuery.query, e)
 error: parsePostgresEvalError(validationQuery.query, e)
 };
 }
 queryEvaluations.push(
Expand All@@ -129,33 +134,45 @@ export class PostgresDbAdapter implements IDbAdapter {
 return queryEvaluations;
 }

 public async tables(): Promise<sqlanvil.ITarget[]> {
 public async tables(
 _database: string,
 schema?: string
 ): Promise<sqlanvil.ITableMetadata[]> {
 const params: any[] = [];
 let schemaClause = "";
 if (schema) {
 schemaClause = "and table_schema = $1";
 params.push(schema);
 }
 const queryResult = await this.execute(
 `select table_name, table_schema
 from information_schema.tables
 where table_schema != 'information_schema'
 and table_schema != 'pg_catalog'
 and table_schema != 'pg_internal'`,
 { rowLimit: 10000, includeQueryInError: true }
 from information_schema.tables
 where table_schema not in ('information_schema', 'pg_catalog', 'pg_internal', 'pg_toast')
 ${schemaClause}`,
 { params, rowLimit: 10000, includeQueryInError: true }
 );
 const { rows } = queryResult;
 return rows.map(row => ({
 schema: row.table_schema,
 name: row.table_name
 const targets = queryResult.rows.map(row => ({
 schema: row.table_schema as string,
 name: row.table_name as string
 }));
 // Hydrate full metadata for each target — IDbAdapter.tables returns
 // ITableMetadata[], not ITarget[].
 return await Promise.all(targets.map(target => this.table(target)));
 }

 public async search(
 searchText: string,
 options: { limit: number } = { limit: 1000 }
 ): Promise<sqlanvil.ITableMetadata[]> {
 // TODO: It would be nice to extend this to search through table/column descriptions. However, this involves
 // a somewhat crazy 5-way join.
 const results = await this.execute(
 `select tables.table_schema as table_schema, tables.table_name as table_name
 from information_schema.tables as tables
 left join information_schema.columns columns on tables.table_schema = columns.table_schema and tables.table_name = columns.table_name
 where tables.table_schema ilike $1 or tables.table_name ilike $1 or columns.column_name ilike $1
 left join information_schema.columns columns
 on tables.table_schema = columns.table_schema
 and tables.table_name = columns.table_name
 where tables.table_schema ilike $1
 or tables.table_name ilike $1
 or columns.column_name ilike $1
 group by 1, 2`,
 {
 params: [`%${searchText}%`],
Expand DownExpand Up@@ -186,13 +203,13 @@ export class PostgresDbAdapter implements IDbAdapter {
 { params, includeQueryInError: true }
 ),
 this.execute(
 `
select objsubid as column_number, description from pg_description
 where objoid = (
 select oid from pg_class where relname = $2 and relnamespace = (
 select oid from pg_namespace where nspname = $1
 )
 )`,
 `select objsubid as column_number, description
 from pg_description
where objoid = (
select oid from pg_class where relname = $2 and relnamespace = (
select oid from pg_namespace where nspname = $1
)
)`,
 { params, includeQueryInError: true }
 )
 ]);
Expand DownExpand Up@@ -220,38 +237,42 @@ export class PostgresDbAdapter implements IDbAdapter {
 });
 }

 public async preview(target: sqlanvil.ITarget, limitRows: number = 10): Promise<any[]> {
 const { rows } = await this.execute(
 `SELECT * FROM "${target.schema}"."${target.name}" LIMIT ${limitRows}`
 public async deleteTable(target: sqlanvil.ITarget): Promise<void> {
 const metadata = await this.table(target);
 if (!metadata) {
 return;
 }
 const kind = metadata.type === sqlanvil.TableMetadata.Type.VIEW ? "view" : "table";
 await this.execute(
 `drop ${kind} if exists "${target.schema}"."${target.name}" cascade`,
 { includeQueryInError: true }
 );
 return rows;
 }

 public async schemas(): Promise<string[]> {
 const schemas = await this.execute(`select nspname from pg_namespace`, {
 public async schemas(_database: string): Promise<string[]> {
 const result = await this.execute(`select nspname from pg_namespace`, {
 includeQueryInError: true
 });
 return schemas.rows.map(row => row.nspname);
 }

 public async createSchema(_: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, { includeQueryInError: true });
 return result.rows
 .map(row => row.nspname as string)
 .filter(name => !INTERNAL_SCHEMAS.has(name) && !name.startsWith("pg_"));
 }

 public async close() {
 await this.queryExecutor.close();
 if (this.options.sshTunnel) {
 await this.options.sshTunnel.close();
 }
 public async createSchema(_database: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, {
 includeQueryInError: true
 });
 }

 public async setMetadata(action: sqlanvil.IExecutionAction): Promise<void> {
 const { target, actionDescriptor, tableType } = action;

 const actualMetadata = await this.table(target);
 if (!actualMetadata) {
 return;
 }

 const queries: Array<Promise<any>> = [];
 if (actionDescriptor.description) {
 const queries: Array<Promise<unknown>> = [];
 if (actionDescriptor?.description) {
 queries.push(
 this.execute(
 `comment on ${tableType === "view" ? "view" : "table"} "${target.schema}"."${
Expand All@@ -260,7 +281,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 )
 );
 }
 if (actionDescriptor.columns?.length > 0) {
 if (actionDescriptor?.columns?.length > 0) {
 actionDescriptor.columns
 .filter(
 column =>
Expand All@@ -277,7 +298,10 @@ export class PostgresDbAdapter implements IDbAdapter {
 );
 });
 }

 await Promise.all(queries);
 }

 public async close(): Promise<void> {
 await this.queryExecutor.close();
 }
}

11 changes: 4 additions & 7 deletions
cli/api/utils/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,19 +4,16 @@ load("//tools:ts_library.bzl", "ts_library")

ts_library(
 name = "utils",
 srcs = glob(
 ["**/*.ts"],
 # Postgres helper — relocated from api/utils/ in Phase 2.
 # Excluded until Phase 3 wires it through cli/api's BUILD with
 # the right pg/pg-query-stream deps and an updated import surface.
 exclude = ["postgres.ts"],
 ),
 srcs = glob(["**/*.ts"]),
 deps = [
 "//common/protos",
 "//common/strings",
 "//core",
 "//protos:ts",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//object-sizeof",
 "@npm//pg",
 "@npm//pg-query-stream",
 ],
)
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a) by ihistand · Pull Request #7 · SQLAnvil/sqlanvil · GitHub
Skip to content
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)#7

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

ihistand
wants to merge
1
commit into

from

 Closed


feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)
#7
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


7 changes: 2 additions & 5 deletions
cli/api/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,6 @@ ts_library(
 exclude = [
 "utils/**/*.*",
 "**/*_test.ts",
 # Postgres adapter — relocated from api/ in Phase 2.
 # Excluded until Phase 3 (interface alignment + proto IJDBC →
 # PostgresConnection rewrite) makes it compile against the
 # current IDbAdapter contract.
 "dbadapters/postgres.ts",
 ],
 ),
 deps = [
Expand All@@ -38,6 +33,7 @@ ts_library(
 "@npm//@types/js-yaml",
 "@npm//@types/long",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//@types/semver",
 "@npm//@types/tmp",
 "@npm//deepmerge",
Expand All@@ -46,6 +42,7 @@ ts_library(
 "@npm//google-sql-syntax-ts",
 "@npm//js-beautify",
 "@npm//js-yaml",
 "@npm//pg",
 "@npm//promise-pool-executor",
 "@npm//protobufjs",
 "@npm//semver",
Expand Down

224 changes: 124 additions & 100 deletions
cli/api/dbadapters/postgres.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,105 +1,110 @@
import * as pg from "pg";

import { Credentials } from "sa/cli/api/commands/credentials";
import { IDbAdapter, IDbClient } from "sa/cli/api/dbadapters/index";
import { collectEvaluationQueries, QueryOrAction } from "sa/cli/api/dbadapters/execution_sql";
import {
 IDbAdapter,
 IDbClient,
 IExecutionResult,
 IExecutionResultRaw,
 OnCancel
} from "sa/cli/api/dbadapters/index";
import { parsePostgresEvalError } from "sa/cli/api/utils/error_parsing";
import { convertFieldType, PgPoolExecutor } from "sa/cli/api/utils/postgres";
import { ErrorWithCause } from "sa/common/errors/errors";
import { sqlanvil } from "sa/protos/ts";

interface IPostgresAdapterOptions {
 sshTunnel?: SSHTunnelProxy;
}
const INTERNAL_SCHEMAS = new Set(["information_schema", "pg_catalog", "pg_internal", "pg_toast"]);

export class PostgresDbAdapter implements IDbAdapter {
 public static async create(
 credentials: Credentials,
 credentials: sqlanvil.IPostgresConnection,
 options?: { concurrencyLimit?: number; disableSslForTestsOnly?: boolean }
 ) {
 const jdbcCredentials = credentials as sqlanvil.IJDBC;
 const baseClientConfig: Partial<pg.ClientConfig> = {
 user: jdbcCredentials.username,
 password: jdbcCredentials.password,
 database: jdbcCredentials.databaseName,
 ssl: options?.disableSslForTestsOnly
 ? false
 : {
 rejectUnauthorized: false,
 ca: jdbcCredentials.ssl?.serverCertificate,
 cert: jdbcCredentials.ssl?.clientCertificate,
 key: jdbcCredentials.ssl?.clientPrivateKey
 ): Promise<PostgresDbAdapter> {
 const sslMode = (credentials.sslMode || "").toLowerCase();
 const sslEnabled = !options?.disableSslForTestsOnly && sslMode !== "disable";
 const clientConfig: pg.ClientConfig = {
 host: credentials.host,
 port: credentials.port,
 database: credentials.database,
 user: credentials.user,
 password: credentials.password,
 ssl: sslEnabled
 ? {
 // Supabase and most managed Postgres providers serve certs signed
 // by their own CA. Skipping verification is the documented path
 // for `sslmode=require`. Stricter `verify-ca` / `verify-full`
 // requires a CA bundle that we don't ship today.
 rejectUnauthorized: sslMode === "verify-ca" || sslMode === "verify-full"
 }
 : false
 };
 if (jdbcCredentials.sshTunnel) {
 const sshTunnel = await SSHTunnelProxy.create(jdbcCredentials.sshTunnel, {
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 });
 const queryExecutor = new PgPoolExecutor(
 {
 ...baseClientConfig,
 host: "127.0.0.1",
 port: sshTunnel.localPort
 },
 options
 );
 return new PostgresDbAdapter(queryExecutor, { sshTunnel });
 } else {
 const clientConfig: pg.ClientConfig = {
 ...baseClientConfig,
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 };
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor, {});
 }
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor);
 }

 private constructor(
 private readonly queryExecutor: PgPoolExecutor,
 private readonly options: IPostgresAdapterOptions
 ) {}
 private constructor(private readonly queryExecutor: PgPoolExecutor) {}

 public async execute(
 statement: string,
 options: {
 params?: any[];
 onCancel?: (handleCancel: () => void) => void;
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) {
 return await this.withClientLock(executor => executor.execute(statement, options));
 ): Promise<IExecutionResult> {
 return await this.withClientLock(client => client.execute(statement, options));
 }

 public async executeRaw(
 statement: string,
 options: {
 params?: any[];
 rowLimit?: number;
 } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> {
 const result = await this.execute(statement, options);
 return { ...result, schema: [] };
 }

 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>) {
 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>): Promise<T> {
 return await this.queryExecutor.withClientLock(client =>
 callback({
 execute: async (
statement: string,
options: {
stmt: string,
opts: {
 params?: any[];
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) => {
 ): Promise<IExecutionResult> => {
 try {
 const rows = await client.execute(statement, options);
 const rows = await client.execute(stmt, opts);
 return { rows, metadata: {} };
 } catch (e) {
 if (options.includeQueryInError) {
 throw new Error(`Error encountered while running "${statement}": ${e.message}`);
 if (opts.includeQueryInError) {
 throw new Error(`Error encountered while running "${stmt}": ${e.message}`);
 }
 throw new ErrorWithCause(`Error executing postgres query: ${e.message}`, e);
 }
 },
 executeRaw: async (
 stmt: string,
 opts: { params?: { [name: string]: any }; rowLimit?: number } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> => {
 // Convert named param object to positional array — pg uses $1, $2 etc.
 const positional = opts.params ? Object.values(opts.params) : undefined;
 const rows = await client.execute(stmt, { params: positional, rowLimit: opts.rowLimit });
 return { rows, schema: [], metadata: {} };
 }
 })
 );
 }

 public async evaluate(queryOrAction: QueryOrAction) {
 public async evaluate(queryOrAction: QueryOrAction): Promise<sqlanvil.IQueryEvaluation[]> {
 const validationQueries = collectEvaluationQueries(queryOrAction, false, (query: string) =>
 !!query ? `explain ${query}` : ""
 ).map((validationQuery, index) => ({ index, validationQuery }));
Expand All@@ -115,7 +120,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 } catch (e) {
 evaluationResponse = {
 status: sqlanvil.QueryEvaluation.QueryEvaluationStatus.FAILURE,
 error: parseRedshiftEvalError(validationQuery.query, e)
 error: parsePostgresEvalError(validationQuery.query, e)
 };
 }
 queryEvaluations.push(
Expand All@@ -129,33 +134,45 @@ export class PostgresDbAdapter implements IDbAdapter {
 return queryEvaluations;
 }

 public async tables(): Promise<sqlanvil.ITarget[]> {
 public async tables(
 _database: string,
 schema?: string
 ): Promise<sqlanvil.ITableMetadata[]> {
 const params: any[] = [];
 let schemaClause = "";
 if (schema) {
 schemaClause = "and table_schema = $1";
 params.push(schema);
 }
 const queryResult = await this.execute(
 `select table_name, table_schema
 from information_schema.tables
 where table_schema != 'information_schema'
 and table_schema != 'pg_catalog'
 and table_schema != 'pg_internal'`,
 { rowLimit: 10000, includeQueryInError: true }
 from information_schema.tables
 where table_schema not in ('information_schema', 'pg_catalog', 'pg_internal', 'pg_toast')
 ${schemaClause}`,
 { params, rowLimit: 10000, includeQueryInError: true }
 );
 const { rows } = queryResult;
 return rows.map(row => ({
 schema: row.table_schema,
 name: row.table_name
 const targets = queryResult.rows.map(row => ({
 schema: row.table_schema as string,
 name: row.table_name as string
 }));
 // Hydrate full metadata for each target — IDbAdapter.tables returns
 // ITableMetadata[], not ITarget[].
 return await Promise.all(targets.map(target => this.table(target)));
 }

 public async search(
 searchText: string,
 options: { limit: number } = { limit: 1000 }
 ): Promise<sqlanvil.ITableMetadata[]> {
 // TODO: It would be nice to extend this to search through table/column descriptions. However, this involves
 // a somewhat crazy 5-way join.
 const results = await this.execute(
 `select tables.table_schema as table_schema, tables.table_name as table_name
 from information_schema.tables as tables
 left join information_schema.columns columns on tables.table_schema = columns.table_schema and tables.table_name = columns.table_name
 where tables.table_schema ilike $1 or tables.table_name ilike $1 or columns.column_name ilike $1
 left join information_schema.columns columns
 on tables.table_schema = columns.table_schema
 and tables.table_name = columns.table_name
 where tables.table_schema ilike $1
 or tables.table_name ilike $1
 or columns.column_name ilike $1
 group by 1, 2`,
 {
 params: [`%${searchText}%`],
Expand DownExpand Up@@ -186,13 +203,13 @@ export class PostgresDbAdapter implements IDbAdapter {
 { params, includeQueryInError: true }
 ),
 this.execute(
 `
select objsubid as column_number, description from pg_description
 where objoid = (
 select oid from pg_class where relname = $2 and relnamespace = (
 select oid from pg_namespace where nspname = $1
 )
 )`,
 `select objsubid as column_number, description
 from pg_description
where objoid = (
select oid from pg_class where relname = $2 and relnamespace = (
select oid from pg_namespace where nspname = $1
)
)`,
 { params, includeQueryInError: true }
 )
 ]);
Expand DownExpand Up@@ -220,38 +237,42 @@ export class PostgresDbAdapter implements IDbAdapter {
 });
 }

 public async preview(target: sqlanvil.ITarget, limitRows: number = 10): Promise<any[]> {
 const { rows } = await this.execute(
 `SELECT * FROM "${target.schema}"."${target.name}" LIMIT ${limitRows}`
 public async deleteTable(target: sqlanvil.ITarget): Promise<void> {
 const metadata = await this.table(target);
 if (!metadata) {
 return;
 }
 const kind = metadata.type === sqlanvil.TableMetadata.Type.VIEW ? "view" : "table";
 await this.execute(
 `drop ${kind} if exists "${target.schema}"."${target.name}" cascade`,
 { includeQueryInError: true }
 );
 return rows;
 }

 public async schemas(): Promise<string[]> {
 const schemas = await this.execute(`select nspname from pg_namespace`, {
 public async schemas(_database: string): Promise<string[]> {
 const result = await this.execute(`select nspname from pg_namespace`, {
 includeQueryInError: true
 });
 return schemas.rows.map(row => row.nspname);
 }

 public async createSchema(_: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, { includeQueryInError: true });
 return result.rows
 .map(row => row.nspname as string)
 .filter(name => !INTERNAL_SCHEMAS.has(name) && !name.startsWith("pg_"));
 }

 public async close() {
 await this.queryExecutor.close();
 if (this.options.sshTunnel) {
 await this.options.sshTunnel.close();
 }
 public async createSchema(_database: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, {
 includeQueryInError: true
 });
 }

 public async setMetadata(action: sqlanvil.IExecutionAction): Promise<void> {
 const { target, actionDescriptor, tableType } = action;

 const actualMetadata = await this.table(target);
 if (!actualMetadata) {
 return;
 }

 const queries: Array<Promise<any>> = [];
 if (actionDescriptor.description) {
 const queries: Array<Promise<unknown>> = [];
 if (actionDescriptor?.description) {
 queries.push(
 this.execute(
 `comment on ${tableType === "view" ? "view" : "table"} "${target.schema}"."${
Expand All@@ -260,7 +281,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 )
 );
 }
 if (actionDescriptor.columns?.length > 0) {
 if (actionDescriptor?.columns?.length > 0) {
 actionDescriptor.columns
 .filter(
 column =>
Expand All@@ -277,7 +298,10 @@ export class PostgresDbAdapter implements IDbAdapter {
 );
 });
 }

 await Promise.all(queries);
 }

 public async close(): Promise<void> {
 await this.queryExecutor.close();
 }
}

11 changes: 4 additions & 7 deletions
cli/api/utils/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,19 +4,16 @@ load("//tools:ts_library.bzl", "ts_library")

ts_library(
 name = "utils",
 srcs = glob(
 ["**/*.ts"],
 # Postgres helper — relocated from api/utils/ in Phase 2.
 # Excluded until Phase 3 wires it through cli/api's BUILD with
 # the right pg/pg-query-stream deps and an updated import surface.
 exclude = ["postgres.ts"],
 ),
 srcs = glob(["**/*.ts"]),
 deps = [
 "//common/protos",
 "//common/strings",
 "//core",
 "//protos:ts",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//object-sizeof",
 "@npm//pg",
 "@npm//pg-query-stream",
 ],
)
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a) by ihistand · Pull Request #7 · SQLAnvil/sqlanvil · GitHub
Skip to content
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)#7

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

ihistand
wants to merge
1
commit into

from

 Closed


feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)
#7
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


7 changes: 2 additions & 5 deletions
cli/api/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,6 @@ ts_library(
 exclude = [
 "utils/**/*.*",
 "**/*_test.ts",
 # Postgres adapter — relocated from api/ in Phase 2.
 # Excluded until Phase 3 (interface alignment + proto IJDBC →
 # PostgresConnection rewrite) makes it compile against the
 # current IDbAdapter contract.
 "dbadapters/postgres.ts",
 ],
 ),
 deps = [
Expand All@@ -38,6 +33,7 @@ ts_library(
 "@npm//@types/js-yaml",
 "@npm//@types/long",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//@types/semver",
 "@npm//@types/tmp",
 "@npm//deepmerge",
Expand All@@ -46,6 +42,7 @@ ts_library(
 "@npm//google-sql-syntax-ts",
 "@npm//js-beautify",
 "@npm//js-yaml",
 "@npm//pg",
 "@npm//promise-pool-executor",
 "@npm//protobufjs",
 "@npm//semver",
Expand Down

224 changes: 124 additions & 100 deletions
cli/api/dbadapters/postgres.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,105 +1,110 @@
import * as pg from "pg";

import { Credentials } from "sa/cli/api/commands/credentials";
import { IDbAdapter, IDbClient } from "sa/cli/api/dbadapters/index";
import { collectEvaluationQueries, QueryOrAction } from "sa/cli/api/dbadapters/execution_sql";
import {
 IDbAdapter,
 IDbClient,
 IExecutionResult,
 IExecutionResultRaw,
 OnCancel
} from "sa/cli/api/dbadapters/index";
import { parsePostgresEvalError } from "sa/cli/api/utils/error_parsing";
import { convertFieldType, PgPoolExecutor } from "sa/cli/api/utils/postgres";
import { ErrorWithCause } from "sa/common/errors/errors";
import { sqlanvil } from "sa/protos/ts";

interface IPostgresAdapterOptions {
 sshTunnel?: SSHTunnelProxy;
}
const INTERNAL_SCHEMAS = new Set(["information_schema", "pg_catalog", "pg_internal", "pg_toast"]);

export class PostgresDbAdapter implements IDbAdapter {
 public static async create(
 credentials: Credentials,
 credentials: sqlanvil.IPostgresConnection,
 options?: { concurrencyLimit?: number; disableSslForTestsOnly?: boolean }
 ) {
 const jdbcCredentials = credentials as sqlanvil.IJDBC;
 const baseClientConfig: Partial<pg.ClientConfig> = {
 user: jdbcCredentials.username,
 password: jdbcCredentials.password,
 database: jdbcCredentials.databaseName,
 ssl: options?.disableSslForTestsOnly
 ? false
 : {
 rejectUnauthorized: false,
 ca: jdbcCredentials.ssl?.serverCertificate,
 cert: jdbcCredentials.ssl?.clientCertificate,
 key: jdbcCredentials.ssl?.clientPrivateKey
 ): Promise<PostgresDbAdapter> {
 const sslMode = (credentials.sslMode || "").toLowerCase();
 const sslEnabled = !options?.disableSslForTestsOnly && sslMode !== "disable";
 const clientConfig: pg.ClientConfig = {
 host: credentials.host,
 port: credentials.port,
 database: credentials.database,
 user: credentials.user,
 password: credentials.password,
 ssl: sslEnabled
 ? {
 // Supabase and most managed Postgres providers serve certs signed
 // by their own CA. Skipping verification is the documented path
 // for `sslmode=require`. Stricter `verify-ca` / `verify-full`
 // requires a CA bundle that we don't ship today.
 rejectUnauthorized: sslMode === "verify-ca" || sslMode === "verify-full"
 }
 : false
 };
 if (jdbcCredentials.sshTunnel) {
 const sshTunnel = await SSHTunnelProxy.create(jdbcCredentials.sshTunnel, {
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 });
 const queryExecutor = new PgPoolExecutor(
 {
 ...baseClientConfig,
 host: "127.0.0.1",
 port: sshTunnel.localPort
 },
 options
 );
 return new PostgresDbAdapter(queryExecutor, { sshTunnel });
 } else {
 const clientConfig: pg.ClientConfig = {
 ...baseClientConfig,
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 };
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor, {});
 }
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor);
 }

 private constructor(
 private readonly queryExecutor: PgPoolExecutor,
 private readonly options: IPostgresAdapterOptions
 ) {}
 private constructor(private readonly queryExecutor: PgPoolExecutor) {}

 public async execute(
 statement: string,
 options: {
 params?: any[];
 onCancel?: (handleCancel: () => void) => void;
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) {
 return await this.withClientLock(executor => executor.execute(statement, options));
 ): Promise<IExecutionResult> {
 return await this.withClientLock(client => client.execute(statement, options));
 }

 public async executeRaw(
 statement: string,
 options: {
 params?: any[];
 rowLimit?: number;
 } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> {
 const result = await this.execute(statement, options);
 return { ...result, schema: [] };
 }

 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>) {
 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>): Promise<T> {
 return await this.queryExecutor.withClientLock(client =>
 callback({
 execute: async (
statement: string,
options: {
stmt: string,
opts: {
 params?: any[];
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) => {
 ): Promise<IExecutionResult> => {
 try {
 const rows = await client.execute(statement, options);
 const rows = await client.execute(stmt, opts);
 return { rows, metadata: {} };
 } catch (e) {
 if (options.includeQueryInError) {
 throw new Error(`Error encountered while running "${statement}": ${e.message}`);
 if (opts.includeQueryInError) {
 throw new Error(`Error encountered while running "${stmt}": ${e.message}`);
 }
 throw new ErrorWithCause(`Error executing postgres query: ${e.message}`, e);
 }
 },
 executeRaw: async (
 stmt: string,
 opts: { params?: { [name: string]: any }; rowLimit?: number } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> => {
 // Convert named param object to positional array — pg uses $1, $2 etc.
 const positional = opts.params ? Object.values(opts.params) : undefined;
 const rows = await client.execute(stmt, { params: positional, rowLimit: opts.rowLimit });
 return { rows, schema: [], metadata: {} };
 }
 })
 );
 }

 public async evaluate(queryOrAction: QueryOrAction) {
 public async evaluate(queryOrAction: QueryOrAction): Promise<sqlanvil.IQueryEvaluation[]> {
 const validationQueries = collectEvaluationQueries(queryOrAction, false, (query: string) =>
 !!query ? `explain ${query}` : ""
 ).map((validationQuery, index) => ({ index, validationQuery }));
Expand All@@ -115,7 +120,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 } catch (e) {
 evaluationResponse = {
 status: sqlanvil.QueryEvaluation.QueryEvaluationStatus.FAILURE,
 error: parseRedshiftEvalError(validationQuery.query, e)
 error: parsePostgresEvalError(validationQuery.query, e)
 };
 }
 queryEvaluations.push(
Expand All@@ -129,33 +134,45 @@ export class PostgresDbAdapter implements IDbAdapter {
 return queryEvaluations;
 }

 public async tables(): Promise<sqlanvil.ITarget[]> {
 public async tables(
 _database: string,
 schema?: string
 ): Promise<sqlanvil.ITableMetadata[]> {
 const params: any[] = [];
 let schemaClause = "";
 if (schema) {
 schemaClause = "and table_schema = $1";
 params.push(schema);
 }
 const queryResult = await this.execute(
 `select table_name, table_schema
 from information_schema.tables
 where table_schema != 'information_schema'
 and table_schema != 'pg_catalog'
 and table_schema != 'pg_internal'`,
 { rowLimit: 10000, includeQueryInError: true }
 from information_schema.tables
 where table_schema not in ('information_schema', 'pg_catalog', 'pg_internal', 'pg_toast')
 ${schemaClause}`,
 { params, rowLimit: 10000, includeQueryInError: true }
 );
 const { rows } = queryResult;
 return rows.map(row => ({
 schema: row.table_schema,
 name: row.table_name
 const targets = queryResult.rows.map(row => ({
 schema: row.table_schema as string,
 name: row.table_name as string
 }));
 // Hydrate full metadata for each target — IDbAdapter.tables returns
 // ITableMetadata[], not ITarget[].
 return await Promise.all(targets.map(target => this.table(target)));
 }

 public async search(
 searchText: string,
 options: { limit: number } = { limit: 1000 }
 ): Promise<sqlanvil.ITableMetadata[]> {
 // TODO: It would be nice to extend this to search through table/column descriptions. However, this involves
 // a somewhat crazy 5-way join.
 const results = await this.execute(
 `select tables.table_schema as table_schema, tables.table_name as table_name
 from information_schema.tables as tables
 left join information_schema.columns columns on tables.table_schema = columns.table_schema and tables.table_name = columns.table_name
 where tables.table_schema ilike $1 or tables.table_name ilike $1 or columns.column_name ilike $1
 left join information_schema.columns columns
 on tables.table_schema = columns.table_schema
 and tables.table_name = columns.table_name
 where tables.table_schema ilike $1
 or tables.table_name ilike $1
 or columns.column_name ilike $1
 group by 1, 2`,
 {
 params: [`%${searchText}%`],
Expand DownExpand Up@@ -186,13 +203,13 @@ export class PostgresDbAdapter implements IDbAdapter {
 { params, includeQueryInError: true }
 ),
 this.execute(
 `
select objsubid as column_number, description from pg_description
 where objoid = (
 select oid from pg_class where relname = $2 and relnamespace = (
 select oid from pg_namespace where nspname = $1
 )
 )`,
 `select objsubid as column_number, description
 from pg_description
where objoid = (
select oid from pg_class where relname = $2 and relnamespace = (
select oid from pg_namespace where nspname = $1
)
)`,
 { params, includeQueryInError: true }
 )
 ]);
Expand DownExpand Up@@ -220,38 +237,42 @@ export class PostgresDbAdapter implements IDbAdapter {
 });
 }

 public async preview(target: sqlanvil.ITarget, limitRows: number = 10): Promise<any[]> {
 const { rows } = await this.execute(
 `SELECT * FROM "${target.schema}"."${target.name}" LIMIT ${limitRows}`
 public async deleteTable(target: sqlanvil.ITarget): Promise<void> {
 const metadata = await this.table(target);
 if (!metadata) {
 return;
 }
 const kind = metadata.type === sqlanvil.TableMetadata.Type.VIEW ? "view" : "table";
 await this.execute(
 `drop ${kind} if exists "${target.schema}"."${target.name}" cascade`,
 { includeQueryInError: true }
 );
 return rows;
 }

 public async schemas(): Promise<string[]> {
 const schemas = await this.execute(`select nspname from pg_namespace`, {
 public async schemas(_database: string): Promise<string[]> {
 const result = await this.execute(`select nspname from pg_namespace`, {
 includeQueryInError: true
 });
 return schemas.rows.map(row => row.nspname);
 }

 public async createSchema(_: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, { includeQueryInError: true });
 return result.rows
 .map(row => row.nspname as string)
 .filter(name => !INTERNAL_SCHEMAS.has(name) && !name.startsWith("pg_"));
 }

 public async close() {
 await this.queryExecutor.close();
 if (this.options.sshTunnel) {
 await this.options.sshTunnel.close();
 }
 public async createSchema(_database: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, {
 includeQueryInError: true
 });
 }

 public async setMetadata(action: sqlanvil.IExecutionAction): Promise<void> {
 const { target, actionDescriptor, tableType } = action;

 const actualMetadata = await this.table(target);
 if (!actualMetadata) {
 return;
 }

 const queries: Array<Promise<any>> = [];
 if (actionDescriptor.description) {
 const queries: Array<Promise<unknown>> = [];
 if (actionDescriptor?.description) {
 queries.push(
 this.execute(
 `comment on ${tableType === "view" ? "view" : "table"} "${target.schema}"."${
Expand All@@ -260,7 +281,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 )
 );
 }
 if (actionDescriptor.columns?.length > 0) {
 if (actionDescriptor?.columns?.length > 0) {
 actionDescriptor.columns
 .filter(
 column =>
Expand All@@ -277,7 +298,10 @@ export class PostgresDbAdapter implements IDbAdapter {
 );
 });
 }

 await Promise.all(queries);
 }

 public async close(): Promise<void> {
 await this.queryExecutor.close();
 }
}

11 changes: 4 additions & 7 deletions
cli/api/utils/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,19 +4,16 @@ load("//tools:ts_library.bzl", "ts_library")

ts_library(
 name = "utils",
 srcs = glob(
 ["**/*.ts"],
 # Postgres helper — relocated from api/utils/ in Phase 2.
 # Excluded until Phase 3 wires it through cli/api's BUILD with
 # the right pg/pg-query-stream deps and an updated import surface.
 exclude = ["postgres.ts"],
 ),
 srcs = glob(["**/*.ts"]),
 deps = [
 "//common/protos",
 "//common/strings",
 "//core",
 "//protos:ts",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//object-sizeof",
 "@npm//pg",
 "@npm//pg-query-stream",
 ],
)
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a) by ihistand · Pull Request #7 · SQLAnvil/sqlanvil · GitHub
Skip to content
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)#7

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

ihistand
wants to merge
1
commit into

from

 Closed


feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)
#7
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


7 changes: 2 additions & 5 deletions
cli/api/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,6 @@ ts_library(
 exclude = [
 "utils/**/*.*",
 "**/*_test.ts",
 # Postgres adapter — relocated from api/ in Phase 2.
 # Excluded until Phase 3 (interface alignment + proto IJDBC →
 # PostgresConnection rewrite) makes it compile against the
 # current IDbAdapter contract.
 "dbadapters/postgres.ts",
 ],
 ),
 deps = [
Expand All@@ -38,6 +33,7 @@ ts_library(
 "@npm//@types/js-yaml",
 "@npm//@types/long",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//@types/semver",
 "@npm//@types/tmp",
 "@npm//deepmerge",
Expand All@@ -46,6 +42,7 @@ ts_library(
 "@npm//google-sql-syntax-ts",
 "@npm//js-beautify",
 "@npm//js-yaml",
 "@npm//pg",
 "@npm//promise-pool-executor",
 "@npm//protobufjs",
 "@npm//semver",
Expand Down

224 changes: 124 additions & 100 deletions
cli/api/dbadapters/postgres.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,105 +1,110 @@
import * as pg from "pg";

import { Credentials } from "sa/cli/api/commands/credentials";
import { IDbAdapter, IDbClient } from "sa/cli/api/dbadapters/index";
import { collectEvaluationQueries, QueryOrAction } from "sa/cli/api/dbadapters/execution_sql";
import {
 IDbAdapter,
 IDbClient,
 IExecutionResult,
 IExecutionResultRaw,
 OnCancel
} from "sa/cli/api/dbadapters/index";
import { parsePostgresEvalError } from "sa/cli/api/utils/error_parsing";
import { convertFieldType, PgPoolExecutor } from "sa/cli/api/utils/postgres";
import { ErrorWithCause } from "sa/common/errors/errors";
import { sqlanvil } from "sa/protos/ts";

interface IPostgresAdapterOptions {
 sshTunnel?: SSHTunnelProxy;
}
const INTERNAL_SCHEMAS = new Set(["information_schema", "pg_catalog", "pg_internal", "pg_toast"]);

export class PostgresDbAdapter implements IDbAdapter {
 public static async create(
 credentials: Credentials,
 credentials: sqlanvil.IPostgresConnection,
 options?: { concurrencyLimit?: number; disableSslForTestsOnly?: boolean }
 ) {
 const jdbcCredentials = credentials as sqlanvil.IJDBC;
 const baseClientConfig: Partial<pg.ClientConfig> = {
 user: jdbcCredentials.username,
 password: jdbcCredentials.password,
 database: jdbcCredentials.databaseName,
 ssl: options?.disableSslForTestsOnly
 ? false
 : {
 rejectUnauthorized: false,
 ca: jdbcCredentials.ssl?.serverCertificate,
 cert: jdbcCredentials.ssl?.clientCertificate,
 key: jdbcCredentials.ssl?.clientPrivateKey
 ): Promise<PostgresDbAdapter> {
 const sslMode = (credentials.sslMode || "").toLowerCase();
 const sslEnabled = !options?.disableSslForTestsOnly && sslMode !== "disable";
 const clientConfig: pg.ClientConfig = {
 host: credentials.host,
 port: credentials.port,
 database: credentials.database,
 user: credentials.user,
 password: credentials.password,
 ssl: sslEnabled
 ? {
 // Supabase and most managed Postgres providers serve certs signed
 // by their own CA. Skipping verification is the documented path
 // for `sslmode=require`. Stricter `verify-ca` / `verify-full`
 // requires a CA bundle that we don't ship today.
 rejectUnauthorized: sslMode === "verify-ca" || sslMode === "verify-full"
 }
 : false
 };
 if (jdbcCredentials.sshTunnel) {
 const sshTunnel = await SSHTunnelProxy.create(jdbcCredentials.sshTunnel, {
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 });
 const queryExecutor = new PgPoolExecutor(
 {
 ...baseClientConfig,
 host: "127.0.0.1",
 port: sshTunnel.localPort
 },
 options
 );
 return new PostgresDbAdapter(queryExecutor, { sshTunnel });
 } else {
 const clientConfig: pg.ClientConfig = {
 ...baseClientConfig,
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 };
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor, {});
 }
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor);
 }

 private constructor(
 private readonly queryExecutor: PgPoolExecutor,
 private readonly options: IPostgresAdapterOptions
 ) {}
 private constructor(private readonly queryExecutor: PgPoolExecutor) {}

 public async execute(
 statement: string,
 options: {
 params?: any[];
 onCancel?: (handleCancel: () => void) => void;
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) {
 return await this.withClientLock(executor => executor.execute(statement, options));
 ): Promise<IExecutionResult> {
 return await this.withClientLock(client => client.execute(statement, options));
 }

 public async executeRaw(
 statement: string,
 options: {
 params?: any[];
 rowLimit?: number;
 } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> {
 const result = await this.execute(statement, options);
 return { ...result, schema: [] };
 }

 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>) {
 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>): Promise<T> {
 return await this.queryExecutor.withClientLock(client =>
 callback({
 execute: async (
statement: string,
options: {
stmt: string,
opts: {
 params?: any[];
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) => {
 ): Promise<IExecutionResult> => {
 try {
 const rows = await client.execute(statement, options);
 const rows = await client.execute(stmt, opts);
 return { rows, metadata: {} };
 } catch (e) {
 if (options.includeQueryInError) {
 throw new Error(`Error encountered while running "${statement}": ${e.message}`);
 if (opts.includeQueryInError) {
 throw new Error(`Error encountered while running "${stmt}": ${e.message}`);
 }
 throw new ErrorWithCause(`Error executing postgres query: ${e.message}`, e);
 }
 },
 executeRaw: async (
 stmt: string,
 opts: { params?: { [name: string]: any }; rowLimit?: number } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> => {
 // Convert named param object to positional array — pg uses $1, $2 etc.
 const positional = opts.params ? Object.values(opts.params) : undefined;
 const rows = await client.execute(stmt, { params: positional, rowLimit: opts.rowLimit });
 return { rows, schema: [], metadata: {} };
 }
 })
 );
 }

 public async evaluate(queryOrAction: QueryOrAction) {
 public async evaluate(queryOrAction: QueryOrAction): Promise<sqlanvil.IQueryEvaluation[]> {
 const validationQueries = collectEvaluationQueries(queryOrAction, false, (query: string) =>
 !!query ? `explain ${query}` : ""
 ).map((validationQuery, index) => ({ index, validationQuery }));
Expand All@@ -115,7 +120,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 } catch (e) {
 evaluationResponse = {
 status: sqlanvil.QueryEvaluation.QueryEvaluationStatus.FAILURE,
 error: parseRedshiftEvalError(validationQuery.query, e)
 error: parsePostgresEvalError(validationQuery.query, e)
 };
 }
 queryEvaluations.push(
Expand All@@ -129,33 +134,45 @@ export class PostgresDbAdapter implements IDbAdapter {
 return queryEvaluations;
 }

 public async tables(): Promise<sqlanvil.ITarget[]> {
 public async tables(
 _database: string,
 schema?: string
 ): Promise<sqlanvil.ITableMetadata[]> {
 const params: any[] = [];
 let schemaClause = "";
 if (schema) {
 schemaClause = "and table_schema = $1";
 params.push(schema);
 }
 const queryResult = await this.execute(
 `select table_name, table_schema
 from information_schema.tables
 where table_schema != 'information_schema'
 and table_schema != 'pg_catalog'
 and table_schema != 'pg_internal'`,
 { rowLimit: 10000, includeQueryInError: true }
 from information_schema.tables
 where table_schema not in ('information_schema', 'pg_catalog', 'pg_internal', 'pg_toast')
 ${schemaClause}`,
 { params, rowLimit: 10000, includeQueryInError: true }
 );
 const { rows } = queryResult;
 return rows.map(row => ({
 schema: row.table_schema,
 name: row.table_name
 const targets = queryResult.rows.map(row => ({
 schema: row.table_schema as string,
 name: row.table_name as string
 }));
 // Hydrate full metadata for each target — IDbAdapter.tables returns
 // ITableMetadata[], not ITarget[].
 return await Promise.all(targets.map(target => this.table(target)));
 }

 public async search(
 searchText: string,
 options: { limit: number } = { limit: 1000 }
 ): Promise<sqlanvil.ITableMetadata[]> {
 // TODO: It would be nice to extend this to search through table/column descriptions. However, this involves
 // a somewhat crazy 5-way join.
 const results = await this.execute(
 `select tables.table_schema as table_schema, tables.table_name as table_name
 from information_schema.tables as tables
 left join information_schema.columns columns on tables.table_schema = columns.table_schema and tables.table_name = columns.table_name
 where tables.table_schema ilike $1 or tables.table_name ilike $1 or columns.column_name ilike $1
 left join information_schema.columns columns
 on tables.table_schema = columns.table_schema
 and tables.table_name = columns.table_name
 where tables.table_schema ilike $1
 or tables.table_name ilike $1
 or columns.column_name ilike $1
 group by 1, 2`,
 {
 params: [`%${searchText}%`],
Expand DownExpand Up@@ -186,13 +203,13 @@ export class PostgresDbAdapter implements IDbAdapter {
 { params, includeQueryInError: true }
 ),
 this.execute(
 `
select objsubid as column_number, description from pg_description
 where objoid = (
 select oid from pg_class where relname = $2 and relnamespace = (
 select oid from pg_namespace where nspname = $1
 )
 )`,
 `select objsubid as column_number, description
 from pg_description
where objoid = (
select oid from pg_class where relname = $2 and relnamespace = (
select oid from pg_namespace where nspname = $1
)
)`,
 { params, includeQueryInError: true }
 )
 ]);
Expand DownExpand Up@@ -220,38 +237,42 @@ export class PostgresDbAdapter implements IDbAdapter {
 });
 }

 public async preview(target: sqlanvil.ITarget, limitRows: number = 10): Promise<any[]> {
 const { rows } = await this.execute(
 `SELECT * FROM "${target.schema}"."${target.name}" LIMIT ${limitRows}`
 public async deleteTable(target: sqlanvil.ITarget): Promise<void> {
 const metadata = await this.table(target);
 if (!metadata) {
 return;
 }
 const kind = metadata.type === sqlanvil.TableMetadata.Type.VIEW ? "view" : "table";
 await this.execute(
 `drop ${kind} if exists "${target.schema}"."${target.name}" cascade`,
 { includeQueryInError: true }
 );
 return rows;
 }

 public async schemas(): Promise<string[]> {
 const schemas = await this.execute(`select nspname from pg_namespace`, {
 public async schemas(_database: string): Promise<string[]> {
 const result = await this.execute(`select nspname from pg_namespace`, {
 includeQueryInError: true
 });
 return schemas.rows.map(row => row.nspname);
 }

 public async createSchema(_: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, { includeQueryInError: true });
 return result.rows
 .map(row => row.nspname as string)
 .filter(name => !INTERNAL_SCHEMAS.has(name) && !name.startsWith("pg_"));
 }

 public async close() {
 await this.queryExecutor.close();
 if (this.options.sshTunnel) {
 await this.options.sshTunnel.close();
 }
 public async createSchema(_database: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, {
 includeQueryInError: true
 });
 }

 public async setMetadata(action: sqlanvil.IExecutionAction): Promise<void> {
 const { target, actionDescriptor, tableType } = action;

 const actualMetadata = await this.table(target);
 if (!actualMetadata) {
 return;
 }

 const queries: Array<Promise<any>> = [];
 if (actionDescriptor.description) {
 const queries: Array<Promise<unknown>> = [];
 if (actionDescriptor?.description) {
 queries.push(
 this.execute(
 `comment on ${tableType === "view" ? "view" : "table"} "${target.schema}"."${
Expand All@@ -260,7 +281,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 )
 );
 }
 if (actionDescriptor.columns?.length > 0) {
 if (actionDescriptor?.columns?.length > 0) {
 actionDescriptor.columns
 .filter(
 column =>
Expand All@@ -277,7 +298,10 @@ export class PostgresDbAdapter implements IDbAdapter {
 );
 });
 }

 await Promise.all(queries);
 }

 public async close(): Promise<void> {
 await this.queryExecutor.close();
 }
}

11 changes: 4 additions & 7 deletions
cli/api/utils/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,19 +4,16 @@ load("//tools:ts_library.bzl", "ts_library")

ts_library(
 name = "utils",
 srcs = glob(
 ["**/*.ts"],
 # Postgres helper — relocated from api/utils/ in Phase 2.
 # Excluded until Phase 3 wires it through cli/api's BUILD with
 # the right pg/pg-query-stream deps and an updated import surface.
 exclude = ["postgres.ts"],
 ),
 srcs = glob(["**/*.ts"]),
 deps = [
 "//common/protos",
 "//common/strings",
 "//core",
 "//protos:ts",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//object-sizeof",
 "@npm//pg",
 "@npm//pg-query-stream",
 ],
)
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a) by ihistand · Pull Request #7 · SQLAnvil/sqlanvil · GitHub
Skip to content
feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)#7

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

ihistand
wants to merge
1
commit into

from

 Closed


feat(postgres-adapter): implement IDbAdapter contract (Phase 3a)
#7
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


7 changes: 2 additions & 5 deletions
cli/api/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,6 @@ ts_library(
 exclude = [
 "utils/**/*.*",
 "**/*_test.ts",
 # Postgres adapter — relocated from api/ in Phase 2.
 # Excluded until Phase 3 (interface alignment + proto IJDBC →
 # PostgresConnection rewrite) makes it compile against the
 # current IDbAdapter contract.
 "dbadapters/postgres.ts",
 ],
 ),
 deps = [
Expand All@@ -38,6 +33,7 @@ ts_library(
 "@npm//@types/js-yaml",
 "@npm//@types/long",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//@types/semver",
 "@npm//@types/tmp",
 "@npm//deepmerge",
Expand All@@ -46,6 +42,7 @@ ts_library(
 "@npm//google-sql-syntax-ts",
 "@npm//js-beautify",
 "@npm//js-yaml",
 "@npm//pg",
 "@npm//promise-pool-executor",
 "@npm//protobufjs",
 "@npm//semver",
Expand Down

224 changes: 124 additions & 100 deletions
cli/api/dbadapters/postgres.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,105 +1,110 @@
import * as pg from "pg";

import { Credentials } from "sa/cli/api/commands/credentials";
import { IDbAdapter, IDbClient } from "sa/cli/api/dbadapters/index";
import { collectEvaluationQueries, QueryOrAction } from "sa/cli/api/dbadapters/execution_sql";
import {
 IDbAdapter,
 IDbClient,
 IExecutionResult,
 IExecutionResultRaw,
 OnCancel
} from "sa/cli/api/dbadapters/index";
import { parsePostgresEvalError } from "sa/cli/api/utils/error_parsing";
import { convertFieldType, PgPoolExecutor } from "sa/cli/api/utils/postgres";
import { ErrorWithCause } from "sa/common/errors/errors";
import { sqlanvil } from "sa/protos/ts";

interface IPostgresAdapterOptions {
 sshTunnel?: SSHTunnelProxy;
}
const INTERNAL_SCHEMAS = new Set(["information_schema", "pg_catalog", "pg_internal", "pg_toast"]);

export class PostgresDbAdapter implements IDbAdapter {
 public static async create(
 credentials: Credentials,
 credentials: sqlanvil.IPostgresConnection,
 options?: { concurrencyLimit?: number; disableSslForTestsOnly?: boolean }
 ) {
 const jdbcCredentials = credentials as sqlanvil.IJDBC;
 const baseClientConfig: Partial<pg.ClientConfig> = {
 user: jdbcCredentials.username,
 password: jdbcCredentials.password,
 database: jdbcCredentials.databaseName,
 ssl: options?.disableSslForTestsOnly
 ? false
 : {
 rejectUnauthorized: false,
 ca: jdbcCredentials.ssl?.serverCertificate,
 cert: jdbcCredentials.ssl?.clientCertificate,
 key: jdbcCredentials.ssl?.clientPrivateKey
 ): Promise<PostgresDbAdapter> {
 const sslMode = (credentials.sslMode || "").toLowerCase();
 const sslEnabled = !options?.disableSslForTestsOnly && sslMode !== "disable";
 const clientConfig: pg.ClientConfig = {
 host: credentials.host,
 port: credentials.port,
 database: credentials.database,
 user: credentials.user,
 password: credentials.password,
 ssl: sslEnabled
 ? {
 // Supabase and most managed Postgres providers serve certs signed
 // by their own CA. Skipping verification is the documented path
 // for `sslmode=require`. Stricter `verify-ca` / `verify-full`
 // requires a CA bundle that we don't ship today.
 rejectUnauthorized: sslMode === "verify-ca" || sslMode === "verify-full"
 }
 : false
 };
 if (jdbcCredentials.sshTunnel) {
 const sshTunnel = await SSHTunnelProxy.create(jdbcCredentials.sshTunnel, {
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 });
 const queryExecutor = new PgPoolExecutor(
 {
 ...baseClientConfig,
 host: "127.0.0.1",
 port: sshTunnel.localPort
 },
 options
 );
 return new PostgresDbAdapter(queryExecutor, { sshTunnel });
 } else {
 const clientConfig: pg.ClientConfig = {
 ...baseClientConfig,
 host: jdbcCredentials.host,
 port: jdbcCredentials.port
 };
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor, {});
 }
 const queryExecutor = new PgPoolExecutor(clientConfig, options);
 return new PostgresDbAdapter(queryExecutor);
 }

 private constructor(
 private readonly queryExecutor: PgPoolExecutor,
 private readonly options: IPostgresAdapterOptions
 ) {}
 private constructor(private readonly queryExecutor: PgPoolExecutor) {}

 public async execute(
 statement: string,
 options: {
 params?: any[];
 onCancel?: (handleCancel: () => void) => void;
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) {
 return await this.withClientLock(executor => executor.execute(statement, options));
 ): Promise<IExecutionResult> {
 return await this.withClientLock(client => client.execute(statement, options));
 }

 public async executeRaw(
 statement: string,
 options: {
 params?: any[];
 rowLimit?: number;
 } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> {
 const result = await this.execute(statement, options);
 return { ...result, schema: [] };
 }

 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>) {
 public async withClientLock<T>(callback: (client: IDbClient) => Promise<T>): Promise<T> {
 return await this.queryExecutor.withClientLock(client =>
 callback({
 execute: async (
statement: string,
options: {
stmt: string,
opts: {
 params?: any[];
 onCancel?: OnCancel;
 rowLimit?: number;
 byteLimit?: number;
 includeQueryInError?: boolean;
 } = { rowLimit: 1000, byteLimit: 1024 * 1024 }
 ) => {
 ): Promise<IExecutionResult> => {
 try {
 const rows = await client.execute(statement, options);
 const rows = await client.execute(stmt, opts);
 return { rows, metadata: {} };
 } catch (e) {
 if (options.includeQueryInError) {
 throw new Error(`Error encountered while running "${statement}": ${e.message}`);
 if (opts.includeQueryInError) {
 throw new Error(`Error encountered while running "${stmt}": ${e.message}`);
 }
 throw new ErrorWithCause(`Error executing postgres query: ${e.message}`, e);
 }
 },
 executeRaw: async (
 stmt: string,
 opts: { params?: { [name: string]: any }; rowLimit?: number } = { rowLimit: 1000 }
 ): Promise<IExecutionResultRaw> => {
 // Convert named param object to positional array — pg uses $1, $2 etc.
 const positional = opts.params ? Object.values(opts.params) : undefined;
 const rows = await client.execute(stmt, { params: positional, rowLimit: opts.rowLimit });
 return { rows, schema: [], metadata: {} };
 }
 })
 );
 }

 public async evaluate(queryOrAction: QueryOrAction) {
 public async evaluate(queryOrAction: QueryOrAction): Promise<sqlanvil.IQueryEvaluation[]> {
 const validationQueries = collectEvaluationQueries(queryOrAction, false, (query: string) =>
 !!query ? `explain ${query}` : ""
 ).map((validationQuery, index) => ({ index, validationQuery }));
Expand All@@ -115,7 +120,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 } catch (e) {
 evaluationResponse = {
 status: sqlanvil.QueryEvaluation.QueryEvaluationStatus.FAILURE,
 error: parseRedshiftEvalError(validationQuery.query, e)
 error: parsePostgresEvalError(validationQuery.query, e)
 };
 }
 queryEvaluations.push(
Expand All@@ -129,33 +134,45 @@ export class PostgresDbAdapter implements IDbAdapter {
 return queryEvaluations;
 }

 public async tables(): Promise<sqlanvil.ITarget[]> {
 public async tables(
 _database: string,
 schema?: string
 ): Promise<sqlanvil.ITableMetadata[]> {
 const params: any[] = [];
 let schemaClause = "";
 if (schema) {
 schemaClause = "and table_schema = $1";
 params.push(schema);
 }
 const queryResult = await this.execute(
 `select table_name, table_schema
 from information_schema.tables
 where table_schema != 'information_schema'
 and table_schema != 'pg_catalog'
 and table_schema != 'pg_internal'`,
 { rowLimit: 10000, includeQueryInError: true }
 from information_schema.tables
 where table_schema not in ('information_schema', 'pg_catalog', 'pg_internal', 'pg_toast')
 ${schemaClause}`,
 { params, rowLimit: 10000, includeQueryInError: true }
 );
 const { rows } = queryResult;
 return rows.map(row => ({
 schema: row.table_schema,
 name: row.table_name
 const targets = queryResult.rows.map(row => ({
 schema: row.table_schema as string,
 name: row.table_name as string
 }));
 // Hydrate full metadata for each target — IDbAdapter.tables returns
 // ITableMetadata[], not ITarget[].
 return await Promise.all(targets.map(target => this.table(target)));
 }

 public async search(
 searchText: string,
 options: { limit: number } = { limit: 1000 }
 ): Promise<sqlanvil.ITableMetadata[]> {
 // TODO: It would be nice to extend this to search through table/column descriptions. However, this involves
 // a somewhat crazy 5-way join.
 const results = await this.execute(
 `select tables.table_schema as table_schema, tables.table_name as table_name
 from information_schema.tables as tables
 left join information_schema.columns columns on tables.table_schema = columns.table_schema and tables.table_name = columns.table_name
 where tables.table_schema ilike $1 or tables.table_name ilike $1 or columns.column_name ilike $1
 left join information_schema.columns columns
 on tables.table_schema = columns.table_schema
 and tables.table_name = columns.table_name
 where tables.table_schema ilike $1
 or tables.table_name ilike $1
 or columns.column_name ilike $1
 group by 1, 2`,
 {
 params: [`%${searchText}%`],
Expand DownExpand Up@@ -186,13 +203,13 @@ export class PostgresDbAdapter implements IDbAdapter {
 { params, includeQueryInError: true }
 ),
 this.execute(
 `
select objsubid as column_number, description from pg_description
 where objoid = (
 select oid from pg_class where relname = $2 and relnamespace = (
 select oid from pg_namespace where nspname = $1
 )
 )`,
 `select objsubid as column_number, description
 from pg_description
where objoid = (
select oid from pg_class where relname = $2 and relnamespace = (
select oid from pg_namespace where nspname = $1
)
)`,
 { params, includeQueryInError: true }
 )
 ]);
Expand DownExpand Up@@ -220,38 +237,42 @@ export class PostgresDbAdapter implements IDbAdapter {
 });
 }

 public async preview(target: sqlanvil.ITarget, limitRows: number = 10): Promise<any[]> {
 const { rows } = await this.execute(
 `SELECT * FROM "${target.schema}"."${target.name}" LIMIT ${limitRows}`
 public async deleteTable(target: sqlanvil.ITarget): Promise<void> {
 const metadata = await this.table(target);
 if (!metadata) {
 return;
 }
 const kind = metadata.type === sqlanvil.TableMetadata.Type.VIEW ? "view" : "table";
 await this.execute(
 `drop ${kind} if exists "${target.schema}"."${target.name}" cascade`,
 { includeQueryInError: true }
 );
 return rows;
 }

 public async schemas(): Promise<string[]> {
 const schemas = await this.execute(`select nspname from pg_namespace`, {
 public async schemas(_database: string): Promise<string[]> {
 const result = await this.execute(`select nspname from pg_namespace`, {
 includeQueryInError: true
 });
 return schemas.rows.map(row => row.nspname);
 }

 public async createSchema(_: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, { includeQueryInError: true });
 return result.rows
 .map(row => row.nspname as string)
 .filter(name => !INTERNAL_SCHEMAS.has(name) && !name.startsWith("pg_"));
 }

 public async close() {
 await this.queryExecutor.close();
 if (this.options.sshTunnel) {
 await this.options.sshTunnel.close();
 }
 public async createSchema(_database: string, schema: string): Promise<void> {
 await this.execute(`create schema if not exists "${schema}"`, {
 includeQueryInError: true
 });
 }

 public async setMetadata(action: sqlanvil.IExecutionAction): Promise<void> {
 const { target, actionDescriptor, tableType } = action;

 const actualMetadata = await this.table(target);
 if (!actualMetadata) {
 return;
 }

 const queries: Array<Promise<any>> = [];
 if (actionDescriptor.description) {
 const queries: Array<Promise<unknown>> = [];
 if (actionDescriptor?.description) {
 queries.push(
 this.execute(
 `comment on ${tableType === "view" ? "view" : "table"} "${target.schema}"."${
Expand All@@ -260,7 +281,7 @@ export class PostgresDbAdapter implements IDbAdapter {
 )
 );
 }
 if (actionDescriptor.columns?.length > 0) {
 if (actionDescriptor?.columns?.length > 0) {
 actionDescriptor.columns
 .filter(
 column =>
Expand All@@ -277,7 +298,10 @@ export class PostgresDbAdapter implements IDbAdapter {
 );
 });
 }

 await Promise.all(queries);
 }

 public async close(): Promise<void> {
 await this.queryExecutor.close();
 }
}

11 changes: 4 additions & 7 deletions
cli/api/utils/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,19 +4,16 @@ load("//tools:ts_library.bzl", "ts_library")

ts_library(
 name = "utils",
 srcs = glob(
 ["**/*.ts"],
 # Postgres helper — relocated from api/utils/ in Phase 2.
 # Excluded until Phase 3 wires it through cli/api's BUILD with
 # the right pg/pg-query-stream deps and an updated import surface.
 exclude = ["postgres.ts"],
 ),
 srcs = glob(["**/*.ts"]),
 deps = [
 "//common/protos",
 "//common/strings",
 "//core",
 "//protos:ts",
 "@npm//@types/node",
 "@npm//@types/pg",
 "@npm//object-sizeof",
 "@npm//pg",
 "@npm//pg-query-stream",
 ],
)
Loading