Skip to content

Commit f628951

Browse files
committed
Update: 09-10-2024
1 parent 84a0bc7 commit f628951

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+167
-184
lines changed

accounts/account.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Using the `DELETE` method logs out the user because the cookie is considered exp
9898
| `POST` | `/_session` | Do cookie-based user login. | `Content-Type: application/x-www-form-urlencoded` | `name`, `password` |
9999
| `GET` | `/_session` | Returns cookie-based login user information. | AuthSession cookie returned by POST request. | |
100100
| `DELETE` | `/_session` | Log out cookie-based user. | AuthSession cookie returned by POST request. |
101-
{: caption="Table 1. Cookie authentication and methods" caption-side="top"}
101+
{: caption="Cookie authentication and methods" caption-side="top"}
102102

103103
For more information, see [Security scheme](/apidocs/cloudant#security-scheme){: external} on basic authentication.
104104

@@ -145,7 +145,7 @@ The three core roles are defined in the following table:
145145
| `_admin` | Change security settings, including adding roles. |
146146
| `_reader` | Read documents from the database. |
147147
| `_writer` | Create, update, and delete documents (except design documents) in the database. |
148-
{: caption="Table 2. Core roles" caption-side="top"}
148+
{: caption="Core roles" caption-side="top"}
149149

150150
The `_reader` and `_writer` roles are exclusive. If a user has the `_writer` role, they can't read documents that they create unless they *also* have the `_reader` role.
151151
{: tip}
@@ -170,7 +170,7 @@ The focused roles are defined in the following table:
170170
| `_design` | Allows create, read, modify, or delete access to design documents. | [`_design`](/docs/Cloudant?topic=Cloudant-design-documents#design-documents), [`_find`](/docs/Cloudant?topic=Cloudant-query#working-with-indexes), [`_index`](/docs/Cloudant?topic=Cloudant-query#working-with-indexes) |
171171
| `_replicator` | Allows read access to replicate data from a database, and write access to create checkpoints. | [`_local`](/apidocs/cloudant?code=node#postreplicate){: external}, [`_replicate`](/apidocs/cloudant#postreplicate){: external}, [`_replicator`](/docs/Cloudant?topic=Cloudant-replication-api#the-replicator-database) |
172172
| `_security` | Allows read and write access to the `/$DATABASE/_security` endpoint. | [`_security`](/apidocs/cloudant#getsecurity){: external} |
173-
{: caption="Table 3. Focused roles" caption-side="top"}
173+
{: caption="Focused roles" caption-side="top"}
174174

175175
The nature of the access that is granted depends on the specific API endpoint.
176176
For example,

accounts/cors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ CORS support is available in the {{site.data.keyword.cloudant_short_notm}} Dashb
8484

8585
You can update your CORS settings by using the CORS tab within the dashboard. See the following screenshot:
8686

87-
![CORS dashboard lets you connect to remote servers directly from the brower. Using CORS, you can host browser-based apps on static pages, and load data directly from {{site.data.keyword.cloudant_short_notm}}.](../images/corsdashboard.png){: caption="Figure 1. CORS dashboard" caption-side="bottom"}
87+
![CORS dashboard lets you connect to remote servers directly from the brower. Using CORS, you can host browser-based apps on static pages, and load data directly from {{site.data.keyword.cloudant_short_notm}}.](../images/corsdashboard.png){: caption="CORS dashboard" caption-side="bottom"}
8888

8989
To see the current CORS configuration,
9090
open **Account** > **CORS** in the dashboard.

couchdb/compare.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,4 +117,4 @@ click the corresponding link.
117117
| `GET /{db}/{docid}/{attname}` \n [Cloudant](/apidocs/cloudant#getattachment){: external}, [CouchDB](https://docs.couchdb.org/en/latest/api/document/attachments.html#get--db-docid-attname) | Retrieve the file attachment associated with the document. For {{site.data.keyword.cloudant_short_notm}}, use `{attachment_name}` instead of `{attname}`. |
118118
| `PUT /{db}/{docid}/{attname}` \n [Cloudant](/apidocs/cloudant#putattachment){: external}, [CouchDB](https://docs.couchdb.org/en/latest/api/document/attachments.html#put--db-docid-attname) | Upload the supplied content as an attachment to the specified document. For {{site.data.keyword.cloudant_short_notm}}, use `{attachment_name}` instead of `{attname}`. |
119119
| `DELETE /{db}/{docid}/{attname}` \n [Cloudant](/apidocs/cloudant#deleteattachment){: external}, [CouchDB](https://docs.couchdb.org/en/latest/api/document/attachments.html#delete--db-docid-attname) | Delete the attachment associated with the specified doc. For {{site.data.keyword.cloudant_short_notm}}, use `{attachment_name}` instead of `{attname}`. |
120-
{: caption="Table 1. Compare {{site.data.keyword.cloudant_short_notm}} and Apache CouchDB API endpoints" caption-side="top"}
120+
{: caption="Compare {{site.data.keyword.cloudant_short_notm}} and Apache CouchDB API endpoints" caption-side="top"}

couchdb/comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The following table shows the feature and function differences that you must be
4141
| Attachment size | 4 GB (default) | 4 GB (default) | 4 GB (default) | 10 MB |
4242
| Security auth | [CouchDB Auth](https://docs.couchdb.org/en/stable/intro/security.html#){: external} | [CouchDB Auth](https://docs.couchdb.org/en/stable/intro/security.html#){: external} | [CouchDB Auth](https://docs.couchdb.org/en/stable/intro/security.html#){: external} | [{{site.data.keyword.cloudant_short_notm}} legacy auth with API Keys](/docs/Cloudant?topic=Cloudant-work-with-your-account#authorization), [{{site.data.keyword.cloud_notm}} IAM](/docs/Cloudant?topic=Cloudant-managing-access-for-cloudant), or [CouchDB Auth](https://docs.couchdb.org/en/stable/intro/security.html#){: external} |
4343
| LDAP | No | No | No | No |
44-
{: caption="Table 1. Feature and function differences between {{site.data.keyword.cloudant_short_notm}} and Apache CouchDB" caption-side="top"}
44+
{: caption="Feature and function differences between {{site.data.keyword.cloudant_short_notm}} and Apache CouchDB" caption-side="top"}
4545

4646
The CouchDB `_show`, `_list`, `_update`, and `_rewrite` functions were deprecated in Apache CouchDB 3.0. For more information, see [deprecated feature warnings](https://docs.couchdb.org/en/stable/whatsnew/3.0.html#deprecated-feature-warnings).
4747

databases/cloudant-redis-cache.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ When you run this script, it takes the data output from the Terraform script and
136136
1. Open a browser and visit `https://localhost:8080`.
137137
See the button for each team in the following screen capture:
138138

139-
![{Click the button for each team. ](../images/teamdir1.png){: caption="Figure 1. Team Directory team selectors" caption-side="bottom"}
139+
![{Click the button for each team. ](../images/teamdir1.png){: caption="Team Directory team selectors" caption-side="bottom"}
140140

141141
1. Click any of the colored buttons and obtain a list of team members.
142142

@@ -145,7 +145,7 @@ When you run this script, it takes the data output from the Terraform script and
145145
1. Click the same button that you clicked in step two.
146146
You can see the data that comes from the {{site.data.keyword.databases-for-redis}} cache and takes a lot less time to execute in the following screen capture:
147147

148-
![Click the team button and see the members of the team. ](../images/teamdir2.png){: caption="Figure 2. Team Directory team list and cache information" caption-side="bottom"}
148+
![Click the team button and see the members of the team. ](../images/teamdir2.png){: caption="Team Directory team list and cache information" caption-side="bottom"}
149149

150150
In a real cloud-based application, the application server and the {{site.data.keyword.databases-for-redis}} instance would be close to each other (in the same data center) so latency between the two would be only a few milliseconds. In this example, extra network hops exist between your locally hosted application server and the cloud-hosted {{site.data.keyword.databases-for-redis}} cache so latency gains aren't as good as in production.
151151
{: note}

databases/conflicts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The following suggested practices might help you decide when to check for, and r
5353
| Often but not always connected to the network, for example, a laptop. | Often | - | Y |
5454
| Often but not always connected to the network. | Occasionally | - | Y |
5555
| Occasionally connected to the network, for example, a tablet. | Often | - | Y |
56-
{: caption="Table 1. Suggested practices" caption-side="top"}
56+
{: caption="Suggested practices" caption-side="top"}
5757

5858
## Finding conflicts
5959
{: #finding-conflicts}

databases/creating-a-db.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ All Go examples require the `service` object to be initialized. For more informa
233233
| Argument | Description | Optional | Type | Default | Supported values |
234234
|-----------------|-------------|----------|------|---------|------------------|
235235
| `partitioned` | Determines whether the database is partitioned. | Yes | Boolean | `false` | `true`, `false` |
236-
{: caption="Table 1. Query arguments" caption-side="top"}
236+
{: caption="Query arguments" caption-side="top"}
237237

238238
## Database naming
239239
{: #database-naming}
@@ -253,7 +253,7 @@ If your database is successfully created, you get a 201 or 202 response. An erro
253253
| 202 | The database was successfully created on some nodes, but the number of nodes is less than the write quorum. |
254254
| 400 | Invalid database name. |
255255
| 412 | Database exists. |
256-
{: caption="Table 2. HTTP status codes" caption-side="top"}
256+
{: caption="HTTP status codes" caption-side="top"}
257257

258258
See the following example response that is received after a database is created successfully:
259259

databases/database_partitioning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Let's look at some use cases and some good and bad choices for a partition key.
9696
| Blogging platform | One document per blog post | `author_id` | Good - if many authors participate. Easy to query each author's posts. |
9797
| IOT - sensor readings | One document per reading | `device_id` | Good - if many devices exist, make sure that one device isn't producing many more readings than the others. |
9898
| IOT - sensor readings | One document per reading | `date` | Bad - current readings cause a "hot spot" on the current date's partition. |
99-
{: caption="Table 1. Good and bad choices for a partition key" caption-side="top"}
99+
{: caption="Good and bad choices for a partition key" caption-side="top"}
100100

101101
Some use cases exist where no viable choice for a partition key exists.
102102
In these situations, it's likely a non-partitioned database is the best

databases/deleting-a-db.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ An error response uses the HTTP status code to indicate what went wrong.
122122
| 200 | Database deleted successfully. |
123123
| 202 | Database was successfully deleted on some nodes, but the number of nodes is less than the write quorum. |
124124
| 404 | Database does not exist on all of the nodes. |
125-
{: caption="Table 1. HTTP status codes" caption-side="top"}
125+
{: caption="HTTP status codes" caption-side="top"}
126126

127127
See the following example response that is received after a database is deleted successfully:
128128

@@ -132,4 +132,3 @@ See the following example response that is received after a database is deleted
132132
}
133133
```
134134
{: codeblock}
135-

databases/getting-changes-to-docs-in-db.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The `_changes` endpoint accepts several optional query arguments:
4141
| `since` | Start the results from changes after the specified sequence identifier. For more information, see the [`since` information](#the-since-argument). | Sequence identifier or `now` | 0 |
4242
| `style` | Specifies how many revisions are returned in the changes array. The `main_only` style returns only the current "winning" revision. The `all_docs` style returns all leaf revisions, including conflicts and deleted former conflicts. | `main_only`, `all_docs` | `main_only` |
4343
| `timeout` | Wait this number of milliseconds for data, then stop the response. If the `heartbeat` setting is also supplied, it takes precedence over the `timeout` setting. | Any positive number | |
44-
{: caption="Table 1. Query arguments for _changes endpoint" caption-side="top"}
44+
{: caption="Query arguments for _changes endpoint" caption-side="top"}
4545

4646
Using `include_docs=true` might have [performance implications](/docs/Cloudant?topic=Cloudant-using-views#multi-document-fetching).
4747
{: important}
@@ -231,7 +231,7 @@ The following table describes the meaning of the individual fields:
231231
| `last_seq` | Identifier of the last of the sequence identifiers. Currently, this identifier is the same as the sequence identifier of the last item in the `results`. | String |
232232
| `results` | Array of changes that were made to the database. | Array
233233
| `seq` | Update sequence identifier. | String |
234-
{: caption="Table 2. JSON object response fields for _changes" caption-side="top"}
234+
{: caption="JSON object response fields for _changes" caption-side="top"}
235235

236236
See the following example (abbreviated) response to a `_changes` request:
237237

databases/getting-db-details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ The elements of the returned structure are shown in the following table:
127127
| `sizes` | A JSON object, containing `file`, `external`, and `active` sizes. `active` is the size in bytes of data that is stored internally (excluding old revisions). `external` is the size in bytes of decompressed user data. This value is the billable data size. The `other/data_size` field is an alias for the `external` field. `file` is the size in bytes of data that is stored on the disk. Indexes aren't included in the calculation. The `disk_size` field is an alias for the `file` field. This size includes data that is waiting for compaction. |
128128
| `update_seq` | An opaque string that describes the state of the database. Don't rely on this string for counting the number of updates. |
129129
| `partitioned_indexes` | A JSON object that appears only if the database is partitioned. `count` is the number of partitioned indexes. `indexes` list the type of partitioned indexes, and `limit` shows the maximum number of allowed partitioned indexes. |
130-
{: caption="Table 1. Database details" caption-side="top"}
130+
{: caption="Database details" caption-side="top"}
131131

132132
See the following example (abbreviated) response that contains database details:
133133

databases/getting-docs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The `_all_docs` endpoint accepts the following query string and JSON body argume
3838
| `skip` | Skip this number of records before returning the results. | Yes | Numeric | 0 |
3939
| `startkey` | Return records, starting with the specified key. | Yes | String | |
4040
| `startkey_docid` | Return records, starting with the specified document ID. If `startkey` isn't set, this argument is ignored. | Yes | String | |
41-
{: caption="Table 1. Query string and JSON body arguments" caption-side="top"}
41+
{: caption="Query string and JSON body arguments" caption-side="top"}
4242

4343
## Notes
4444
{: #get-documents-notes}
@@ -279,7 +279,7 @@ The following table describes the meaning of the individual fields:
279279
| `rows` | Array of document objects. | Array |
280280
| `total_rows` | Number of documents in the database or view that match the parameters of the query. | Numeric |
281281
| `pdate_seq` | Current update sequence for the database. | String |
282-
{: caption="Table 2. JSON object fields" caption-side="top"}
282+
{: caption="JSON object fields" caption-side="top"}
283283

284284
See the following example response after a request for all documents in a database:
285285

databases/sending-multiple-queries-to-db.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ The results are returned by using the following response JSON object:
192192
| Response JSON object | Description | Type |
193193
|-------------------------|-------------|------|
194194
| `results` | An array of result objects - one for each query. Each result object contains the same fields as the response to a regular `_all_docs` request. | Array |
195-
{: caption="Table 1. Response JSON object" caption-side="top"}
195+
{: caption="Response JSON object" caption-side="top"}
196196

197197
See the following example request with multiple queries:
198198

databases/sharding.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ The servers are available within a single Region.
2929
If the Region supports Availability Zones, the replicas are stored on servers in different Zones.
3030
The collection of servers in a Region is called a cluster.
3131

32-
![A single database is split into Q shards, which are each stored in triplicate on three separate servers.](../images/sharding_database.svg){: caption="Figure 1. Data storage" caption-side="bottom"}
32+
![A single database is split into Q shards, which are each stored in triplicate on three separate servers.](../images/sharding_database.svg){: caption="Data storage" caption-side="bottom"}
3333

3434
A document is assigned to a particular shard by using consistent hashing of its ID.
3535
This assignment means that a document is always stored on a known shard and a known set of servers.
3636

37-
![A single document is assigned to a single shard so ends up on three replicas on three separate servers. ](../images/sharding_document.svg){: caption="Figure 2. Document consistent hashing" caption-side="bottom"}
37+
![A single document is assigned to a single shard so ends up on three replicas on three separate servers. ](../images/sharding_document.svg){: caption="Document consistent hashing" caption-side="bottom"}
3838

3939
Occasionally,
4040
shards are rebalanced.
@@ -244,4 +244,3 @@ By specifying a `W` value,
244244
the client can inspect the HTTP status code in the response to determine whether `W` replicas responded to the coordinator.
245245
The coordinator waits until a pre-determined timeout for `W` responses from nodes that host copies of the document
246246
before it returns the response to the client.
247-

documents/bulk-operations.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For both inserts and updates, the basic structure of the JSON document in the re
3636
| Field | Description | Type | Optional |
3737
|-------|-------------------------|------------------|---------|
3838
| `docs` | List of document objects | Array of objects | No |
39-
{: caption="Table 1. Basic bulk request structure" caption-side="top"}
39+
{: caption="Basic bulk request structure" caption-side="top"}
4040

4141
It is best not to use the `new_edits` field. By default, if conflicts exist, document updates fail and return an error to the client. However, this option applies document revisions without checking for conflicts, so it is easy to accidentally end up with many conflicts.
4242
{: note}
@@ -48,7 +48,7 @@ Each `docs` array object has the following structure:
4848
| `_id` | Document ID | String | Optional only for new documents. Otherwise, it's mandatory. |
4949
| `_rev` | Document revision | String | Mandatory for updates and deletes, not used for new documents. |
5050
| `_deleted` | Determines whether the document must be deleted. | Boolean | (Optional) The default value is `false`. |
51-
{: caption="Table 2. Structure of the docs array object" caption-side="top"}
51+
{: caption="Structure of the docs array object" caption-side="top"}
5252

5353
Recall that for a partitioned database the `_id` field is formed from
5454
a partition key part and a document key part.
@@ -275,7 +275,7 @@ you get an array with detailed information for each document in the request.
275275
|------|-------------|
276276
| `201` | The request did succeed, but this success doesn't imply all documents were updated. Inspect the response body to determine the status of each requested change, and [address any problems](#bulk-document-validation-and-conflict-errors). |
277277
| `202` | For at least one document, the write [quorum](#quorum-writing-and-reading-data) wasn't met. |
278-
{: caption="Table 3. HTTP status codes" caption-side="top"}
278+
{: caption="HTTP status codes" caption-side="top"}
279279

280280
See an example response from a bulk request:
281281

@@ -756,7 +756,7 @@ The structure of the returned information is shown in the following tables:
756756
| Field | Description | Type |
757757
|-------|-------------------------|-----|
758758
| `docs` | List of document objects | Array of objects |
759-
{: caption="Table 4. Structure of JSON returned" caption-side="top"}
759+
{: caption="Structure of JSON returned" caption-side="top"}
760760

761761
Each `docs` array object has the following structure:
762762

@@ -765,7 +765,7 @@ Each `docs` array object has the following structure:
765765
| `id` | Document ID | String |
766766
| `error` | Error type | String |
767767
| `reason` | Error string with extended reason | String |
768-
{: caption="Table 5. Structure for the docs array object" caption-side="top"}
768+
{: caption="Structure for the docs array object" caption-side="top"}
769769

770770
When a document (or document revision) is not correctly committed to the database because of an error,
771771
you must check the `error` field to determine error type and course of action.

0 commit comments

Comments
 (0)