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

package/dist/engine.d.ts

@@ -1,27 +1,30 @@
 import { Connector, IpAddressTypes } from "@google-cloud/cloud-sql-connector";
 import knex from "knex";
-export interface PostgresEngineArgs {
-    ipType?: IpAddressTypes;
-    user?: string;
-    password?: string;
-    iamAccountEmail?: string;
+
+//#region src/engine.d.ts
+interface PostgresEngineArgs {
+  ipType?: IpAddressTypes;
+  user?: string;
+  password?: string;
+  iamAccountEmail?: string;
 }
-export interface VectorStoreTableArgs {
-    schemaName?: string;
-    contentColumn?: string;
-    embeddingColumn?: string;
-    metadataColumns?: Column[];
-    metadataJsonColumn?: string;
-    idColumn?: string | Column;
-    overwriteExisting?: boolean;
-    storeMetadata?: boolean;
+interface VectorStoreTableArgs {
+  schemaName?: string;
+  contentColumn?: string;
+  embeddingColumn?: string;
+  embeddingColumnType?: "vector" | "halfvec" | "bit" | "sparsevec";
+  metadataColumns?: Column[];
+  metadataJsonColumn?: string;
+  idColumn?: string | Column;
+  overwriteExisting?: boolean;
+  storeMetadata?: boolean;
 }
-export declare class Column {
-    name: string;
-    dataType: string;
-    nullable: boolean;
-    constructor(name: string, dataType: string, nullable?: boolean);
-    private postInitilization;
+declare class Column {
+  name: string;
+  dataType: string;
+  nullable: boolean;
+  constructor(name: string, dataType: string, nullable?: boolean);
+  private postInitilization;
 }
 /**
  * Cloud SQL shared connection pool
@@ -53,64 +56,83 @@ export declare class Column {
  * <br />
  *
  */
-export 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 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, 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>;
-    testConnection(): knex.Knex.Raw<any>;
+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>;
 }
-export default PostgresEngine;
+//#endregion
+export { Column, PostgresEngine, PostgresEngineArgs, VectorStoreTableArgs };
+//# sourceMappingURL=engine.d.ts.map

package/dist/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","names":["Connector","IpAddressTypes","knex","PostgresEngineArgs","VectorStoreTableArgs","Column","PostgresEngine","Knex","ipType","user","password","iamAccountEmail","Promise","StaticConnectionConfig","PoolConfig","schemaName","contentColumn","embeddingColumn","embeddingColumnType","metadataColumns","metadataJsonColumn","idColumn","overwriteExisting","storeMetadata","Raw","default"],"sources":["../src/engine.d.ts"],"sourcesContent":["import { Connector, IpAddressTypes } from \"@google-cloud/cloud-sql-connector\";\nimport knex from \"knex\";\nexport interface PostgresEngineArgs {\n    ipType?: IpAddressTypes;\n    user?: string;\n    password?: string;\n    iamAccountEmail?: string;\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}\nexport declare class Column {\n    name: string;\n    dataType: string;\n    nullable: boolean;\n    constructor(name: string, dataType: string, nullable?: boolean);\n    private postInitilization;\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 declare class PostgresEngine {\n    private static _createKey;\n    pool: knex.Knex;\n    static connector: Connector;\n    constructor(key: symbol, pool: knex.Knex);\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    static fromInstance(projectId: string, region: string, instance: string, database: string, { ipType, user, password, iamAccountEmail }?: PostgresEngineArgs): Promise<PostgresEngine>;\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 fromPool(engine: knex.Knex): Promise<PostgresEngine>;\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 fromConnectionString(url: string | knex.Knex.StaticConnectionConfig, poolConfig?: knex.Knex.PoolConfig): Promise<PostgresEngine>;\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    initVectorstoreTable(tableName: string, vectorSize: number, { schemaName, contentColumn, embeddingColumn, embeddingColumnType, metadataColumns, metadataJsonColumn, idColumn, overwriteExisting, storeMetadata }?: VectorStoreTableArgs): Promise<void>;\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    initChatHistoryTable(tableName: string, schemaName?: string): Promise<void>;\n    /**\n     *  Dispose of connection pool\n     */\n    closeConnection(): Promise<void>;\n    // Just to test the connection to the database\n    testConnection(): knex.Knex.Raw<any>;\n}\nexport default PostgresEngine;\n"],"mappings":";;;;UAEiBG,kBAAAA;WACJF;EADIE,IAAAA,CAAAA,EAAAA,MAAAA;EAMAC,QAAAA,CAAAA,EAAAA,MAAAA;EAAoB,eAAA,CAAA,EAAA,MAAA;;AAObC,UAPPD,oBAAAA,CAOOC;EAAM,UAAA,CAAA,EAAA,MAAA;EAITA,aAAM,CAAA,EAAA,MAAA;EAqCNC,eAAAA,CAAAA,EAAc,MAAA;EAAA,mBAAA,CAAA,EAAA,QAAA,GAAA,SAAA,GAAA,KAAA,GAAA,WAAA;EAAA,eAEpBC,CAAAA,EA7COF,MA6CPE,EAAAA;EAAI,kBACGP,CAAAA,EAAAA,MAAAA;EAAS,QACSO,CAAAA,EAAAA,MAAAA,GA7ChBF,MA6CgBE;EAAI,iBAYqDC,CAAAA,EAAAA,OAAAA;EAAM,aAAEC,CAAAA,EAAAA,OAAAA;;AAAgBE,cArDpGN,MAAAA,CAqDoGM;EAAe,IAAKR,EAAAA,MAAAA;EAAkB,QAAWG,EAAAA,MAAAA;EAAc,QAAtBM,EAAAA,OAAAA;EAAO,WAOxIL,CAAAA,IAAAA,EAAAA,MAAAA,EAAAA,QAAAA,EAAAA,MAAAA,EAAAA,QAAAA,CAAAA,EAAAA,OAAAA;EAAI,QAAWD,iBAAAA;;;;;;;;;;;;;;;;;;;;AAqCb;;;;;;;;;;;;cA5DdA,cAAAA;;QAEXJ,IAAAA,CAAKK;oBACOP;iCACaE,IAAAA,CAAKK;;;;;;;;;;;;;;;;;MAYqGJ,qBAAqBS,QAAQN;;;;;;;0BAO9IJ,IAAAA,CAAKK,OAAOK,QAAQN;;;;;;;;4CAQFJ,IAAAA,CAAKK,IAAAA,CAAKM,qCAAqCX,IAAAA,CAAKK,IAAAA,CAAKO,aAAaF,QAAQN;;;;;;;;;;;;;;;;;;;;;;;;;;MAgB2FF,uBAAuBQ;;;;;;;gEAO5KA;;;;qBAI3CA;;oBAEDV,IAAAA,CAAKK,IAAAA,CAAKiB"}