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: content/operate/rs/references/rest-api/requests/bdbs/_index.md
+20-2Lines changed: 20 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,12 +38,20 @@ Get all databases in the cluster.
38
38
39
39
### Request {#get-all-request}
40
40
41
-
#### Example HTTP request
41
+
#### Example HTTP requests
42
+
43
+
The following request returns the unique IDs and names of all databases:
42
44
43
45
```sh
44
46
GET /v1/bdbs?fields=uid,name
45
47
```
46
48
49
+
The following request returns all fields for the databases, including configuration fields for modules like search, probabilistic, and timeseries:
50
+
51
+
```sh
52
+
GET /v1/bdbs?extended=true
53
+
```
54
+
47
55
#### Headers
48
56
49
57
| Key | Value |
@@ -56,6 +64,7 @@ GET /v1/bdbs?fields=uid,name
56
64
| Field | Type | Description |
57
65
|-------|------|-------------|
58
66
| fields | string | Comma-separated list of field names to return (by default all fields are returned). (optional) |
67
+
| extended | boolean | If true, includes configuration fields for modules, such as search, timeseries, and probabilistic, in the response. If the `extended` query parameter is not included in the request, module configuration fields do not appear in the response. (optional) |
59
68
60
69
### Response {#get-all-response}
61
70
@@ -128,12 +137,20 @@ Get a single database.
128
137
129
138
### Request {#get-request}
130
139
131
-
#### Example HTTP request
140
+
#### Example HTTP requests
141
+
142
+
The following request returns all fields for the specified database, except for module configuration fields:
132
143
133
144
```sh
134
145
GET /v1/bdbs/1
135
146
```
136
147
148
+
The following request returns all fields for the specified database, including configuration fields for modules like search, probabilistic, and timeseries:
149
+
150
+
```sh
151
+
GET /v1/bdbs/1?extended=true
152
+
```
153
+
137
154
#### Headers
138
155
139
156
| Key | Value |
@@ -154,6 +171,7 @@ GET /v1/bdbs/1
154
171
| Field | Type | Description |
155
172
|-------|------|-------------|
156
173
| fields | string | Comma-separated list of field names to return (by default all fields are returned). (optional) |
174
+
| extended | boolean | If true, includes configuration fields for modules, such as search, timeseries, and probabilistic, in the response. If the `extended` query parameter is not included in the request, module configuration fields do not appear in the response. (optional) |
0 commit comments