Skip to content

Commit 95a9840

Browse files
committed
Update README
1 parent 94f6bb1 commit 95a9840

1 file changed

Lines changed: 37 additions & 1 deletion

File tree

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
11
# sql-autocomplete
2-
Autocomplete recommendations for SQL statements
2+
3+
Generate valid autocomplete suggestions for keywords, tables, or columns.
4+
5+
Supports MySQL, T-SQL (SQL Server), PL/pgSQL (PostgreSQL) and PL/SQL (Oracle) dialects.
6+
7+
## Install
8+
```shell
9+
npm install sql-autocomplete
10+
```
11+
12+
## [Full documentation can be found here](https://modeldba.com/sql-autocomplete/docs/)
13+
14+
## Get Started
15+
16+
```typescript
17+
import { SQLAutocomplete, SQLDialect } from 'sql-autocomplete';
18+
19+
const sqlAutocomplete = new SQLAutocomplete(SQLDialect.MYSQL);
20+
const sql1 = 'SELECT * FR';
21+
const options1 = sqlAutocomplete.autocomplete(sql1);
22+
console.dir(options1);
23+
24+
// [ AutocompleteOption { value: 'FROM', optionType: 'KEYWORD' } ]
25+
26+
const sql2 = 'SELECT * FROM myDatabaseTableNam';
27+
const options2 = sqlAutocomplete.autocomplete(sql2);
28+
console.dir(options2);
29+
30+
// [ AutocompleteOption { value: null, optionType: 'TABLE' } ]
31+
```
32+
33+
## Created By
34+
35+
[![modelDBA logo](https://modeldba.com/sql-autocomplete/modelDBA128x128.png "modelDBA")](https://modeldba.com)
36+
37+
sql-autocomplete is a project created and maintained by [modelDBA](https://modeldba.com), a database IDE for modern developers.
38+
modelDBA lets you visualize SQL as you type and edit tables easily with a no-code table editor.

0 commit comments

Comments
 (0)