@langchain/google-cloud-sql-pg 0.0.2 → 1.0.1

package/dist/engine.cjs

@@ -1,252 +1,198 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const require_utils = require('./utils/utils.cjs');
+const __google_cloud_cloud_sql_connector = require_rolldown_runtime.__toESM(require("@google-cloud/cloud-sql-connector"));
+const google_auth_library = require_rolldown_runtime.__toESM(require("google-auth-library"));
+const knex = require_rolldown_runtime.__toESM(require("knex"));
+
+//#region src/engine.ts
+var Column = class {
+	name;
+	dataType;
+	nullable;
+	constructor(name, dataType, nullable = true) {
+		this.name = name;
+		this.dataType = dataType;
+		this.nullable = nullable;
+		this.postInitilization();
+	}
+	postInitilization() {
+		if (typeof this.name !== "string") throw Error("Column name must be type string");
+		if (typeof this.dataType !== "string") throw Error("Column data_type must be type string");
+	}
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PostgresEngine = exports.Column = void 0;
-const cloud_sql_connector_1 = require("@google-cloud/cloud-sql-connector");
-const google_auth_library_1 = require("google-auth-library");
-const knex_1 = __importDefault(require("knex"));
-const utils_js_1 = require("./utils/utils.cjs");
-class Column {
-    constructor(name, dataType, nullable = true) {
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "dataType", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "nullable", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = name;
-        this.dataType = dataType;
-        this.nullable = nullable;
-        this.postInitilization();
-    }
-    postInitilization() {
-        if (typeof this.name !== "string") {
-            throw Error("Column name must be type string");
-        }
-        if (typeof this.dataType !== "string") {
-            throw Error("Column data_type must be type string");
-        }
-    }
-}
-exports.Column = Column;
 const USER_AGENT = "langchain-google-cloud-sql-pg-js";
 /**
- * Cloud SQL shared connection pool
- *
- * Setup:
- * Install `@langchain/google-cloud-sql-pg`
- *
- * <details open>
- * <summary><strong>Instantiate</strong></summary>
- *
- * ```typescript
- * import { Column, PostgresEngine, PostgresEngineArgs } from "@langchain/google-cloud-sql-pg";
- *
- * const pgArgs: PostgresEngineArgs = {
- *    user: "db-user",
- *    password: "password"
- *}
- *
- * const engine: PostgresEngine = await PostgresEngine.fromInstance(
- *  "project-id",
- *  "region",
- *  "instance-name",
- *  "database-name",
- *  pgArgs
- * );
- * ```
- * </details>
- *
- * <br />
- *
- */
-class PostgresEngine {
-    constructor(key, pool) {
-        Object.defineProperty(this, "pool", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        if (key !== PostgresEngine._createKey) {
-            throw Error("Only create class through 'create' method!");
-        }
-        this.pool = pool;
-    }
-    /**
-     * @param projectId Required - GCP Project ID
-     * @param region Required - Postgres Instance Region
-     * @param instance Required - Postgres Instance name
-     * @param database Required - Database name
-     * @param ipType Optional - IP address type. Defaults to IPAddressType.PUBLIC
-     * @param user Optional - Postgres user name. Defaults to undefined
-     * @param password Optional - Postgres user password. Defaults to undefined
-     * @param iamAccountEmail Optional - IAM service account email. Defaults to undefined
-     * @returns PostgresEngine instance
-     */
-    static async fromInstance(projectId, region, instance, database, { ipType = cloud_sql_connector_1.IpAddressTypes.PUBLIC, user, password, iamAccountEmail, } = {}) {
-        let dbUser;
-        let enableIAMAuth;
-        if ((!user && password) || (user && !password)) {
-            // XOR for strings
-            throw Error("Only one of 'user' or 'password' were specified. Either " +
-                "both should be specified to use basic user/password " +
-                "authentication or neither for IAM DB authentication.");
-        }
-        // User and password are given so we use the basic auth
-        if (user !== undefined && password !== undefined) {
-            enableIAMAuth = false;
-            dbUser = user;
-        }
-        else {
-            enableIAMAuth = true;
-            if (iamAccountEmail !== undefined) {
-                dbUser = iamAccountEmail;
-            }
-            else {
-                // Get application default credentials
-                const auth = new google_auth_library_1.GoogleAuth({
-                    scopes: "https://www.googleapis.com/auth/cloud-platform",
-                });
-                // dbUser should be the iam principal email by passing the credentials obtained
-                dbUser = await (0, utils_js_1.getIAMPrincipalEmail)(auth);
-            }
-        }
-        PostgresEngine.connector = new cloud_sql_connector_1.Connector({ userAgent: USER_AGENT });
-        const clientOpts = await PostgresEngine.connector.getOptions({
-            instanceConnectionName: `${projectId}:${region}:${instance}`,
-            ipType,
-            authType: enableIAMAuth ? cloud_sql_connector_1.AuthTypes.IAM : cloud_sql_connector_1.AuthTypes.PASSWORD,
-        });
-        const dbConfig = {
-            client: "pg",
-            connection: {
-                ...clientOpts,
-                ...(password ? { password } : {}),
-                user: dbUser,
-                database,
-            },
-        };
-        const engine = (0, knex_1.default)(dbConfig);
-        return new PostgresEngine(PostgresEngine._createKey, engine);
-    }
-    /**
-     * Create a PostgresEngine instance from an Knex instance.
-     *
-     * @param engine knex instance
-     * @returns PostgresEngine instance from a knex instance
-     */
-    static async fromPool(engine) {
-        return new PostgresEngine(PostgresEngine._createKey, engine);
-    }
-    /**
-     * Create a PostgresEngine instance from arguments.
-     *
-     * @param url URL use to connect to a database
-     * @param poolConfig Optional - Configuration pool to use in the Knex configuration
-     * @returns PostgresEngine instance
-     */
-    static async fromConnectionString(url, poolConfig) {
-        const driver = "postgresql+asyncpg";
-        if (typeof url === "string" && !url.startsWith(driver)) {
-            throw Error("Driver must be type 'postgresql+asyncpg'");
-        }
-        const dbConfig = {
-            client: "pg",
-            connection: url,
-            acquireConnectionTimeout: 1000000,
-            pool: {
-                ...poolConfig,
-                acquireTimeoutMillis: 600000,
-            },
-        };
-        const engine = (0, knex_1.default)(dbConfig);
-        return new PostgresEngine(PostgresEngine._createKey, engine);
-    }
-    /**
-     * Create a table for saving of vectors to be used with PostgresVectorStore.
-     *
-     * @param tableName Postgres database table name. Parameter is not escaped. Do not use with end user input.
-     * @param vectorSize Vector size for the embedding model to be used.
-     * @param schemaName The schema name to store Postgres database table. Default: "public". Parameter is not escaped. Do not use with end user input.
-     * @param contentColumn Name of the column to store document content. Default: "content".
-     * @param embeddingColumn Name of the column to store vector embeddings. Default: "embedding".
-     * @param metadataColumns Optional - A list of Columns to create for custom metadata. Default: [].
-     * @param metadataJsonColumn Optional - The column to store extra metadata in JSON format. Default: "langchain_metadata".
-     * @param idColumn Optional - Column to store ids. Default: "langchain_id" column name with data type UUID.
-     * @param overwriteExisting Whether to drop existing table. Default: False.
-     * @param storeMetadata Whether to store metadata in the table. Default: True.
-     */
-    async initVectorstoreTable(tableName, vectorSize, { schemaName = "public", contentColumn = "content", embeddingColumn = "embedding", metadataColumns = [], metadataJsonColumn = "langchain_metadata", idColumn = "langchain_id", overwriteExisting = false, storeMetadata = true, } = {}) {
-        await this.pool.raw("CREATE EXTENSION IF NOT EXISTS vector");
-        if (overwriteExisting) {
-            await this.pool.schema
-                .withSchema(schemaName)
-                .dropTableIfExists(tableName);
-        }
-        const idDataType = typeof idColumn === "string" ? "UUID" : idColumn.dataType;
-        const idColumnName = typeof idColumn === "string" ? idColumn : idColumn.name;
-        let query = `CREATE TABLE ${schemaName}.${tableName}(
+* Cloud SQL shared connection pool
+*
+* Setup:
+* Install `@langchain/google-cloud-sql-pg`
+*
+* <details open>
+* <summary><strong>Instantiate</strong></summary>
+*
+* ```typescript
+* import { Column, PostgresEngine, PostgresEngineArgs } from "@langchain/google-cloud-sql-pg";
+*
+* const pgArgs: PostgresEngineArgs = {
+*    user: "db-user",
+*    password: "password"
+*}
+*
+* const engine: PostgresEngine = await PostgresEngine.fromInstance(
+*  "project-id",
+*  "region",
+*  "instance-name",
+*  "database-name",
+*  pgArgs
+* );
+* ```
+* </details>
+*
+* <br />
+*
+*/
+var PostgresEngine = class PostgresEngine {
+	static _createKey = Symbol("key");
+	pool;
+	static connector;
+	constructor(key, pool) {
+		if (key !== PostgresEngine._createKey) throw Error("Only create class through 'create' method!");
+		this.pool = pool;
+	}
+	/**
+	* @param projectId Required - GCP Project ID
+	* @param region Required - Postgres Instance Region
+	* @param instance Required - Postgres Instance name
+	* @param database Required - Database name
+	* @param ipType Optional - IP address type. Defaults to IPAddressType.PUBLIC
+	* @param user Optional - Postgres user name. Defaults to undefined
+	* @param password Optional - Postgres user password. Defaults to undefined
+	* @param iamAccountEmail Optional - IAM service account email. Defaults to undefined
+	* @returns PostgresEngine instance
+	*/
+	static async fromInstance(projectId, region, instance, database, { ipType = __google_cloud_cloud_sql_connector.IpAddressTypes.PUBLIC, user, password, iamAccountEmail } = {}) {
+		let dbUser;
+		let enableIAMAuth;
+		if (!user && password || user && !password) throw Error("Only one of 'user' or 'password' were specified. Either both should be specified to use basic user/password authentication or neither for IAM DB authentication.");
+		if (user !== void 0 && password !== void 0) {
+			enableIAMAuth = false;
+			dbUser = user;
+		} else {
+			enableIAMAuth = true;
+			if (iamAccountEmail !== void 0) dbUser = iamAccountEmail;
+			else {
+				const auth = new google_auth_library.GoogleAuth({ scopes: "https://www.googleapis.com/auth/cloud-platform" });
+				dbUser = await require_utils.getIAMPrincipalEmail(auth);
+			}
+		}
+		PostgresEngine.connector = new __google_cloud_cloud_sql_connector.Connector({ userAgent: USER_AGENT });
+		const clientOpts = await PostgresEngine.connector.getOptions({
+			instanceConnectionName: `${projectId}:${region}:${instance}`,
+			ipType,
+			authType: enableIAMAuth ? __google_cloud_cloud_sql_connector.AuthTypes.IAM : __google_cloud_cloud_sql_connector.AuthTypes.PASSWORD
+		});
+		const dbConfig = {
+			client: "pg",
+			connection: {
+				...clientOpts,
+				...password ? { password } : {},
+				user: dbUser,
+				database
+			}
+		};
+		const engine = (0, knex.default)(dbConfig);
+		return new PostgresEngine(PostgresEngine._createKey, engine);
+	}
+	/**
+	* Create a PostgresEngine instance from an Knex instance.
+	*
+	* @param engine knex instance
+	* @returns PostgresEngine instance from a knex instance
+	*/
+	static async fromPool(engine) {
+		return new PostgresEngine(PostgresEngine._createKey, engine);
+	}
+	/**
+	* Create a PostgresEngine instance from arguments.
+	*
+	* @param url URL use to connect to a database
+	* @param poolConfig Optional - Configuration pool to use in the Knex configuration
+	* @returns PostgresEngine instance
+	*/
+	static async fromConnectionString(url, poolConfig) {
+		const driver = "postgresql+asyncpg";
+		if (typeof url === "string" && !url.startsWith(driver)) throw Error("Driver must be type 'postgresql+asyncpg'");
+		const dbConfig = {
+			client: "pg",
+			connection: url,
+			acquireConnectionTimeout: 1e6,
+			pool: {
+				...poolConfig,
+				acquireTimeoutMillis: 6e5
+			}
+		};
+		const engine = (0, knex.default)(dbConfig);
+		return new PostgresEngine(PostgresEngine._createKey, engine);
+	}
+	/**
+	* Create a table for saving of vectors to be used with PostgresVectorStore.
+	*
+	* @param tableName Postgres database table name. Parameter is not escaped. Do not use with end user input.
+	* @param vectorSize Vector size for the embedding model to be used.
+	* @param schemaName The schema name to store Postgres database table. Default: "public". Parameter is not escaped. Do not use with end user input.
+	* @param contentColumn Name of the column to store document content. Default: "content".
+	* @param embeddingColumn Name of the column to store vector embeddings. Default: "embedding".
+	* @param embeddingColumnType Type of the embedding column ("vector" | "halfvec" | "bit" | "sparsevec"). Default: "vector". More info on HNSW-supported types: https://github.com/pgvector/pgvector#hnsw
+	* @param metadataColumns Optional - A list of Columns to create for custom metadata. Default: [].
+	* @param metadataJsonColumn Optional - The column to store extra metadata in JSON format. Default: "langchain_metadata".
+	* @param idColumn Optional - Column to store ids. Default: "langchain_id" column name with data type UUID.
+	* @param overwriteExisting Whether to drop existing table. Default: False.
+	* @param storeMetadata Whether to store metadata in the table. Default: True.
+	*/
+	async initVectorstoreTable(tableName, vectorSize, { schemaName = "public", contentColumn = "content", embeddingColumn = "embedding", embeddingColumnType = "vector", metadataColumns = [], metadataJsonColumn = "langchain_metadata", idColumn = "langchain_id", overwriteExisting = false, storeMetadata = true } = {}) {
+		await this.pool.raw("CREATE EXTENSION IF NOT EXISTS vector");
+		if (overwriteExisting) await this.pool.schema.withSchema(schemaName).dropTableIfExists(tableName);
+		const idDataType = typeof idColumn === "string" ? "UUID" : idColumn.dataType;
+		const idColumnName = typeof idColumn === "string" ? idColumn : idColumn.name;
+		let query = `CREATE TABLE ${schemaName}.${tableName}(
       ${idColumnName} ${idDataType} PRIMARY KEY,
       ${contentColumn} TEXT NOT NULL,
-      ${embeddingColumn} vector(${vectorSize}) NOT NULL`;
-        for (const column of metadataColumns) {
-            const nullable = !column.nullable ? "NOT NULL" : "";
-            query += `,\n ${column.name} ${column.dataType} ${nullable}`;
-        }
-        if (storeMetadata) {
-            query += `,\n${metadataJsonColumn} JSON`;
-        }
-        query += `\n);`;
-        await this.pool.raw(query);
-    }
-    /**
-     * Create a Cloud SQL table to store chat history.
-     *
-     * @param tableName Table name to store chat history
-     * @param schemaName Schema name to store chat history table
-     */
-    async initChatHistoryTable(tableName, schemaName = "public") {
-        await this.pool.raw(`CREATE TABLE IF NOT EXISTS ${schemaName}.${tableName}(
+      ${embeddingColumn} ${embeddingColumnType}(${vectorSize}) NOT NULL`;
+		for (const column of metadataColumns) {
+			const nullable = !column.nullable ? "NOT NULL" : "";
+			query += `,\n ${column.name} ${column.dataType} ${nullable}`;
+		}
+		if (storeMetadata) query += `,\n${metadataJsonColumn} JSON`;
+		query += `\n);`;
+		await this.pool.raw(query);
+	}
+	/**
+	* Create a Cloud SQL table to store chat history.
+	*
+	* @param tableName Table name to store chat history
+	* @param schemaName Schema name to store chat history table
+	*/
+	async initChatHistoryTable(tableName, schemaName = "public") {
+		await this.pool.raw(`CREATE TABLE IF NOT EXISTS ${schemaName}.${tableName}(
       id SERIAL PRIMARY KEY,
       session_id TEXT NOT NULL,
       data JSONB NOT NULL,
       type TEXT NOT NULL);`);
-    }
-    /**
-     *  Dispose of connection pool
-     */
-    async closeConnection() {
-        await this.pool.destroy();
-        if (PostgresEngine.connector !== undefined) {
-            PostgresEngine.connector.close();
-        }
-    }
-    // Just to test the connection to the database
-    testConnection() {
-        const now = this.pool.raw("SELECT NOW() as currentTimestamp");
-        return now;
-    }
-}
+	}
+	/**
+	*  Dispose of connection pool
+	*/
+	async closeConnection() {
+		await this.pool.destroy();
+		if (PostgresEngine.connector !== void 0) PostgresEngine.connector.close();
+	}
+	testConnection() {
+		const now = this.pool.raw("SELECT NOW() as currentTimestamp");
+		return now;
+	}
+};
+
+//#endregion
+exports.Column = Column;
 exports.PostgresEngine = PostgresEngine;
-Object.defineProperty(PostgresEngine, "_createKey", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: Symbol("key")
-});
-exports.default = PostgresEngine;
+//# sourceMappingURL=engine.cjs.map

package/dist/engine.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.cjs","names":["name: string","dataType: string","nullable: boolean","key: symbol","pool: knex.Knex","projectId: string","region: string","instance: string","database: string","IpAddressTypes","dbUser: string","enableIAMAuth: boolean","GoogleAuth","getIAMPrincipalEmail","Connector","AuthTypes","dbConfig: knex.Knex.Config","engine: knex.Knex","url: string | knex.Knex.StaticConnectionConfig","poolConfig?: knex.Knex.PoolConfig","tableName: string","vectorSize: number","schemaName: string"],"sources":["../src/engine.ts"],"sourcesContent":["import {\n  AuthTypes,\n  Connector,\n  IpAddressTypes,\n} from \"@google-cloud/cloud-sql-connector\";\nimport { GoogleAuth } from \"google-auth-library\";\nimport knex from \"knex\";\nimport { getIAMPrincipalEmail } from \"./utils/utils.js\";\n\nexport interface PostgresEngineArgs {\n  ipType?: IpAddressTypes;\n  user?: string;\n  password?: string;\n  iamAccountEmail?: string;\n}\n\nexport interface VectorStoreTableArgs {\n  schemaName?: string;\n  contentColumn?: string;\n  embeddingColumn?: string;\n  embeddingColumnType?: \"vector\" | \"halfvec\" | \"bit\" | \"sparsevec\";\n  metadataColumns?: Column[];\n  metadataJsonColumn?: string;\n  idColumn?: string | Column;\n  overwriteExisting?: boolean;\n  storeMetadata?: boolean;\n}\n\nexport class Column {\n  name: string;\n\n  dataType: string;\n\n  nullable: boolean;\n\n  constructor(name: string, dataType: string, nullable: boolean = true) {\n    this.name = name;\n    this.dataType = dataType;\n    this.nullable = nullable;\n\n    this.postInitilization();\n  }\n\n  private postInitilization() {\n    if (typeof this.name !== \"string\") {\n      throw Error(\"Column name must be type string\");\n    }\n\n    if (typeof this.dataType !== \"string\") {\n      throw Error(\"Column data_type must be type string\");\n    }\n  }\n}\n\nconst USER_AGENT = \"langchain-google-cloud-sql-pg-js\";\n\n/**\n * Cloud SQL shared connection pool\n *\n * Setup:\n * Install `@langchain/google-cloud-sql-pg`\n *\n * <details open>\n * <summary><strong>Instantiate</strong></summary>\n *\n * ```typescript\n * import { Column, PostgresEngine, PostgresEngineArgs } from \"@langchain/google-cloud-sql-pg\";\n *\n * const pgArgs: PostgresEngineArgs = {\n *    user: \"db-user\",\n *    password: \"password\"\n *}\n *\n * const engine: PostgresEngine = await PostgresEngine.fromInstance(\n *  \"project-id\",\n *  \"region\",\n *  \"instance-name\",\n *  \"database-name\",\n *  pgArgs\n * );\n * ```\n * </details>\n *\n * <br />\n *\n */\nexport class PostgresEngine {\n  private static _createKey = Symbol(\"key\");\n\n  pool: knex.Knex;\n\n  static connector: Connector;\n\n  constructor(key: symbol, pool: knex.Knex) {\n    if (key !== PostgresEngine._createKey) {\n      throw Error(\"Only create class through 'create' method!\");\n    }\n    this.pool = pool;\n  }\n\n  /**\n   * @param projectId Required - GCP Project ID\n   * @param region Required - Postgres Instance Region\n   * @param instance Required - Postgres Instance name\n   * @param database Required - Database name\n   * @param ipType Optional - IP address type. Defaults to IPAddressType.PUBLIC\n   * @param user Optional - Postgres user name. Defaults to undefined\n   * @param password Optional - Postgres user password. Defaults to undefined\n   * @param iamAccountEmail Optional - IAM service account email. Defaults to undefined\n   * @returns PostgresEngine instance\n   */\n\n  static async fromInstance(\n    projectId: string,\n    region: string,\n    instance: string,\n    database: string,\n    {\n      ipType = IpAddressTypes.PUBLIC,\n      user,\n      password,\n      iamAccountEmail,\n    }: PostgresEngineArgs = {}\n  ): Promise<PostgresEngine> {\n    let dbUser: string;\n    let enableIAMAuth: boolean;\n\n    if ((!user && password) || (user && !password)) {\n      // XOR for strings\n      throw Error(\n        \"Only one of 'user' or 'password' were specified. Either \" +\n          \"both should be specified to use basic user/password \" +\n          \"authentication or neither for IAM DB authentication.\"\n      );\n    }\n\n    // User and password are given so we use the basic auth\n    if (user !== undefined && password !== undefined) {\n      enableIAMAuth = false;\n      dbUser = user!;\n    } else {\n      enableIAMAuth = true;\n      if (iamAccountEmail !== undefined) {\n        dbUser = iamAccountEmail;\n      } else {\n        // Get application default credentials\n        const auth = new GoogleAuth({\n          scopes: \"https://www.googleapis.com/auth/cloud-platform\",\n        });\n        // dbUser should be the iam principal email by passing the credentials obtained\n        dbUser = await getIAMPrincipalEmail(auth);\n      }\n    }\n\n    PostgresEngine.connector = new Connector({ userAgent: USER_AGENT });\n    const clientOpts = await PostgresEngine.connector.getOptions({\n      instanceConnectionName: `${projectId}:${region}:${instance}`,\n      ipType,\n      authType: enableIAMAuth ? AuthTypes.IAM : AuthTypes.PASSWORD,\n    });\n\n    const dbConfig: knex.Knex.Config = {\n      client: \"pg\",\n      connection: {\n        ...clientOpts,\n        ...(password ? { password } : {}),\n        user: dbUser,\n        database,\n      },\n    };\n\n    const engine = knex(dbConfig);\n\n    return new PostgresEngine(PostgresEngine._createKey, engine);\n  }\n\n  /**\n   * Create a PostgresEngine instance from an Knex instance.\n   *\n   * @param engine knex instance\n   * @returns PostgresEngine instance from a knex instance\n   */\n  static async fromPool(engine: knex.Knex) {\n    return new PostgresEngine(PostgresEngine._createKey, engine);\n  }\n\n  /**\n   * Create a PostgresEngine instance from arguments.\n   *\n   * @param url URL use to connect to a database\n   * @param poolConfig Optional - Configuration pool to use in the Knex configuration\n   * @returns PostgresEngine instance\n   */\n  static async fromConnectionString(\n    url: string | knex.Knex.StaticConnectionConfig,\n    poolConfig?: knex.Knex.PoolConfig\n  ) {\n    const driver = \"postgresql+asyncpg\";\n\n    if (typeof url === \"string\" && !url.startsWith(driver)) {\n      throw Error(\"Driver must be type 'postgresql+asyncpg'\");\n    }\n\n    const dbConfig: knex.Knex.Config = {\n      client: \"pg\",\n      connection: url,\n      acquireConnectionTimeout: 1000000,\n      pool: {\n        ...poolConfig,\n        acquireTimeoutMillis: 600000,\n      },\n    };\n\n    const engine = knex(dbConfig);\n\n    return new PostgresEngine(PostgresEngine._createKey, engine);\n  }\n\n  /**\n   * Create a table for saving of vectors to be used with PostgresVectorStore.\n   *\n   * @param tableName Postgres database table name. Parameter is not escaped. Do not use with end user input.\n   * @param vectorSize Vector size for the embedding model to be used.\n   * @param schemaName The schema name to store Postgres database table. Default: \"public\". Parameter is not escaped. Do not use with end user input.\n   * @param contentColumn Name of the column to store document content. Default: \"content\".\n   * @param embeddingColumn Name of the column to store vector embeddings. Default: \"embedding\".\n   * @param embeddingColumnType Type of the embedding column (\"vector\" | \"halfvec\" | \"bit\" | \"sparsevec\"). Default: \"vector\". More info on HNSW-supported types: https://github.com/pgvector/pgvector#hnsw\n   * @param metadataColumns Optional - A list of Columns to create for custom metadata. Default: [].\n   * @param metadataJsonColumn Optional - The column to store extra metadata in JSON format. Default: \"langchain_metadata\".\n   * @param idColumn Optional - Column to store ids. Default: \"langchain_id\" column name with data type UUID.\n   * @param overwriteExisting Whether to drop existing table. Default: False.\n   * @param storeMetadata Whether to store metadata in the table. Default: True.\n   */\n  async initVectorstoreTable(\n    tableName: string,\n    vectorSize: number,\n    {\n      schemaName = \"public\",\n      contentColumn = \"content\",\n      embeddingColumn = \"embedding\",\n      embeddingColumnType = \"vector\",\n      metadataColumns = [],\n      metadataJsonColumn = \"langchain_metadata\",\n      idColumn = \"langchain_id\",\n      overwriteExisting = false,\n      storeMetadata = true,\n    }: VectorStoreTableArgs = {}\n  ): Promise<void> {\n    await this.pool.raw(\"CREATE EXTENSION IF NOT EXISTS vector\");\n\n    if (overwriteExisting) {\n      await this.pool.schema\n        .withSchema(schemaName)\n        .dropTableIfExists(tableName);\n    }\n\n    const idDataType =\n      typeof idColumn === \"string\" ? \"UUID\" : idColumn.dataType;\n    const idColumnName =\n      typeof idColumn === \"string\" ? idColumn : idColumn.name;\n\n    let query = `CREATE TABLE ${schemaName}.${tableName}(\n      ${idColumnName} ${idDataType} PRIMARY KEY,\n      ${contentColumn} TEXT NOT NULL,\n      ${embeddingColumn} ${embeddingColumnType}(${vectorSize}) NOT NULL`;\n\n    for (const column of metadataColumns) {\n      const nullable = !column.nullable ? \"NOT NULL\" : \"\";\n      query += `,\\n ${column.name} ${column.dataType} ${nullable}`;\n    }\n\n    if (storeMetadata) {\n      query += `,\\n${metadataJsonColumn} JSON`;\n    }\n\n    query += `\\n);`;\n\n    await this.pool.raw(query);\n  }\n\n  /**\n   * Create a Cloud SQL table to store chat history.\n   *\n   * @param tableName Table name to store chat history\n   * @param schemaName Schema name to store chat history table\n   */\n\n  async initChatHistoryTable(\n    tableName: string,\n    schemaName: string = \"public\"\n  ): Promise<void> {\n    await this.pool.raw(\n      `CREATE TABLE IF NOT EXISTS ${schemaName}.${tableName}(\n      id SERIAL PRIMARY KEY,\n      session_id TEXT NOT NULL,\n      data JSONB NOT NULL,\n      type TEXT NOT NULL);`\n    );\n  }\n\n  /**\n   *  Dispose of connection pool\n   */\n  async closeConnection(): Promise<void> {\n    await this.pool.destroy();\n    if (PostgresEngine.connector !== undefined) {\n      PostgresEngine.connector.close();\n    }\n  }\n\n  // Just to test the connection to the database\n  testConnection() {\n    const now = this.pool.raw(\"SELECT NOW() as currentTimestamp\");\n    return now;\n  }\n}\n\nexport default PostgresEngine;\n"],"mappings":";;;;;;;AA4BA,IAAa,SAAb,MAAoB;CAClB;CAEA;CAEA;CAEA,YAAYA,MAAcC,UAAkBC,WAAoB,MAAM;EACpE,KAAK,OAAO;EACZ,KAAK,WAAW;EAChB,KAAK,WAAW;EAEhB,KAAK,mBAAmB;CACzB;CAED,AAAQ,oBAAoB;AAC1B,MAAI,OAAO,KAAK,SAAS,SACvB,OAAM,MAAM,kCAAkC;AAGhD,MAAI,OAAO,KAAK,aAAa,SAC3B,OAAM,MAAM,uCAAuC;CAEtD;AACF;AAED,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCnB,IAAa,iBAAb,MAAa,eAAe;CAC1B,OAAe,aAAa,OAAO,MAAM;CAEzC;CAEA,OAAO;CAEP,YAAYC,KAAaC,MAAiB;AACxC,MAAI,QAAQ,eAAe,WACzB,OAAM,MAAM,6CAA6C;EAE3D,KAAK,OAAO;CACb;;;;;;;;;;;;CAcD,aAAa,aACXC,WACAC,QACAC,UACAC,UACA,EACE,SAASC,kDAAe,QACxB,MACA,UACA,iBACmB,GAAG,CAAE,GACD;EACzB,IAAIC;EACJ,IAAIC;AAEJ,MAAK,CAAC,QAAQ,YAAc,QAAQ,CAAC,SAEnC,OAAM,MACJ,mKAGD;AAIH,MAAI,SAAS,UAAa,aAAa,QAAW;GAChD,gBAAgB;GAChB,SAAS;EACV,OAAM;GACL,gBAAgB;AAChB,OAAI,oBAAoB,QACtB,SAAS;QACJ;IAEL,MAAM,OAAO,IAAIC,+BAAW,EAC1B,QAAQ,iDACT;IAED,SAAS,MAAMC,mCAAqB,KAAK;GAC1C;EACF;EAED,eAAe,YAAY,IAAIC,6CAAU,EAAE,WAAW,WAAY;EAClE,MAAM,aAAa,MAAM,eAAe,UAAU,WAAW;GAC3D,wBAAwB,GAAG,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,UAAU;GAC5D;GACA,UAAU,gBAAgBC,6CAAU,MAAMA,6CAAU;EACrD,EAAC;EAEF,MAAMC,WAA6B;GACjC,QAAQ;GACR,YAAY;IACV,GAAG;IACH,GAAI,WAAW,EAAE,SAAU,IAAG,CAAE;IAChC,MAAM;IACN;GACD;EACF;EAED,MAAM,2BAAc,SAAS;AAE7B,SAAO,IAAI,eAAe,eAAe,YAAY;CACtD;;;;;;;CAQD,aAAa,SAASC,QAAmB;AACvC,SAAO,IAAI,eAAe,eAAe,YAAY;CACtD;;;;;;;;CASD,aAAa,qBACXC,KACAC,YACA;EACA,MAAM,SAAS;AAEf,MAAI,OAAO,QAAQ,YAAY,CAAC,IAAI,WAAW,OAAO,CACpD,OAAM,MAAM,2CAA2C;EAGzD,MAAMH,WAA6B;GACjC,QAAQ;GACR,YAAY;GACZ,0BAA0B;GAC1B,MAAM;IACJ,GAAG;IACH,sBAAsB;GACvB;EACF;EAED,MAAM,2BAAc,SAAS;AAE7B,SAAO,IAAI,eAAe,eAAe,YAAY;CACtD;;;;;;;;;;;;;;;;CAiBD,MAAM,qBACJI,WACAC,YACA,EACE,aAAa,UACb,gBAAgB,WAChB,kBAAkB,aAClB,sBAAsB,UACtB,kBAAkB,CAAE,GACpB,qBAAqB,sBACrB,WAAW,gBACX,oBAAoB,OACpB,gBAAgB,MACK,GAAG,CAAE,GACb;EACf,MAAM,KAAK,KAAK,IAAI,wCAAwC;AAE5D,MAAI,mBACF,MAAM,KAAK,KAAK,OACb,WAAW,WAAW,CACtB,kBAAkB,UAAU;EAGjC,MAAM,aACJ,OAAO,aAAa,WAAW,SAAS,SAAS;EACnD,MAAM,eACJ,OAAO,aAAa,WAAW,WAAW,SAAS;EAErD,IAAI,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,UAAU;MAClD,EAAE,aAAa,CAAC,EAAE,WAAW;MAC7B,EAAE,cAAc;MAChB,EAAE,gBAAgB,CAAC,EAAE,oBAAoB,CAAC,EAAE,WAAW,UAAU,CAAC;AAEpE,OAAK,MAAM,UAAU,iBAAiB;GACpC,MAAM,WAAW,CAAC,OAAO,WAAW,aAAa;GACjD,SAAS,CAAC,IAAI,EAAE,OAAO,KAAK,CAAC,EAAE,OAAO,SAAS,CAAC,EAAE,UAAU;EAC7D;AAED,MAAI,eACF,SAAS,CAAC,GAAG,EAAE,mBAAmB,KAAK,CAAC;EAG1C,SAAS,CAAC,IAAI,CAAC;EAEf,MAAM,KAAK,KAAK,IAAI,MAAM;CAC3B;;;;;;;CASD,MAAM,qBACJD,WACAE,aAAqB,UACN;EACf,MAAM,KAAK,KAAK,IACd,CAAC,2BAA2B,EAAE,WAAW,CAAC,EAAE,UAAU;;;;0BAIlC,CAAC,CACtB;CACF;;;;CAKD,MAAM,kBAAiC;EACrC,MAAM,KAAK,KAAK,SAAS;AACzB,MAAI,eAAe,cAAc,QAC/B,eAAe,UAAU,OAAO;CAEnC;CAGD,iBAAiB;EACf,MAAM,MAAM,KAAK,KAAK,IAAI,mCAAmC;AAC7D,SAAO;CACR;AACF"}

package/dist/engine.d.cts

@@ -0,0 +1,138 @@
+import { Connector, IpAddressTypes } from "@google-cloud/cloud-sql-connector";
+import knex from "knex";
+
+//#region src/engine.d.ts
+interface PostgresEngineArgs {
+  ipType?: IpAddressTypes;
+  user?: string;
+  password?: string;
+  iamAccountEmail?: string;
+}
+interface VectorStoreTableArgs {
+  schemaName?: string;
+  contentColumn?: string;
+  embeddingColumn?: string;
+  embeddingColumnType?: "vector" | "halfvec" | "bit" | "sparsevec";
+  metadataColumns?: Column[];
+  metadataJsonColumn?: string;
+  idColumn?: string | Column;
+  overwriteExisting?: boolean;
+  storeMetadata?: boolean;
+}
+declare class Column {
+  name: string;
+  dataType: string;
+  nullable: boolean;
+  constructor(name: string, dataType: string, nullable?: boolean);
+  private postInitilization;
+}
+/**
+ * Cloud SQL shared connection pool
+ *
+ * Setup:
+ * Install `@langchain/google-cloud-sql-pg`
+ *
+ * <details open>
+ * <summary><strong>Instantiate</strong></summary>
+ *
+ * ```typescript
+ * import { Column, PostgresEngine, PostgresEngineArgs } from "@langchain/google-cloud-sql-pg";
+ *
+ * const pgArgs: PostgresEngineArgs = {
+ *    user: "db-user",
+ *    password: "password"
+ *}
+ *
+ * const engine: PostgresEngine = await PostgresEngine.fromInstance(
+ *  "project-id",
+ *  "region",
+ *  "instance-name",
+ *  "database-name",
+ *  pgArgs
+ * );
+ * ```
+ * </details>
+ *
+ * <br />
+ *
+ */
+declare class PostgresEngine {
+  private static _createKey;
+  pool: knex.Knex;
+  static connector: Connector;
+  constructor(key: symbol, pool: knex.Knex);
+  /**
+   * @param projectId Required - GCP Project ID
+   * @param region Required - Postgres Instance Region
+   * @param instance Required - Postgres Instance name
+   * @param database Required - Database name
+   * @param ipType Optional - IP address type. Defaults to IPAddressType.PUBLIC
+   * @param user Optional - Postgres user name. Defaults to undefined
+   * @param password Optional - Postgres user password. Defaults to undefined
+   * @param iamAccountEmail Optional - IAM service account email. Defaults to undefined
+   * @returns PostgresEngine instance
+   */
+  static fromInstance(projectId: string, region: string, instance: string, database: string, {
+    ipType,
+    user,
+    password,
+    iamAccountEmail
+  }?: PostgresEngineArgs): Promise<PostgresEngine>;
+  /**
+   * Create a PostgresEngine instance from an Knex instance.
+   *
+   * @param engine knex instance
+   * @returns PostgresEngine instance from a knex instance
+   */
+  static fromPool(engine: knex.Knex): Promise<PostgresEngine>;
+  /**
+   * Create a PostgresEngine instance from arguments.
+   *
+   * @param url URL use to connect to a database
+   * @param poolConfig Optional - Configuration pool to use in the Knex configuration
+   * @returns PostgresEngine instance
+   */
+  static fromConnectionString(url: string | knex.Knex.StaticConnectionConfig, poolConfig?: knex.Knex.PoolConfig): Promise<PostgresEngine>;
+  /**
+   * Create a table for saving of vectors to be used with PostgresVectorStore.
+   *
+   * @param tableName Postgres database table name. Parameter is not escaped. Do not use with end user input.
+   * @param vectorSize Vector size for the embedding model to be used.
+   * @param schemaName The schema name to store Postgres database table. Default: "public". Parameter is not escaped. Do not use with end user input.
+   * @param contentColumn Name of the column to store document content. Default: "content".
+   * @param embeddingColumn Name of the column to store vector embeddings. Default: "embedding".
+   * @param embeddingColumnType Type of the embedding column ("vector" | "halfvec" | "bit" | "sparsevec"). Default: "vector". More info on HNSW-supported types: https://github.com/pgvector/pgvector#hnsw
+   * @param metadataColumns Optional - A list of Columns to create for custom metadata. Default: [].
+   * @param metadataJsonColumn Optional - The column to store extra metadata in JSON format. Default: "langchain_metadata".
+   * @param idColumn Optional - Column to store ids. Default: "langchain_id" column name with data type UUID.
+   * @param overwriteExisting Whether to drop existing table. Default: False.
+   * @param storeMetadata Whether to store metadata in the table. Default: True.
+   */
+  initVectorstoreTable(tableName: string, vectorSize: number, {
+    schemaName,
+    contentColumn,
+    embeddingColumn,
+    embeddingColumnType,
+    metadataColumns,
+    metadataJsonColumn,
+    idColumn,
+    overwriteExisting,
+    storeMetadata
+  }?: VectorStoreTableArgs): Promise<void>;
+  /**
+   * Create a Cloud SQL table to store chat history.
+   *
+   * @param tableName Table name to store chat history
+   * @param schemaName Schema name to store chat history table
+   */
+  initChatHistoryTable(tableName: string, schemaName?: string): Promise<void>;
+  /**
+   *  Dispose of connection pool
+   */
+  closeConnection(): Promise<void>;
+  // Just to test the connection to the database
+  testConnection(): knex.Knex.Raw<any>;
+}
+//#endregion
+export { Column, PostgresEngine, PostgresEngineArgs, VectorStoreTableArgs };
+//# sourceMappingURL=engine.d.cts.map