Symbol

SQL.file

file(filename: string, values?: any[]): SQLQuery

Reads a file and uses the contents as a query. Optional parameters can be used if the file includes $1, $2, etc

const result = await sql.file("query.sql", [1, 2, 3]);

Referenced types

interface SQLQuery

Represents a SQL query that can be executed, with additional control methods Extends Promise to allow for async/await usage

readonly [Symbol.toStringTag]: string
active: boolean
Indicates if the query is currently executing
cancelled: boolean
Indicates if the query has been cancelled
cancel(): SQLQuery
Cancels the executing query
catch<TResult = never>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<any>
Attaches a callback for only the rejection of the Promise.
@param onrejected
The callback to execute when the Promise is rejected.
@returns
A Promise for the completion of the callback.
execute(): SQLQuery
Executes the query
finally(onfinally?: null | () => void): Promise<any>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
@param onfinally
The callback to execute when the Promise is settled (fulfilled or rejected).
@returns
A Promise for the completion of the callback.
raw(): SQLQuery
Returns the raw query result
simple(): SQLQuery
Execute as a simple query, no parameters are allowed but can execute multiple commands separated by semicolons
then<TResult1 = any, TResult2 = never>(onfulfilled?: null | (value: any) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
@param onfulfilled
The callback to execute when the Promise is resolved.
@param onrejected
The callback to execute when the Promise is rejected.
@returns
A Promise for the completion of which ever callback is executed.
values(): SQLQuery
Returns only the values from the query result