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: BaseLanguageModel<any, BaseLanguageModelCallOptions>

outputKey

outputKey: string = "result"

prompt

prompt: PromptTemplate<Object, any> = DEFAULT_SQL_DATABASE_PROMPT

returnDirect

returnDirect: boolean = false

sqlOutputKey

sqlOutputKey: undefined | string = undefined

topK

topK: number = 5

Optional memory

memory?: BaseMemory

Accessors

inputKeys

  • get inputKeys(): string[]

  • Returns string[]

outputKeys

  • get outputKeys(): string[]

  • Returns string[]

Methods

apply

  • Call the chain on all inputs in the list

    Parameters

    • inputs: ChainValues[]
    • Optional config: (BaseCallbackConfig | Callbacks)[]

    Returns Promise<ChainValues[]>

call

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

    Wraps _call and handles memory.

    Parameters

    • values: ChainValues & {
          signal?: AbortSignal;
          timeout?: number;
      }
    • Optional config: BaseCallbackConfig | Callbacks
    • Optional tags: string[]

      Deprecated

    Returns Promise<ChainValues>

invoke

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

    Parameters

    • input: ChainValues

      Input values for the chain run.

    • Optional config: BaseCallbackConfig

      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: BaseCallbackConfig | Callbacks

    Returns Promise<string>

serialize

Static deserialize

  • Load a chain from a json-like object describing it.

    Parameters

    Returns Promise<BaseChain<ChainValues, ChainValues>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc