Skip to content

Commit de4a67d

Browse files
authored
DOC-12483 remove memcached buckets (#3814)
* Initial pass at removing Memcached bucket references. * Added What's New entry. * Removed two cli reference topics from cbstats that were memcached bucket only (the commands are no longer listed in cbstats --help). * removed all incstances of "memecached bucket" except for the What's New statement of their removal. * Some additional edits * Adding branch-specific preview config * Fixed missing period * Removing a partial that was only used once, and had weird formatting in it.
1 parent 8d09f6e commit de4a67d

File tree

13 files changed

+98
-199
lines changed

13 files changed

+98
-199
lines changed

modules/ROOT/nav.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,6 @@ include::cli:partial$cbcli/nav.adoc[]
285285
*** xref:cli:cbstats/cbstats-durability-monitor.adoc[durability-monitor]
286286
*** xref:cli:cbstats/cbstats-failovers.adoc[failovers]
287287
*** xref:cli:cbstats/cbstats-hash.adoc[hash]
288-
*** xref:cli:cbstats/cbstats-items.adoc[items]
289288
*** xref:cli:cbstats/cbstats-key.adoc[key]
290289
*** xref:cli:cbstats/cbstats-kvstore.adoc[kvstore]
291290
*** xref:cli:cbstats/cbstats-kvtimings.adoc[kvtimings]
@@ -298,7 +297,6 @@ include::cli:partial$cbcli/nav.adoc[]
298297
*** xref:cli:cbstats/cbstats-scheduler.adoc[scheduler]
299298
*** xref:cli:cbstats/cbstats-scopes.adoc[scopes]
300299
*** xref:cli:cbstats/cbstats-scopes-details.adoc[scopes-details]
301-
*** xref:cli:cbstats/cbstats-slabs.adoc[slabs]
302300
*** xref:cli:cbstats/cbstats-tap-vbtakeover.adoc[tap-vbtakeover]
303301
*** xref:cli:cbstats/cbstats-tasks.adoc[tasks]
304302
*** xref:cli:cbstats/cbstats-timing.adoc[timings]

modules/audit-event-reference/pages/audit-event-reference.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,6 @@ The following events are generated by the Data Service, in response to attempts
117117
| Event Group | Event Name | ID | Description | Filter? | Event Type
118118
| Data Service | opened DCP connection | 20480 | opened DCP connection | N | Admin
119119
| Data Service | authentication failed | 20481 | authentication failed | N | Admin
120-
| Data Service | external memcached bucket flush | 20482 | External user flushed the content of a memcached bucket | N | Admin
121120
| Data Service | invalid packet | 20483 | Rejected an invalid packet | N | Admin
122121
| Data Service | command access failure | 20484 | Rejected access to a command | N | Admin
123122
| Data Service | authentication succeeded | 20485 | Authentication to the cluster succeeded | N | Admin

modules/cli/pages/cbstats/cbstats-items.adoc

Lines changed: 0 additions & 45 deletions
This file was deleted.

modules/cli/pages/cbstats/cbstats-slabs.adoc

Lines changed: 0 additions & 47 deletions
This file was deleted.

modules/learn/pages/buckets-memory-and-storage/buckets.adoc

Lines changed: 68 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,53 @@
11
= Buckets
2-
:description: pass:q[A _bucket_ is the fundamental space for storing data in Couchbase Server.]
2+
:description: pass:q[A bucket is the fundamental space for storing data in Couchbase Server.]
33
:page-aliases: understanding-couchbase:buckets-memory-and-storage/buckets,architecture:core-data-access-buckets
44

55
[abstract]
66
{description}
77
Each bucket contains a hierarchy of scopes and collections to group keys and values logically.
8+
See xref:data/scopes-and-collections.adoc[Scopes and Collections] for more information about scopes and collections.
89

910
== Bucket Types
1011

1112
[#couchbase-bucket-types]
12-
A maximum of 30 buckets can be created in a cluster.
13-
Each bucket must be specified as one of the following three _types_.
13+
You can create up to 30 buckets in a cluster.
14+
Couchbase Server supports two types of buckets:
1415

15-
* *Couchbase buckets*: These store data persistently, as well as in memory.
16-
They allow data to be automatically replicated for high availability, using the Database Change Protocol (DCP); and dynamically scaled across multiple clusters, by means of Cross Datacenter Replication (XDCR).
16+
* Couchbase buckets store data both in memory and on disk.
17+
They support automatic data replication for high availability using the Database Change Protocol (DCP).
18+
You can also scale data across multiple clusters with Cross Datacenter Replication (XDCR).
1719
+
18-
If a Couchbase bucket's RAM-quota is exceeded, items are _ejected_.
19-
This means that data, which is resident both in memory and on disk, is removed from memory, but not from disk.
20-
Therefore, if removed data is subsequently needed, it is reloaded into memory from disk.
21-
For a Couchbase bucket, ejection can be either of the following, based on configuration performed at the time of bucket-creation:
20+
If a Couchbase bucket exceeds its RAM quota, the system ejects items.
21+
Ejection removes data from memory but keeps it on disk.
22+
If you need the removed data later, Couchbase Server reloads it from disk.
23+
You can configure ejection at bucket creation as either of the following:
2224

23-
** _Value-only_: Only key-values are removed.
24-
Generally, this favors performance at the expense of memory.
25+
** Value-only: The system removes only key-values.
26+
This option generally improves performance but uses more memory.
2527

26-
** _Full_: All data — including keys, key-values, and metadata — is removed.
27-
Generally, this favors memory at the expense of performance.
28+
** Full: The system removes all data, including keys, key-values, and metadata.
29+
This option generally saves memory but may reduce performance.
2830

29-
* *Ephemeral buckets*: These are an alternative to Couchbase buckets, to be used whenever persistence is not required: for example, when repeated disk-access involves too much overhead.
30-
This allows highly consistent in-memory performance, without disk-based fluctuations.
31-
It also allows faster node rebalances and restarts.
31+
* Ephemeral buckets are an alternative to Couchbase buckets when you do not need data persistence.
32+
Use them when disk access causes too much overhead.
33+
Ephemeral buckets deliver consistent in-memory performance without disk-based fluctuations.
34+
They also allow nodes to rebalance and restart faster.
3235
+
33-
If an Ephemeral bucket's RAM-quota is exceeded, one of the following occurs, based on configuration performed at the time of bucket-creation:
36+
An Ephemeral bucket handles running out of RAM quota in one of two ways, depending on how you set their ejection policy:
3437

35-
** Resident data-items remain in RAM.
36-
No additional data can be added; and attempts to add data therefore fail.
38+
** If you choose not to have data ejected, Couchbase Server does not remove data from the bucket when it fills.
39+
Instead, it returns an error when you try to load additional data into the bucket.
40+
To be able to load more data into the bucket, you must either increase the bucket's RAM quota or remove some data from the bucket.
3741

38-
** Resident data-items are _ejected_ from RAM, to make way for new data.
39-
For an Ephemeral bucket, this means that data, which is resident in memory (but, due to this type of bucket, can never be on disk), is removed from memory.
40-
Therefore, if removed data is subsequently needed, it cannot be re-acquired from Couchbase Server.
41-
+
42-
For an Ephemeral bucket, ejection removes all of an item's data: however, a _tombstone_ (a record of the ejected item, which includes keys and metadata) is retained until the next scheduled purge of metadata for the current node.
43-
See xref:buckets-memory-and-storage/storage.adoc[Storage] for more information.
44-
45-
* *Memcached buckets*: These are now _deprecated_.
46-
Memcached buckets are designed to be used alongside other database platforms, such as ones employing relational database technology.
47-
By caching frequently-used data, Memcached buckets reduce the number of queries a database-server must perform.
48-
Each Memcached bucket provides a directly addressable, distributed, in-memory key-value cache.
49-
+
50-
Memcached buckets are _not persistent on disk_: they only exist in RAM.
51-
If a Memcached bucket's RAM-quota is exceeded, items are _ejected_.
52-
For a Memcached bucket, this means that data, which is resident in memory (but, due to this type of bucket, can never be on disk), is removed from memory.
53-
Therefore, if removed data is subsequently needed, it cannot be re-acquired from Couchbase Server.
54-
Ejection removes all of an item's data.
55-
56-
All bucket types are fully compatible with the Memcached open source distributed key-value cache.
42+
** If you enable data ejection, Couchbase Server removes older data from the bucket to make room for new data.
43+
When Couchbase Server ejects data from an Ephemeral bucket, you cannot recover it.
44+
It removes all of the item's data.
45+
However, it keeps a tombstone (a record of the ejected item, including keys and metadata) until the next scheduled metadata purge for the current node.
46+
See xref:buckets-memory-and-storage/storage.adoc[Storage] for more details.
5747

5848
== Bucket Capabilities
5949

60-
The Couchbase and Ephemeral bucket-types each support a slightly different set of capabilities; as shown by the following table.
50+
The Couchbase and Ephemeral buckets support a different set of capabilities as the following table shows:
6151

6252
|===
6353
| Capability | Couchbase buckets | Ephemeral buckets
@@ -179,64 +169,70 @@ For version 7.0.2 and after, Yes.
179169
[#replication-dcp-and-xdcr]
180170
== Couchbase vs Ephemeral Buckets
181171

182-
Couchbase and Ephemeral buckets both provide a highly available, dynamically reconfigurable, distributed data-store; which survives node failures, and allows cluster-reconfiguration to occur while service-requests continue to be handled.
183-
The following table provides further information on the principal capabilities shared by both bucket-types.
172+
Couchbase and Ephemeral buckets both provide a highly available, dynamically reconfigurable, distributed data store.
173+
They survive node failures and allow cluster reconfiguration while the system continues to handle service requests.
174+
The following table provides information about the main capabilities shared by both bucket types.
184175

185176
[cols="3,5,5"]
186177
|===
187178
| Capability | Couchbase Buckets | Ephemeral Buckets
188179

189180
| Persistence
190-
| Couchbase buckets are persisted asynchronously, from memory to disk.
191-
This provides protection from server-restarts.
192-
You can set persistence-properties at the bucket level.
193-
| Ephemeral buckets are not persisted to disk: they are retained in RAM only.
181+
| Couchbase buckets persist data asynchronously from memory to disk.
182+
This persistence protects data from server restarts.
183+
You can set persistence properties at the bucket level.
184+
| Ephemeral buckets do not persist data to disk.
185+
They retain data in RAM only.
194186

195187
| Replication (DCP and XDCR)
196-
| Couchbase buckets can be replicated across a configurable number of servers.
197-
If the host machine fails, a replica server is promoted to be the host server, providing high availability cluster operations via failover.
188+
| Couchbase buckets replicate data across a configurable number of servers.
189+
If the host node fails, a replica server becomes the host server.
190+
This provides high availability cluster operations through failover.
198191
You can configure replication at the bucket level.
199-
Additionally, _Cross Datacenter Replication_ (XDCR) allows replication of Couchbase bucket-data between clusters.
200-
| Ephemeral buckets can be replicated across a configurable number of servers, exactly as can Couchbase buckets; but without being persisted to disk.
201-
Likewise, XDCR allows replication of Ephemeral bucket-data between clusters and without persistence: note however, that if an Ephemeral bucket configured to eject data when its RAM-quota is exceeded is used as a source for XDCR, not all data written to the bucket is guaranteed to be replicated by XDCR.
192+
Cross datacenter replication (XDCR) enables replication of Couchbase bucket data between clusters.
193+
| Ephemeral buckets replicate data across a configurable number of servers, just like Couchbase buckets, but without persisting data to disk.
194+
XDCR can also replicate Ephemeral bucket data between clusters without persistence.
195+
If your source for an XDCR replication is an Ephemeral bucket that ejects data when it exceeds its RAM quota, XDCR does not guarantee replication of all data written to the bucket.
202196

203197
| Rebalance
204-
| By means of rebalancing, the load constituted by Couchbase buckets is distributed evenly across nodes within the cluster.
205-
Buckets and nodes can be dynamically added and removed.
206-
| Rebalancing redistributes Ephemeral buckets, exactly as it does Couchbase buckets; but without the data being persisted to disk.
198+
| Rebalancing distributes the load of Couchbase buckets evenly across nodes in the cluster.
199+
You can add or remove buckets and nodes dynamically.
200+
| Rebalancing redistributes Ephemeral buckets in the same way as Couchbase buckets, but without persisting data to disk.
207201

208202
| Auto-failover and auto-reprovision
209-
| By default, Auto-failover starts when a node has been inaccessible for 120 seconds.
210-
Auto-failover can happen only up to a specified maximum number of times, prior to manual reset.
211-
When a failed node becomes accessible again, delta-node recovery is used: re-using data on disk, and resynchronizing it.
203+
| By default, auto-failover starts when a node is inaccessible for 120 seconds.
204+
Auto-failover can occur up to a specified maximum number of times before you must reset it manually.
205+
When a failed node becomes accessible again, delta-node recovery uses data on disk and resynchronizes it.
212206
| Auto-reprovision starts as soon as a node is inaccessible.
213-
Auto-reprovision can happen multiple times, for multiple nodes.
214-
When a failed node becomes accessible again, no delta-node recovery is required, since no data resides on disk.
207+
Auto-reprovision can occur multiple times for multiple nodes.
208+
When a failed node becomes accessible again, the system does not require delta-node recovery because no data resides on disk.
215209
|===
216210

217211
== Bucket Security
218212

219-
Buckets are protected by the Couchbase _Role-Based Access Control_ (RBAC) system.
220-
See
221-
xref:learn:security/authorization-overview.adoc[Authorization] and
222-
xref:learn:security/authentication.adoc[Authentication] for details.
213+
The Couchbase Role-Based Access Control (RBAC) system protects buckets.
214+
See xref:learn:security/authorization-overview.adoc[Authorization] and xref:learn:security/authentication.adoc[Authentication] for details.
223215

224-
From release 7.6, Couchbase Server no longer supports {sqlpp} operations on buckets without password specification -- for instance, legacy buckets which have been upgraded to use RBAC.
225-
Users must authenticate to connect to the Query service and execute a {sqlpp} statement, and must be authorized to access all required buckets and collections.
216+
Starting with version 7.6, Couchbase Server does not support {sqlpp} operations on buckets without a password.
217+
This restriction includes legacy buckets upgraded to use RBAC.
218+
Users must authenticate to connect to the Query Service and execute a {sqlpp} statement.
219+
They must also have a role that grants them access to the buckets and collections they need to access.
220+
See xref:learn:security/authorization-overview.adoc[] for more information about authorization.
226221

227222
== Bucket Storage
223+
228224
Couchbase supports two different backends for the underlying storage of bucket data:
229-
include::manage:partial$backend-description-section.adoc[]
230-
See xref:learn:buckets-memory-and-storage/storage-engines.adoc[] for more information.
231225

232-
Note that the bucket storage backends apply only to Couchbase buckets: they do _not_ apply to Ephemeral buckets.
226+
* Couchstore: the traditional storage engine better suited to lower volumes of data.
227+
* Magma: the latest high performance storage engine for much higher data volumes.
228+
229+
See xref:learn:buckets-memory-and-storage/storage-engines.adoc[] for more Information about storage engines.
230+
231+
The bucket storage backends apply only to Couchbase buckets.
232+
Ephemeral buckets do not use these backends.
233233

234234
== Using Buckets in Administration and Development
235235

236-
For information on how to create, access, and manage buckets, see
237-
xref:manage:manage-buckets/bucket-management-overview.adoc[Manage Buckets].
236+
See xref:manage:manage-buckets/bucket-management-overview.adoc[Manage Buckets] for information about creating, accessing, and managing buckets.
238237

239-
== Scopes and Collections
240238

241-
Within each bucket, data is organized in a logical hierarchy of _scopes_ and _collections_.
242-
For more information, refer to xref:data/scopes-and-collections.adoc[Scopes and Collections].

modules/learn/pages/buckets-memory-and-storage/compression.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ On receipt of a compressed item, Couchbase Server decompresses the item when sto
4040
Couchbase Server sends the item in uncompressed form.
4141
This mode is assigned by default to buckets _upgraded_ from a previous version of Couchbase Server.
4242
The mode is recommended for use where clients cannot benefit from compression, and where neither memory-resources nor network-bandwidth will be negatively impacted by the size and quantity of items to be handled.
43-
Note also that this is the only mode under which Memcached buckets operate.
4443
* *Passive*: On receipt of a compressed item, Couchbase Server stores it in compressed form both in memory and on disk.
4544
Couchbase Server sends the item back to the client in compressed form if this is requested by the client; otherwise, it sends the item back in uncompressed form.
4645
On receipt of an uncompressed item, Couchbase Server stores it in memory in uncompressed form, and stores it on disk in compressed form.

modules/learn/pages/data/expiration.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@ For example, you often want documents that contain user session data to expire s
1515
Or you may use documents to store cached data.
1616
You can have these documents automatically expire so your application knows to refresh the data from its source.
1717

18-
Couchbase Server Enterprise Edition lets you have documents expire after a period of time, called the document's Time To Live (TTL).
19-
This feature only works in Couchbase and Ephemeral buckets.
20-
It does not work in Memcached buckets.
18+
Couchbase Server Enterprise Edition lets you have documents expire after a period of time, called the document's Time To Live (TTL).
2119

2220
You can set an expiration value on an individual document either when you create it or when you mutate it.
2321
Set the expiration to the number of seconds the document should exist before Couchbase Server automatically removes it.

0 commit comments

Comments
 (0)