Skip to content
This repository was archived by the owner on Mar 12, 2020. It is now read-only.

Commit 868d45a

Browse files
committed
Update README.md
1 parent befe2fa commit 868d45a

File tree

1 file changed

+3
-97
lines changed

1 file changed

+3
-97
lines changed

README.md

Lines changed: 3 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Donate and help SQLTools to become more awesome than ever.
2424
![Formatting SQL Queries](https://github.com/mtxr/SQLTools/raw/images/format_sql.gif?raw=true)
2525
* Threading Support (prevent ST lockups)
2626
* Query timeout (Kill thread if query takes too long)
27-
* Unescape chars for languages (PHP " is replace by ")
27+
* Unescape chars for languages (PHP \" is replace by ")
2828
* Save queries (`CTRL+e, CTRL+q`)
2929
* List and Run saved queries (`CTRL+e, CTRL+a`)
3030
* Remove saved queries (`CTRL+e, CTRL+r`)
@@ -46,101 +46,7 @@ As long SQLTools is not in the Package Control repository yet (pull request alre
4646
6. Select *"SQLTools"*
4747
7. Done!
4848

49-
## Settings
5049

51-
| Option | Description | Type | Default value |
52-
| --- | :--- | --- | --- |
53-
| `unescape_quotes` | Escape chars like \\" and \\' for extension in array | `array` | `[ "php" ]` |
54-
| `cli` | Path to desired command. You can check more on [Path to Cli](#path-to-commands) | `object` | |
55-
| `thread_timeout` | Query execution time in miliseconds before kill. Prevents Sublime Text from lockup while running complex queries | `int` | 5000 |
56-
| `show_result_on_window` | Show query result using a window (true) or a panel (false) | `boolean` | `false` |
57-
| `show_records` | Resultset settings. You can check more on [Show records options](#show-records-options) | `object` | `{"limit": 50}` |
58-
| `format` | SQL formatting settings. You can check more on [SQL Formatting](#sql-formatting) | `object` | `{"limit": 50}` |
50+
## Configuration
5951

60-
### <a id="show-records-options"></a>Show records options
61-
62-
| Option | Description | Type | Default value |
63-
| --- | :--- | --- | --- |
64-
| `limit` | number of rows to show whe using Show Table Records command | `int` | 50 |
65-
66-
67-
### <a id="sql-formatting"></a>SQL Formatting
68-
69-
| Option | Description | Type | Default value |
70-
| --- | :--- | --- | --- |
71-
| `keyword_case` | Changes how keywords are formatted. Allowed values are `"upper"`, `"lower"` and `"capitalize"` and `null` (leaves case intact) | `string` | `"upper"` |
72-
| `identifier_case` | Changes how identifiers are formatted. Allowed values are `"upper"` `"lower"` and `"capitalize"`and `null` (leaves case intact) | `string` | `null` |
73-
| `strip_comments` | Remove comments from file/selection | `boolean` | `false` |
74-
| `indent_tabs` | Use tabs instead of spaces | `boolean` | `false` |
75-
| `indent_width` | Indentation width | `int` | 4 |
76-
| `reindent` | Reindent code if `true` | `boolean` | `true` |
77-
78-
### <a id="path-to-commands"></a>Path to Cli
79-
80-
In case your database command is not in your `PATH` enviroment var, you can set the path here.
81-
82-
| Option | Default value |
83-
| --- | --- |
84-
| `mysql` | `"mysql"` |
85-
| `pgsql` | `"psql"` |
86-
| `oracle` | `"sqlplus"` |
87-
| `vertica` | `"vsql"` |
88-
89-
## Connections
90-
91-
SQLToolConnections.sublime-settings example:
92-
93-
```json
94-
{
95-
"connections": {
96-
"Connection 1": {
97-
"type" : "mysql",
98-
"host" : "127.0.0.1",
99-
"port" : 3306,
100-
"username": "user",
101-
"password": "password",
102-
"database": "dbname",
103-
"encoding": "utf-8"
104-
},
105-
"Connection 2": {
106-
"type" : "pgsql",
107-
"host" : "127.0.0.1",
108-
"port" : 5432,
109-
"username": "anotheruser",
110-
"database": "dbname",
111-
"encoding": "utf-8"
112-
},
113-
"Connection 3": {
114-
"type" : "oracle",
115-
"host" : "127.0.0.1",
116-
"port" : 1522,
117-
"username": "anotheruser",
118-
"password": "password",
119-
"database": "dbname",
120-
"service" : "servicename",
121-
"encoding": "utf-8"
122-
}
123-
},
124-
"default": "Connection 1"
125-
}
126-
```
127-
128-
129-
## Auto Complete
130-
131-
After you select one connection, SQLTools prepare auto completions for you.
132-
133-
PS: For a better experience, add this line to your sublime settings file
134-
135-
1. `CTRL+SHIFT+p`, select "*Preferences: Settings - User*"
136-
2. add this option:
137-
138-
139-
```json
140-
{
141-
"auto_complete_triggers": [
142-
{"selector": "text.html", "characters": "<" },
143-
{"selector": "source.sql", "characters": "."}
144-
]
145-
}
146-
```
52+
Documentation: [http://mtxr.github.io/SQLTools/](http://mtxr.github.io/SQLTools/)

0 commit comments

Comments
 (0)