All Settings

Settings

sqltools.autoConnectTostring | string[]

Name(s) of the connection(s) to auto connect on start.

Type	`string or string[]`
Default Value	`[]`

sqltools.autoOpenSessionFilesboolean

Auto open session file when connecting.

Type	`boolean`
Default Value	`true`

sqltools.codelensLanguagesstring[]

Languages that SQLTools will add CodeLenses to.

You can use any language identifier, including those listed at https://code.visualstudio.com/docs/languages/identifiers.

More info about codelens, see https://vscode-sqltools.mteixeira.dev/features/codelens

Type	`string[]`
Default Value	`["sql"]`

sqltools.completionLanguagesstring[]

Languages with SQL completion enabled. Restart to activate changes.

You can use any language identifier, including those listed at https://code.visualstudio.com/docs/languages/identifiers.

Type	`string[]`
Default Value	`["sql"]`

sqltools.connectionExplorer.groupConnectedboolean

Display connections in two groups, 'Connected' and 'Not Connected'.

Type	`boolean`
Default Value	`false`

sqltools.connectionsobject[]

Connections list.

Type	`object[]`
Default Value	`[]`

Object Properties

Property	Description	Type
name	Connection name.	`string`
group	Connection group name.	`string`
server	Server address.	`string`
port	Port for connection.	`number`
socketPath	Path of socket file to connect using UNIX sockets. MySQL only for now.	`string`
database	Database name.	`string`
domain	Connection domain (for MSSQL/Azure only).	`string or null`
username	Connection username.	`string`
password	Connection password	`string or null`
askForPassword	Ask for password at connection time instead of storing it as plaintext in your settings.	`boolean`
driver	Connection driver used for this connection.	`string`
dialect	Connection Driver	`string`
connectString	Connect string. Support for Oracle, PostgreSQL and AWS Redshift.	`string or null`
mssqlOptions	See https://vscode-sqltools.mteixeira.dev/en/drivers/microsoft-sql-server-azure#11-specific-options for more details.	`null or object`
mysqlOptions	See https://vscode-sqltools.mteixeira.dev/en/drivers/my-sql#2-mysqloptions for more details.	`object or null`
pgOptions	See https://vscode-sqltools.mteixeira.dev/en/drivers/postgre-sql#11-specific-options for more details.	`object or null`
oracleOptions	See https://node-oracledb.readthedocs.io/en/latest/api_manual/oracledb.html#createpoolparams for more details.	`object or null`
cqlOptions	See https://docs.datastax.com/en/developer/nodejs-driver/4.1/api/type.ClientOptions/ for more details.	`object or null`
connectionTimeout	Connection timeout in seconds.	`number`
previewLimit	Maximum number of records to return in table previews.	`number`
icons	Define an icon for this connection. If not specified, use defaults.	`object or null`
variables	Connection variables in a key/value pair format. Use this property with `sqltools.queryParams.enableReplace` to replace the variables without prompting.	`object or null`

sqltools.csvExport.delimiterstring

CSV field delimiter, one character only.

Type	`string`
Default Value	`,`

Display the column names on the first line.

Type	`boolean`
Default Value	`true`

sqltools.csvExport.quotestring

The quote characters, an empty value will preserve the original field.

Type	`string`
Default Value	`"`

sqltools.csvExport.quotedboolean

Quote all the non-empty fields even if not required.

Type	`boolean`
Default Value	`false`

sqltools.csvExport.quoted_emptyboolean

Quote empty fields and overrides #sqltools.csvExport.quoted_string# on empty strings when defined.

Type	`boolean`
Default Value	`true`

sqltools.csvExport.quoted_stringboolean

Quote all fields of type string even if not required.

Type	`boolean`
Default Value	`true`

sqltools.csvExport.record_delimiterstring

String used to delimit record rows or a special value: unix (\n), mac (\r), windows (\r\n), ascii (\u001e), or unicode (\u2028).

Type	`string`
Default Value	`unix`

sqltools.defaultExportTypestring

Default mode for results Export command.

Type	`string`
Default Value	`prompt`

sqltools.defaultOpenTypestring

Default mode for results Open command.

Type	`string`
Default Value	`prompt`

sqltools.dependencyManagerobject

Dependency Manager settings.

Type	`object`
Default Value	`{"packageManager":"npm","installArgs":["install"],"runScriptArgs":["run"],"autoAccept":false}`

Object Properties

Property	Description	Type
packageManager	Package manager name or path. For example `yarn`, `npm` or absolute paths like `/usr/bin/npm`.	`string`
installArgs	Array of args passed when installing. If you use `yarn` this shoud be set to `["add"]`.	`any[]`
runScriptArgs	Array of args passed when runnning npm scripts.	`any[]`
autoAccept	Skip confirmation requests when installing or upgrading dependencies.	`boolean`

sqltools.disableChordKeybindingsboolean

SQLTools' default chord keybindings begin with Ctrl/Cmd+E and therefore mask the default keybinding of VS Code's Go to File... command. When this setting is disabled (the default) you can instead invoke that command with the chord Ctrl/Cmd+E Ctrl/Cmd+E. Enable this setting if you don't require SQLTools' chord keybindings.

Type	`boolean`
Default Value	`false`

sqltools.disableNodeDetectNotificationsboolean

Disable node runtime detection notifications.

Type	`boolean`
Default Value	`false`

sqltools.disableReleaseNotificationsboolean

Disable new release notifications.

Type	`boolean`
Default Value	`false`

sqltools.flattenGroupsIfOneboolean

Flatten groups that have only one child.

Type	`boolean`
Default Value	`false`

sqltools.formatobject

Type object

Object Properties

Property	Description	Type
reservedWordCase	Reserved word case.	`string or null` upper: Convert to UPPERCASE. lower: Convert to lowercase. null: Do not change.
language	Language of formatting.	`string` sql db2 n1ql pl/sql
linesBetweenQueries	Adjust spacing between queries.	`string or number` preserve: Leave unchanged. 1: 1 linebreak. 2: 2 linebreaks. 3: 3 linebreaks. 4: 4 linebreaks. 5: 5 linebreaks.

sqltools.formatLanguagesstring[]

Languages with SQL formatting enabled. Restart to activate changes.

You can use any language identifier, including those listed at https://code.visualstudio.com/docs/languages/identifiers.

Type	`string[]`
Default Value	`["sql"]`

sqltools.highlightQueryboolean

Highlight the query at the cursor position.

Type	`boolean`
Default Value	`true`

sqltools.historySizenumber

Number of queries to keep in History.

Type	`number`
Default Value	`100`

sqltools.languageServerEnvobject

Set environment variables to be passed to language server. For example ORACLE_HOME, PATH...

Restart to activate changes.

Type	`object`
Default Value	`{}`

sqltools.queryParams.enableReplaceboolean

Enables query parameter checking.

Type	`boolean`
Default Value	`false`

sqltools.queryParams.regexstring

RegEx used to identify query parameters.

Type	`string`
Default Value	`\$[\d]+\|\$\[([\d\w]+)\]`

sqltools.results.customizationobject

Properties that customize the appearance of results tables.

Type	`object`
Default Value	`{}`

Object Properties

Property	Description	Type
font-family		`string`
font-size		`string`
table-cell-padding		`string`

sqltools.results.limitnumber

Maximum number of records to return in results.

Type	`number`
Default Value	`50`

sqltools.results.locationstring

Define which edit group the results tab should appear in. Empty groups are never created. For example, if setting is 4 but only one group currently exists then the first set of results will create a new group 2, the second a group 3 and the third and subsequent sets of results will appear in group 4.

Type	`string`
Default Value	`next`

sqltools.results.reuseTabsstring

How requests reuse results tabs.

Type	`string`
Default Value	`never`

sqltools.results.showConsoleOnErrorboolean

Show SQL Console view automatically when an error has occurred.

Type	`boolean`
Default Value	`true`

sqltools.sessionFilesFolderstring

Folder for session files to be saved in.

Type	`string`
Default Value

sqltools.showStatusbarboolean

Toggle statusbar item visibility.

Type	`boolean`
Default Value	`true`

sqltools.sortColumnsnull | string

Sort columns criteria.

Type	`null or string`
Default Value	`name`

sqltools.tableTreeItemsExpandedboolean

Table columns should be expanded on load?

Type	`boolean`
Default Value	`false`

sqltools.useNodeRuntimenull | boolean | string

Enable node runtime usage.

Type	`null, boolean or string`
Default Value	`false`