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

Commit f72af33

Browse files
committed
Updated README.md
1 parent 90eff0d commit f72af33

File tree

1 file changed

+2
-93
lines changed

1 file changed

+2
-93
lines changed

README.md

Lines changed: 2 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -40,98 +40,7 @@ As long SQLTools is not in the Package Control repository yet (pull request alre
4040
6. Select *"SQLTools"*
4141
7. Done!
4242

43-
## Settings
4443

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

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

0 commit comments

Comments
 (0)