Class CockroachDB

packages/schema/src/dialects/cockroachdb.ts:24–679

}

export default class CockroachDB implements SchemaInspector {
	knex: Knex;
	schema: string;
	protected explodedSchema: string[];
	protected databaseName: string | undefined;

	constructor(knex: Knex) {
		this.knex = knex;
		const config = knex.client.config;

		if (!config.searchPath) {
			this.schema = 'public';
			this.explodedSchema = [this.schema];
		} else if (typeof config.searchPath === 'string') {
			this.schema = config.searchPath;
			this.explodedSchema = [config.searchPath];
		} else {
			this.schema = config.searchPath[0];
			this.explodedSchema = config.searchPath;
		}
	}

	// CockroachDB specific
	// ===============================================================================================

	private async getDatabaseName(): Promise<string> {
		// dont query the database multiple times if we need the db name multiple times
		if (!this.databaseName) {
			const result = await this.knex.raw<{ rows: { db: string }[] }>(`SELECT current_database() AS db`);
			this.databaseName = result.rows[0]!.db;
		}

		return this.databaseName;
	}

	private async resolveTableSchema(table: string): Promise<string> {
		const row = await this.knex
			.select<{ table_schema: string }>('table_schema')
			.from('information_schema.tables')
			.whereIn('table_schema', this.explodedSchema)
			.andWhere({ table_name: table, table_type: 'BASE TABLE' })
			.first();

		return row?.table_schema ?? this.explodedSchema[0]!;
	}

	private sanitizeIdentifier(schema: string, name: string): string {
		const wrappedSchema = this.knex.client.wrapIdentifier(schema);
		const wrapperName = this.knex.client.wrapIdentifier(name);
		return `${wrappedSchema}.${wrapperName}`;
	}

	/**
	 * Set the schema to be used in other methods
	 */
	withSchema(schema: string): this {
		this.schema = schema;
		this.explodedSchema = [this.schema];