Class SqlDatabase

Class that represents a SQL database in the LangChain framework.

Security

Security Notice This class 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.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

allTables appDataSource appDataSourceOptions ignoreTables includesTables sampleRowsInTableInfo customDescription?

Methods

getTableInfo run serialize toJSON fromDataSourceParams fromOptionsParams

Constructors

Protected constructor

Properties

allTables

allTables: SqlTable[] = []

appDataSource

appDataSource: DataSource

appDataSourceOptions

appDataSourceOptions: DataSourceOptions

ignoreTables

ignoreTables: string[] = []

includesTables

includesTables: string[] = []

sampleRowsInTableInfo

sampleRowsInTableInfo: number = 3

Optional customDescription

customDescription?: Record<string, string>

Methods

getTableInfo

  • getTableInfo(targetTables?): Promise<string>

  • Get information about specified tables.

    Follows best practices as specified in: Rajkumar et al, 2022 (https://arxiv.org/abs/2204.00498)

    If sample_rows_in_table_info, the specified number of sample rows will be appended to each table description. This can increase performance as demonstrated in the paper.

    Parameters

    • Optional targetTables: string[]

    Returns Promise<string>

run

  • run(command, fetch?): Promise<string>

  • Execute a SQL command and return a string representing the results. If the statement returns rows, a string of the results is returned. If the statement returns no rows, an empty string is returned.

    Parameters

    • command: string
    • fetch: "all" | "one" = "all"

    Returns Promise<string>

serialize

toJSON

Static fromDataSourceParams

Static fromOptionsParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc