Class SqlDatabaseChain

Class that represents a SQL database chain in the LangChain framework. It extends the BaseChain class and implements the functionality specific to a SQL database chain.

Security

Security Notice This chain generates SQL queries for the given database. The SQLDatabase class provides a getTableInfo method that can be used to get column information as well as sample data from the table. To mitigate risk of leaking sensitive data, limit permissions to read and scope to the tables that are needed. Optionally, use the includesTables or ignoreTables class parameters to limit which tables can/cannot be accessed.

Link

See https://js.langchain.com/docs/security for more information.

Example

const chain = new SqlDatabaseChain({
  llm: new OpenAI({ temperature: 0 }),
  database: new SqlDatabase({ ...config }),
});

const result = await chain.run("How many tracks are there?");

Hierarchy

Constructors

constructor

Properties

database inputKey llm outputKey prompt returnDirect sqlOutputKey topK memory?

Accessors

inputKeys outputKeys

Methods

apply call invoke prepOutputs run serialize deserialize

Constructors

constructor

Properties

database

database: SqlDatabase

inputKey

inputKey: string = "query"

llm

llm: BaseLanguageModelInterface

outputKey

outputKey: string = "result"

prompt

prompt: any = DEFAULT_SQL_DATABASE_PROMPT

returnDirect

returnDirect: boolean = false

sqlOutputKey

sqlOutputKey: undefined | string = undefined

topK

topK: number = 5

Optional memory

memory?: any

Accessors

inputKeys

outputKeys

Methods

apply

  • Parameters

    • inputs: ChainValues[]
    • Optional config: any[]

    Returns Promise<ChainValues[]>

    ⚠️ Deprecated ⚠️

    Use .batch() instead. Will be removed in 0.2.0.

    This feature is deprecated and will be removed in the future.

    It is not recommended for use.

    Call the chain on all inputs in the list

call

  • Parameters

    • values: any
    • Optional config: any
    • Optional tags: string[]

      Deprecated

    Returns Promise<ChainValues>

    Deprecated

    Use .invoke() instead. Will be removed in 0.2.0.

    Run the core logic of this chain and add to output if desired.

    Wraps _call and handles memory.

invoke

  • Invoke the chain with the provided input and returns the output.

    Parameters

    • input: ChainValues

      Input values for the chain run.

    • Optional config: any

      Optional configuration for the Runnable.

    Returns Promise<ChainValues>

    Promise that resolves with the output of the chain run.

prepOutputs

  • Parameters

    • inputs: Record<string, unknown>
    • outputs: Record<string, unknown>
    • returnOnlyOutputs: boolean = false

    Returns Promise<Record<string, unknown>>

run

  • Parameters

    • input: any
    • Optional config: any

    Returns Promise<string>

    Deprecated

    Use .invoke() instead. Will be removed in 0.2.0.

serialize

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc