vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

DDS API DOC

Browse Source 
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
This commit is contained in:
zhangyue 2023-09-19 08:15:02 +00:00 committed by zuul
parent b33a41468c
commit fa66099c04
12 changed files with 205 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/dds/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

62
docs/dds/api-ref/CLASS.TXT.json
View File

File diff suppressed because it is too large Load Diff

8
docs/dds/api-ref/dds_api_0020.html
View File

@ -228,7 +228,7 @@
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0020__p172142024165814">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p68674213317">Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be <strong id="dds_api_0020__b07792501842">4.2, 4.0,</strong> <strong id="dds_api_0020__b638841714576">3.4</strong> or <strong id="dds_api_0020__b14901353745">3.2</strong>.</p>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p68674213317">Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be <strong id="dds_api_0020__b07792501842">4.4, 4.2, 4.0,</strong> <strong id="dds_api_0020__b638841714576">3.4</strong> or <strong id="dds_api_0020__b14901353745">3.2</strong>.</p>
</td>
</tr>
<tr id="dds_api_0020__row260045131753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0020__p152141624175815">storage_engine</p>
@ -238,7 +238,7 @@
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0020__p1521452419586">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p1072024123815">Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.</p>
<ul id="dds_api_0020__ul915212153019"><li id="dds_api_0020__li4152029306">If the database version is 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0020__b18610160885">rocksDB</strong>.</li><li id="dds_api_0020__li1916224015329">If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is <strong id="dds_api_0020__b175816920818">wiredTiger</strong>.</li></ul>
<ul id="dds_api_0020__ul915212153019"><li id="dds_api_0020__li4152029306">If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0020__b18610160885">rocksDB</strong>.</li><li id="dds_api_0020__li1916224015329">If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is <strong id="dds_api_0020__b175816920818">wiredTiger</strong>.</li></ul>
</td>
</tr>
</tbody>
@ -718,7 +718,7 @@ Create a cluster instance:
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0020__dds_api_0020_p172142024165814">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p68674213317">Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be <strong id="dds_api_0020__dds_api_0020_b07792501842">4.2, 4.0,</strong> <strong id="dds_api_0020__dds_api_0020_b638841714576">3.4</strong> or <strong id="dds_api_0020__dds_api_0020_b14901353745">3.2</strong>.</p>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p68674213317">Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be <strong id="dds_api_0020__dds_api_0020_b07792501842">4.4, 4.2, 4.0,</strong> <strong id="dds_api_0020__dds_api_0020_b638841714576">3.4</strong> or <strong id="dds_api_0020__dds_api_0020_b14901353745">3.2</strong>.</p>
</td>
</tr>
<tr id="dds_api_0020__dds_api_0020_row260045131753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0020__dds_api_0020_p152141624175815">storage_engine</p>
@ -728,7 +728,7 @@ Create a cluster instance:
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0020__dds_api_0020_p1521452419586">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p1072024123815">Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.</p>
<ul id="dds_api_0020__dds_api_0020_ul915212153019"><li id="dds_api_0020__dds_api_0020_li4152029306">If the database version is 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0020__dds_api_0020_b18610160885">rocksDB</strong>.</li><li id="dds_api_0020__dds_api_0020_li1916224015329">If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is <strong id="dds_api_0020__dds_api_0020_b175816920818">wiredTiger</strong>.</li></ul>
<ul id="dds_api_0020__dds_api_0020_ul915212153019"><li id="dds_api_0020__dds_api_0020_li4152029306">If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0020__dds_api_0020_b18610160885">rocksDB</strong>.</li><li id="dds_api_0020__dds_api_0020_li1916224015329">If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is <strong id="dds_api_0020__dds_api_0020_b175816920818">wiredTiger</strong>.</li></ul>
</td>
</tr>
</tbody>

2
docs/dds/api-ref/dds_api_0029.html
View File

@ -231,7 +231,7 @@
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0029__p1656114951410">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0029__p125691591144">Indicates the database of version 3.2, 3.4, 4.0, or 4.2. The value is <strong id="dds_api_0029__b9538133931012">3.2</strong>, <strong id="dds_api_0029__b023384751015">3.4</strong>, <strong id="dds_api_0029__b4673163032710">4.0</strong>, or <strong id="dds_api_0029__b12233124771012">4.2</strong>.</p>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0029__p125691591144">Indicates the database of version 3.2, 3.4, 4.0, 4.2, or 4.4. The value is <strong id="dds_api_0029__b9538133931012">3.2</strong>, <strong id="dds_api_0029__b023384751015">3.4</strong>, <strong id="dds_api_0029__b4673163032710">4.0</strong>, <strong id="dds_api_0029__b996614223148">4.2</strong>, or <strong id="dds_api_0029__b12233124771012">4.4</strong>.</p>
</td>
</tr>
</tbody>

4
docs/dds/api-ref/dds_api_0038.html
View File

@ -584,7 +584,7 @@
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.5.2.1.2.2.5.1.3 "><p id="dds_api_0038__p172142024165814">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.5.2.1.2.2.5.1.4 "><p id="dds_api_0038__p68674213317">Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be <strong id="dds_api_0038__b07792501842">4.2, 4.0,</strong> <strong id="dds_api_0038__b638841714576">3.4</strong> or <strong id="dds_api_0038__b14901353745">3.2</strong>.</p>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.5.2.1.2.2.5.1.4 "><p id="dds_api_0038__p68674213317">Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be <strong id="dds_api_0038__b07792501842">4.4, 4.2, 4.0,</strong> <strong id="dds_api_0038__b638841714576">3.4</strong> or <strong id="dds_api_0038__b14901353745">3.2</strong>.</p>
</td>
</tr>
<tr id="dds_api_0038__row260045131753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.5.2.1.2.2.5.1.1 "><p id="dds_api_0038__p152141624175815">storage_engine</p>
@ -594,7 +594,7 @@
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.5.2.1.2.2.5.1.3 "><p id="dds_api_0038__p1521452419586">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.5.2.1.2.2.5.1.4 "><p id="dds_api_0038__p1072024123815">Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.</p>
<ul id="dds_api_0038__ul915212153019"><li id="dds_api_0038__li4152029306">If the database version is 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0038__b18610160885">rocksDB</strong>.</li><li id="dds_api_0038__li1916224015329">If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is <strong id="dds_api_0038__b175816920818">wiredTiger</strong>.</li></ul>
<ul id="dds_api_0038__ul915212153019"><li id="dds_api_0038__li4152029306">If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0038__b18610160885">rocksDB</strong>.</li><li id="dds_api_0038__li1916224015329">If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is <strong id="dds_api_0038__b175816920818">wiredTiger</strong>.</li></ul>
</td>
</tr>
</tbody>

15
docs/dds/api-ref/dds_api_0070.html Normal file
View File

@ -0,0 +1,15 @@
<a name="dds_api_0070"></a><a name="dds_api_0070"></a>
<h1 class="topictitle1">Managing Databases and Users</h1>
<div id="body1606734638720"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dds_api_0075.html">Changing the Password of a Database User</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_api_description.html">APIs V3.0 (Recommended)</a></div>
</div>
</div>

101
docs/dds/api-ref/dds_api_0075.html Normal file
View File

File diff suppressed because it is too large Load Diff

2
docs/dds/api-ref/dds_api_description.html
View File

@ -22,6 +22,8 @@
</li>
<li class="ulchildlink"><strong><a href="dds_tag_mgmt.html">Tag Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dds_api_0070.html">Managing Databases and Users</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dds_api_0117.html">Task Management</a></strong><br>
</li>
</ul>

2
docs/dds/api-ref/dds_connect_0002.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying Sessions of an Instance Node</h1>
<div id="body0000001127512309"><div class="section" id="dds_connect_0002__section19379596234"><h4 class="sectiontitle">Function</h4><p id="dds_connect_0002__p131541003243">This API is used to query sessions of instance nodes.</p>
</div>
<div class="section" id="dds_connect_0002__section193915915231"><h4 class="sectiontitle">Constraints</h4><p id="dds_connect_0002__p1349143112911">Community Edition 3.4, 4.0 and 4.2 instances are supported.</p>
<div class="section" id="dds_connect_0002__section193915915231"><h4 class="sectiontitle">Constraints</h4><p id="dds_connect_0002__p1349143112911">Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.</p>
</div>
<div class="section" id="dds_connect_0002__section1794313599231"><h4 class="sectiontitle">URI</h4><ul id="dds_connect_0002__ul554735718539"><li id="dds_connect_0002__li915620217316">URI format<p id="dds_connect_0002__p912862005412"><a name="dds_connect_0002__li915620217316"></a><a name="li915620217316"></a>GET https://{Endpoint}/v3/{project_id}/nodes/{node_id}/sessions?offset={offset}&amp;limit={limit}&amp;plan_summary={plan_summary}&amp;type={type}&amp;namespace={namespace}&amp;cost_time={cost_time}</p>
</li><li id="dds_connect_0002__li13262203310313">Parameter description

2
docs/dds/api-ref/dds_connect_0003.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Killing Sessions of an Instance Node</h1>
<div id="body0000001080874504"><div class="section" id="dds_connect_0003__section276112532416"><h4 class="sectiontitle">Function</h4><p id="dds_connect_0003__p14126162512243">This API is used to kill sessions of an instance node.</p>
</div>
<div class="section" id="dds_connect_0003__section07615256244"><h4 class="sectiontitle">Constraints</h4><ul id="dds_connect_0003__ul812632512245"><li id="dds_connect_0003__li1126325122416">Community Edition 3.4, 4.0 and 4.2 instances are supported.</li><li id="dds_connect_0003__li2012612518244">Inactive sessions cannot be terminated.</li></ul>
<div class="section" id="dds_connect_0003__section07615256244"><h4 class="sectiontitle">Constraints</h4><ul id="dds_connect_0003__ul812632512245"><li id="dds_connect_0003__li1126325122416">Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.</li><li id="dds_connect_0003__li2012612518244">Inactive sessions cannot be terminated.</li></ul>
</div>
<div class="section" id="dds_connect_0003__section137742592419"><h4 class="sectiontitle">URI</h4><ul id="dds_connect_0003__ul53354139141429"><li id="dds_connect_0003__li1270098217262">URI format<p id="dds_connect_0003__p174818141875"><a name="dds_connect_0003__li1270098217262"></a><a name="li1270098217262"></a>POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/session</p>
</li></ul>

5
docs/dds/api-ref/dds_database_version.html
View File

@ -48,7 +48,7 @@
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_database_version__p1299616431919">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_database_version__p39568472259">Indicates the database version. Currently, versions 3.2, 3.4, 4.0, and 4.2 are supported.</p>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_database_version__p39568472259">Indicates the database version. Currently, versions 3.2, 3.4, 4.0, 4.2, and 4.4 are supported.</p>
</td>
</tr>
</tbody>
@ -60,7 +60,8 @@
"3.2",
"3.4",
"4.0",
"4.2"
"4.2",
"4.4"
]
}</pre>
</li></ul>

2
docs/dds/api-ref/dds_instance_specification.html
View File

@ -147,7 +147,7 @@
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_instance_specification__p1872955064317">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_instance_specification__p021911204412">Database versions</p>
<p id="dds_instance_specification__p202196164412">For example, DDS mongos node, {"3.2", "3.4", "4.0", "4.2"}</p>
<p id="dds_instance_specification__p202196164412">For example, DDS mongos node, {"3.2", "3.4", "4.0", "4.2", "4.4"}</p>
</td>
</tr>
</tbody>