Skip to content

Commit 9808d51

Browse files
Update syntax.md
1 parent bddf3b1 commit 9808d51

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/query/syntax.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ This comprehensive guide offers detailed insights into the query syntax, aiming
2626

2727
- **NOTE**: Currently, exporting records is only limited to search operations.
2828

29-
- **File Export**: **FiSE** allows search records export only to the file formats mentioned below under the **Available File Formats** section. To export to a file, the following rules must be followed:
29+
- **File Export**: **FiSE** allows search records export only to the file formats mentioned below under the **Available File Formats** section below. To export to a file, the following rules must be followed:
3030

3131
- The file specified must be non-existant.
32-
- The file name must be followed by a allowed suffix. **FiSE** recognizes the file export type explicitly based on the suffix of the file specified.
32+
- The file name must be followed by a allowed suffix, **FiSE** recognizes the file export type explicitly based on the suffix of the file specified.
3333

3434
- **Available File Formats**: **csv**, **html**, **xlsx** and **json**.
3535
- **Available Databases**: **mysql**, **postgresql** and **sqlite**.
@@ -42,17 +42,17 @@ This comprehensive guide offers detailed insights into the query syntax, aiming
4242

4343
3. **SELECT[ PARAMETERS ]** or **DELETE[ PARAMETERS ]**:
4444

45-
- This segments includes the operations specifications. Users can choose between two different query operations: **Search** and **Delete**.
45+
- This segments includes the operation specifications. Users can choose between two different query operations: **Search** and **Delete**.
4646

47-
- **Additional parameters** can be specified within square brackets `[]` seperated by commas, to toggle operations between different file-types or file-modes, especially for data search operations. Refer to the **Types of Parameters** section below to know more about the different types of parameters available.
47+
- **Additional parameters** can be specified to toggle between different file-types or file-modes, especially for data search operations. These can be defined within square brackets `[]` adjoining the name of the operation where each parameter is seperated by commas. Refer to the **Parameters Types** section below to know more about the different types of parameters available.
4848

49-
- **Types of Parameters**: The following are the different types of parameters which can be defined within the operation specifications:
49+
- **Parameters Types**: The following are the different types of parameters which can be defined within the operation specifications:
5050

51-
- **TYPE**: It is used to toggle between file, directory and data operation. To specify this parameter, use the following format: `TYPE (FILE|DIR|DATA)`. Eg: `TYPE DIR` sets the operation to work with files.
51+
- **TYPE**: It is used to toggle between file, directory and data operation. The type can only be set to `data` for search operation and is not available for delete operations. To specify this parameter, use the following format: `TYPE (FILE|DIR|DATA)`. Eg: `SELECT[TYPE DIR]` configures the operation to work with directories and `DELETE[TYPE FILE]` toggles the operation to work with files.
5252

53-
- **MODE**: It is used to toggle between text and bytes filemode. It is only limited to data search operations. To specify this parameter, use the following format: `MODE (TEXT|BYTES)`. Eg: `MODE BYTES` sets the operation to work with bytes data.
53+
- **MODE**: It is used to toggle between text and bytes filemode. It is only limited to data search operations. To specify this parameter, use the following format: `MODE (TEXT|BYTES)`. Eg: `SELECT[TYPE DATA, MODE BYTES]` toggles the operation to work with bytes data and `SELECT[TYPE DATA, MODE TEXT]` configures the operation to work with text data.
5454

55-
- **NOTE**: By default, the `TYPE` parameter is set to `file` and the `MODE` is set to `text` for data search operation and do not require explicit mentionings.
55+
- **NOTE**: By default, the `TYPE` parameter is set to `file` and the `MODE` is set to `text` for data search operation and do not require explicit mentionings. Users must also note that the `text` filemode can only read text files and will raise an error for bytes data.
5656

5757
- Operation specifications examples with different parameters:
5858

@@ -71,21 +71,21 @@ This comprehensive guide offers detailed insights into the query syntax, aiming
7171

7272
5. **ABSOLUTE** or **RELATIVE**:
7373

74-
- This segment is **optional** and specifies whether to include the absolute path of the files and directories if the specified path is relative.
74+
- This segment is optional and specifies whether to include the absolute path of the files and directories if the specified path is relative.
7575

7676
6. **FILE PATH** or **DIRECTORY PATH**:
7777

7878
- Defines the path to the file or directory to operate upon. The path can be either absolute or relative as desired and can be specified directly without any other specifications.
7979

80-
- **Note**: A File can only be specified as a target if the query is related to a data search or delete operation.
80+
- **Note**: Paths comprising whitespaces must be enclosed within single quotes `'` or double quotes `"`.
8181

82-
- **Example**: `./src` or `/use/local/bin`
82+
- **Example**: `./src`, `/usr/local/bin` and `"C:/Program Files/Common Files"`
8383

8484
7. **WHERE CONDITIONS**:
8585

86-
- This segment is **optional** and is used for filtering search/delete records based on the specified conditions.
86+
- This segment is optional and is used for filtering search and delete records based on the specified conditions.
8787

88-
- For a deeper insight about query conditions, please refer to the [Query-Conditions](./query-conditions.md) guide.
88+
- For a deeper insight into query conditions, please refer to the [Query-Conditions](./query-conditions.md) guide.
8989

9090
<h2 align=center>Next Steps</h2>
9191

0 commit comments

Comments
 (0)