You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/apis/DataAPI/ConfigFile.md
+16-17Lines changed: 16 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Therefore, the content and format of the configuration file generally need to be
13
13
LLSE provides the ConfigFile configuration file interface to accomplish this task.
14
14
Of course, you can also manually read and write files to assist in the operation of related configuration files.
15
15
16
-
<br>
16
+
17
17
18
18
### Description: Selection of Configuration File Type
19
19
@@ -24,7 +24,7 @@ The choice of configuration file format will affect the type of configuration da
24
24
25
25
Please make your choice as needed.
26
26
27
-
<br>
27
+
28
28
29
29
### 📰 JSON Format Configuration File
30
30
@@ -47,7 +47,7 @@ Please make your choice as needed.
47
47
48
48
We recommend that you create a directory named `BDS_Root_Directory/plugins/plugin_name/` with a config file named `config.json` to keep the configuration of each plugin uniform.
49
49
50
-
<br>
50
+
51
51
52
52
For a JSON profile object `conf`, you have these read and write interfaces available.
53
53
@@ -67,7 +67,7 @@ Here is an easy way to initialize the configuration file, avoiding the trouble o
67
67
68
68
If the accessed configuration item does not exist, then the engine will automatically create the item `init` in the configuration file and write the given default value.
69
69
If the accessed configuration item `init` already exists, the engine will read and return the existing value in the configuration file.
70
-
<br>
70
+
71
71
72
72
#### Write Configuration Item
73
73
@@ -85,7 +85,7 @@ If the accessed configuration item `init` already exists, the engine will read a
85
85
86
86
- Return value type: `Boolean`
87
87
88
-
<br>
88
+
89
89
90
90
#### Read Configuration Items
91
91
@@ -100,7 +100,7 @@ If the accessed configuration item `init` already exists, the engine will read a
100
100
- Return value: The data of the specified configuration item.
101
101
- Return value type: `Any type`, subject to the specific type of data stored.
102
102
103
-
<br>
103
+
104
104
105
105
#### Delete Configuration Item
106
106
@@ -114,7 +114,7 @@ If the accessed configuration item `init` already exists, the engine will read a
114
114
115
115
If you don't need this configuration item, in order to avoid confusion when others modify the configuration file, you can choose to delete it.
116
116
117
-
<br>
117
+
118
118
119
119
### 📄 Ini Format Configuration File
120
120
@@ -137,7 +137,7 @@ If you don't need this configuration item, in order to avoid confusion when othe
137
137
138
138
We recommend that you create a directory named `BDS_Root_Directory/plugins/plugin_name/` with a config file named `config.json` to keep the configuration of each plugin uniform.
139
139
140
-
<br>
140
+
141
141
142
142
For an ini profile object `conf`, you have these read and write interfaces available:
143
143
@@ -161,7 +161,7 @@ Here is an easy way to initialize the configuration file, avoiding the trouble o
161
161
If the accessed configuration item does not exist, then the engine will automatically create the item `init` in the configuration file and write the given default value.
162
162
If the accessed configuration item `init` already exists, the engine will read and return the existing value in the configuration file.
163
163
164
-
<br>
164
+
165
165
166
166
#### Write Configuration Item
167
167
@@ -182,7 +182,7 @@ If the accessed configuration item `init` already exists, the engine will read a
182
182
183
183
If the configuration item does not exist, the interface will be created automatically.
If you don't need this configuration item, in order to avoid confusion when others modify the configuration file, you can choose to delete it.
220
220
221
-
<br>
221
+
222
222
223
223
### 💼 Other Common Interface Functions
224
224
@@ -232,7 +232,7 @@ For a profile object `conf`, you can use these generic interfaces for auxiliary
232
232
233
233
For performance reasons, the configuration file interface caches read operations, each read operation is read from direct memory, and writes are written directly to disk files. Considering that the configuration file may be modified by the user, after you confirm that the user has modified the configuration file, you need to use this function to refresh the memory cache data of the configuration file.
234
234
235
-
<br>
235
+
236
236
237
237
#### Close Config File
238
238
@@ -242,7 +242,7 @@ For performance reasons, the configuration file interface caches read operations
242
242
243
243
After the profile is closed, do not continue to use it!
244
244
245
-
<br>
245
+
246
246
247
247
#### Get Configuration File Path
248
248
@@ -251,7 +251,7 @@ After the profile is closed, do not continue to use it!
251
251
- Return value: The file path of the current configuration file.
252
252
- Return value type: `String`
253
253
254
-
<br>
254
+
255
255
256
256
#### Read the Content of the Entire Configuration File
257
257
@@ -260,7 +260,7 @@ After the profile is closed, do not continue to use it!
260
260
- Return value: All contents of the current configuration file.
261
261
- Return value type: `String`
262
262
263
-
<br>
263
+
264
264
265
265
#### Write the Contents of the Entire Configuration File
266
266
@@ -272,4 +272,3 @@ After the profile is closed, do not continue to use it!
Copy file name to clipboardExpand all lines: docs/apis/DataAPI/DataBase.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ Unlike configuration files, databases generally have no readability requirements
5
5
LLSE provides a consolidated database interface to accomplish this task.
6
6
In terms of specific implementation, the engine provides two different database formats: NoSQL database in key-value pair format, and SQL database in tabular format. You can use either as needed.
7
7
8
-
<br>
8
+
9
9
10
10
### 🔑 Key-Value NoSQL Database
11
11
@@ -33,7 +33,7 @@ When the given directory does not exist, it will try to automatically create the
33
33
After successfully opening the database, you can use the following interfaces to perform related operations.
34
34
For a database object `db`, with the following functions:
35
35
36
-
<br>
36
+
37
37
38
38
#### Write Data Item
39
39
@@ -49,7 +49,7 @@ For a database object `db`, with the following functions:
49
49
- Return value: Whether the write is successful.
50
50
- Return value type: `Boolean`
51
51
52
-
<br>
52
+
53
53
54
54
#### Read Data Item
55
55
@@ -62,7 +62,7 @@ For a database object `db`, with the following functions:
62
62
- Return value type: `Any type`, depending on the specific type of data stored.
63
63
- If the return value is `Null` it means that the data does not exist.
64
64
65
-
<br>
65
+
66
66
67
67
#### Delete Data Item
68
68
@@ -74,7 +74,7 @@ For a database object `db`, with the following functions:
74
74
- Return value: Whether the deletion was successfu.
75
75
- Return value type: `Boolean`
76
76
77
-
<br>
77
+
78
78
79
79
#### Get All Data Item Names
80
80
@@ -83,7 +83,7 @@ For a database object `db`, with the following functions:
83
83
- Return value: An array of all data item names.
84
84
- Return value type: `Array`
85
85
86
-
<br>
86
+
87
87
88
88
#### Close the Database
89
89
@@ -94,12 +94,12 @@ For a database object `db`, with the following functions:
94
94
95
95
After the database is closed, do not continue to use it!
96
96
97
-
<br>
97
+
98
98
99
99
------
100
100
101
101
### 📋 SQL Database
102
102
103
103
SQL databases are suitable for processing large amounts of relational data using SQL statements. The bottom layer of the interface is implemented using a cross-database operation framework, which can connect to most of the commonly used SQL databases in the market.
0 commit comments