Class: SqlDatabaseChain

chains.SqlDatabaseChain

Base interface that all chains must implement.

Hierarchy

• BaseChain

  ↳ SqlDatabaseChain

Constructors

constructor

• new SqlDatabaseChain(fields)

Parameters

Name	Type
fields	Object
fields.database	SqlDatabase
fields.inputKey?	string
fields.llm	BaseLanguageModel
fields.memory?	BaseMemory
fields.outputKey?	string

Overrides

BaseChain.constructor

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:30

Properties

callbackManager

• callbackManager: CallbackManager

Inherited from

BaseChain.callbackManager

Defined in

langchain/src/chains/base.ts:25

---

database

• database: SqlDatabase

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:15

---

inputKey

• inputKey: string = "query"

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:23

---

llm

• llm: BaseLanguageModel

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:12

---

memory

• Optional memory: BaseMemory

Inherited from

BaseChain.memory

Defined in

langchain/src/chains/base.ts:21

---

outputKey

• outputKey: string = "result"

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:25

---

prompt

• prompt: PromptTemplate = DEFAULT_SQL_DATABASE_PROMPT

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:18

---

returnDirect

• returnDirect: boolean = false

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:28

---

topK

• topK: number = 5

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:21

---

verbose

• verbose: boolean

Inherited from

BaseChain.verbose

Defined in

langchain/src/chains/base.ts:23

Accessors

inputKeys

• get inputKeys(): string[]

Returns

string[]

Overrides

BaseChain.inputKeys

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:97

Methods

_call

▸ _call(values): Promise<ChainValues>

Run the core logic of this chain and return the output

Parameters

Name	Type
values	ChainValues

Returns

Promise<ChainValues>

Overrides

BaseChain._call

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:45

---

_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

langchain/src/chains/sql_db/sql_db_chain.ts:93

---

apply

▸ apply(inputs): Promise<ChainValues>

Call the chain on all inputs in the list

Parameters

Name	Type
inputs	ChainValues[]

Returns

Promise<ChainValues>

Inherited from

BaseChain.apply

Defined in

langchain/src/chains/base.ts:109

---

call

▸ call(values): Promise<ChainValues>

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

Wraps _call and handles memory.

Parameters

Name	Type
values	ChainValues

Returns

Promise<ChainValues>

Inherited from

BaseChain.call

Defined in

langchain/src/chains/base.ts:79

---

run

▸ run(input): Promise<string>

Parameters

Name	Type
input	any

Returns

Promise<string>

Inherited from

BaseChain.run

Defined in

langchain/src/chains/base.ts:55

---

serialize

▸ serialize(): SerializedSqlDatabaseChain

Return a json-like object representing this chain.

Returns

SerializedSqlDatabaseChain

Overrides

BaseChain.serialize

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:114

---

deserialize

▸ Static deserialize(data, SqlDatabaseFromOptionsParams): Promise<SqlDatabaseChain>

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

Parameters

Name	Type
data	SerializedSqlDatabaseChain
SqlDatabaseFromOptionsParams	(fields: SqlDatabaseOptionsParams) => Promise<SqlDatabase>

Returns

Promise<SqlDatabaseChain>

Overrides

BaseChain.deserialize

Defined in

langchain/src/chains/sql_db/sql_db_chain.ts:101