Class PostgresEngine

constructor

• new PostgresEngine(key, pool): PostgresEngine

• Parameters

  • key: symbol
  • pool: Knex<any, any[]>

  Returns PostgresEngine

pool

Staticconnector

closeConnection

• closeConnection(): Promise<void>

• Dispose of connection pool

  Returns Promise<void>

initChatHistoryTable

• initChatHistoryTable(tableName, schemaName?): Promise<void>

• Create a Cloud SQL table to store chat history.

  Parameters

  • tableName: string

    Table name to store chat history
  • schemaName: string = "public"

    Schema name to store chat history table

  Returns Promise<void>

initVectorstoreTable

• initVectorstoreTable(tableName, vectorSize, __namedParameters?): Promise<void>

• Create a table for saving of vectors to be used with PostgresVectorStore.

  Parameters

  • tableName: string

    Postgres database table name. Parameter is not escaped. Do not use with end user input.
  • vectorSize: number

    Vector size for the embedding model to be used.
  • __namedParameters: VectorStoreTableArgs = {}

  Returns Promise<void>

testConnection

• testConnection(): Raw<any>

• Returns Raw<any>

StaticfromConnectionString

• fromConnectionString(url, poolConfig?): Promise<PostgresEngine>

• Create a PostgresEngine instance from arguments.

  Parameters

  • url: string | StaticConnectionConfig

    URL use to connect to a database
  • OptionalpoolConfig: PoolConfig

    Optional - Configuration pool to use in the Knex configuration

  Returns Promise<PostgresEngine>

  PostgresEngine instance

StaticfromInstance

• fromInstance(projectId, region, instance, database, __namedParameters?): Promise<PostgresEngine>

• Parameters

  • projectId: string

    Required - GCP Project ID
  • region: string

    Required - Postgres Instance Region
  • instance: string

    Required - Postgres Instance name
  • database: string

    Required - Database name
  • __namedParameters: PostgresEngineArgs = {}

  Returns Promise<PostgresEngine>

  PostgresEngine instance

StaticfromPool

• fromPool(engine): Promise<PostgresEngine>

• Create a PostgresEngine instance from an Knex instance.

  Parameters

  • engine: Knex<any, any[]>

    knex instance

  Returns Promise<PostgresEngine>

  PostgresEngine instance from a knex instance