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 (View Summary)

BaseChain
- SqlDatabaseChain

Index

Constructors

constructor

new SqlDatabaseChain(fields: SqlDatabaseChainInput): SqlDatabaseChain
Parameters
- fields: SqlDatabaseChainInput
Returns SqlDatabaseChain
Overrides BaseChain.constructor
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/sql_db/sql_db_chain.ts:94

Properties

database

database: SqlDatabase

inputKey

inputKey: string = "query"

llm

llm: BaseLanguageModelInterface

`Optional`memory

memory?: any

outputKey

outputKey: string = "result"

prompt

prompt: any = DEFAULT_SQL_DATABASE_PROMPT

returnDirect

returnDirect: boolean = false

sqlOutputKey

sqlOutputKey: undefined | string = undefined

topK

topK: number = 5

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides BaseChain.inputKeys
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/sql_db/sql_db_chain.ts:173

lc_namespace

get lc_namespace(): string[]
Returns string[]
Inherited from BaseChain.lc_namespace
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:41

outputKeys

get outputKeys(): string[]
Returns string[]
Overrides BaseChain.outputKeys
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/sql_db/sql_db_chain.ts:177

Methods

_chainType

_chainType(): "sql_database_chain"
Return the string type key uniquely identifying this class of chain.

Returns "sql_database_chain"
Overrides BaseChain._chainType
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/sql_db/sql_db_chain.ts:169

`Protected`_formatValues

_formatValues(values: any): Promise<any>
Parameters
- values: any
Returns Promise<any>
Inherited from BaseChain._formatValues
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:217

apply

apply(inputs: ChainValues[], config?: any[]): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optionalconfig: any[]
Returns Promise<ChainValues[]>
Deprecated
Use .batch() instead. Will be removed in 0.2.0.

Call the chain on all inputs in the list
Inherited from BaseChain.apply
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:258

call

call(values: any, config?: any, tags?: string[]): Promise<ChainValues>
Parameters
- values: any
- Optionalconfig: any
- Optionaltags: 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.
Inherited from BaseChain.call
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:243

invoke

invoke(input: ChainValues, options?: any): Promise<ChainValues>
Invoke the chain with the provided input and returns the output.
Parameters
- input: ChainValues
  Input values for the chain run.
- Optionaloptions: any
Returns Promise<ChainValues>
Promise that resolves with the output of the chain run.
Inherited from BaseChain.invoke
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:86

prepOutputs

prepOutputs(
    inputs: Record<string, unknown>,
    outputs: Record<string, unknown>,
    returnOnlyOutputs?: boolean,
): Promise<Record<string, unknown>>
Parameters
- inputs: Record<string, unknown>
- outputs: Record<string, unknown>
- returnOnlyOutputs: boolean = false
Returns Promise<Record<string, unknown>>
Inherited from BaseChain.prepOutputs
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:149

run

run(input: any, config?: any): Promise<string>
Parameters
- input: any
- Optionalconfig: any
Returns Promise<string>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from BaseChain.run
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:190

serialize

serialize(): SerializedBaseChain
Return a json-like object representing this chain.

Returns SerializedBaseChain
Inherited from BaseChain.serialize
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:181

`Static`deserialize

deserialize(
data: SerializedBaseChain,
values?: LoadValues,
): Promise<BaseChain<ChainValues, ChainValues>>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedBaseChain
- values: LoadValues = {}
Returns Promise<BaseChain<ChainValues, ChainValues>>
Inherited from BaseChain.deserialize
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/base.ts:270

`Static`lc_name

lc_name(): string
Returns string
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/sql_db/sql_db_chain.ts:69

Class SqlDatabaseChain

Security

Link

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SqlDatabaseChain

Properties

database

inputKey

llm

Optionalmemory

outputKey

prompt

returnDirect

sqlOutputKey

topK

Accessors

inputKeys

Returns string[]

lc_namespace

Returns string[]

outputKeys

Returns string[]

Methods

_chainType

Returns "sql_database_chain"

Protected_formatValues

Parameters

Returns Promise<any>

apply

Parameters

Returns Promise<ChainValues[]>

Deprecated

call

Parameters

Deprecated

Returns Promise<ChainValues>

Deprecated

invoke

Parameters

Returns Promise<ChainValues>

prepOutputs

Parameters

Returns Promise<Record<string, unknown>>

run

Parameters

Returns Promise<string>

Deprecated

serialize

Returns SerializedBaseChain

Staticdeserialize

Parameters

Returns Promise<BaseChain<ChainValues, ChainValues>>

Staticlc_name

Returns string

Settings

On This Page

`Optional`memory

`Protected`_formatValues

`Static`deserialize

`Static`lc_name