Skip to content

Commit 6d54a94

Browse files
committed
Update README.md
1 parent a0c1fc2 commit 6d54a94

File tree

1 file changed

+40
-2
lines changed

1 file changed

+40
-2
lines changed

docs/README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Free MongoDB GUI powered by PHP
22

33
Visually administrate your MongoDB database. Create, read, update & delete your documents.<br>
4-
Query your Mongo database with SELECT SQL statements. You can also create & drop indexes.<br>
4+
Query your MongoDB database with a [relax JSON syntax](#relaxed-json), regular expressions & SQL statements.<br>
55
Autocompletion is available for collection fields, MongoDB & SQL keywords via [key shortcuts](#key-shortcuts).<br>
6-
Additional features: Export documents to JSON. Import documents from JSON. Manage users.
6+
Export documents to JSON. Import documents from JSON. Manage indexes. Manage users, etc.
77

88
## Screenshots
99

@@ -30,9 +30,47 @@ Additional features: Export documents to JSON. Import documents from JSON. Manag
3030

3131
## Usage
3232

33+
### Query Syntax
34+
35+
#### Relaxed JSON
36+
37+
MongoDB PHP GUI supports a relaxed JSON syntax. In practice, this query:
38+
39+
```js
40+
city: New York
41+
```
42+
43+
Will produce same result that:
44+
45+
```js
46+
{ "city": "New York" }
47+
```
48+
49+
#### Regular Expressions
50+
51+
Imagine you want to find all the US cities starting with "San An". This query:
52+
53+
```js
54+
city: /^San An/
55+
```
56+
57+
Will output:
58+
- San Antonio (FL)
59+
- San Angelo (TX)
60+
- ...
61+
62+
#### SQL Statements
63+
64+
If Java JDK is installed, you can query MongoDB with SQL statements such as:
65+
66+
```sql
67+
SELECT * FROM Cities WHERE state = "CA"
68+
```
69+
3370
### Key Shortcuts
3471

3572
<kbd>Ctrl + Space</kbd> Autocomplete the query<br>
73+
<kbd>Ctrl + *</kbd> Count doc(s) matching the query<br>
3674
<kbd>Ctrl + Enter</kbd> Find doc(s) matching the query
3775

3876
## Credits

0 commit comments

Comments
 (0)