bahman/scylla
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

doc: remove the OSS and Enterprise Features pages

Browse Source 
This commit removes the following pages:
- ScyllaDB Open Source Features
- ScyllaDB Enterprise Features

They were outdated, incomplete, and misleading.
They were also redundant, as the per-release
updates are added as Release Notes.

With this update, the features listed on the removed
pages are added under the common page: ScyllaDB Features.

Note: No redirections are added, because no file paths
or URLs are changed with this commit.

Fixes https://github.com/scylladb/scylladb/issues/13485

Refs https://github.com/scylladb/scylladb/issues/16496
This commit is contained in:
Anna Stuchlik
2024-02-04 20:55:40 +01:00
parent 784c2f8ad2
commit f7afa6773f
4 changed files with 11 additions and 215 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
docs/using-scylla/features-ent.rst
View File

@@ -1,110 +0,0 @@
===========================
Scylla Enterprise Features
===========================
.. toctree::
:maxdepth: 2
:hidden:
Global Secondary Indexes </using-scylla/secondary-indexes/>
Local Secondary Indexes </using-scylla/local-secondary-indexes/>
Materialized Views </using-scylla/materialized-views/>
Counters </using-scylla/counters/>
Change Data Capture </using-scylla/cdc/index>
.. panel-box::
:title: Coming Soon to Scylla Enterprise
:id: "getting-started"
:class: my-panel
The following features are scheduled for an **upcoming release** of Scylla Enterprise. To see which release, read the `Release Notes <https://www.scylladb.com/product/release-notes/>`_.
* `LDAP Role Management <https://enterprise.docs.scylladb.com/stable/operating-scylla/security/ldap-authorization.html>`_
* `LDAP Authentication <https://enterprise.docs.scylladb.com/stable/operating-scylla/security/ldap-authentication.html>`_
.. panel-box::
:title: Scylla Enterprise 2022.1 Features
:id: "getting-started"
:class: my-panel
The following are **new features** in ScyllaDB Enterprise 2022.1.x:
* :doc:`Virtual Tables </operating-scylla/admin-tools/virtual-tables/>` - Tables that retrieve system-level information by generating their contents on-the-fly when queried.
* Virtual table for configuration - ``system.config``, allows you to query and update configuration over CQL.
* Virtual tables for exposing system-level information, such as cluster status, version-related information, etc.
See the `Release Notes <https://www.scylladb.com/product/release-notes/>`_ for more information.
.. panel-box::
:title: Scylla Enterprise 2021.1 Features
:id: "getting-started"
:class: my-panel
The following are **new features** for Scylla Scylla Enterprise 2021.1.x:
* `Space Amplification Goal (SAG) <https://enterprise.docs.scylladb.com/stable/cql/compaction.html>`_ for ICS - new CQL option to set a Space Amplification Goal (SAG) in Incremental Compaction Strategy (ICS).
* Scylla Unified Installer - Scylla is now available as an all-in-one binary tar file. You can download the tar file from the `Scylla Download Center <https://www.scylladb.com/download/?platform=tar>`_.
* :doc:`Change Data Capture (CDC) </using-scylla/cdc/index>` query the history of all changes made to the table. From *Scylla Enterprise 2021.1.1*
Read the `Release Notes <https://www.scylladb.com/product/release-notes/>`_ for more information.
.. panel-box::
:title: Scylla Enterprise 2020.1 Features
:id: "getting-started"
:class: my-panel
The following are **new features** for Scylla Scylla Enterprise 2020.1.x:
* :doc:`Lightweight Transactions (LWT) </using-scylla/lwt>` - Allows you to create and manipulate data according to a specified condition. :ref:`Lightweight Transactions CQL <IF>` Reference.
* :doc:`Scylla Alternator: an Amazon DynamoDB™-compatible API </using-scylla/alternator/index>`
* :ref:`Group Results <group-by-clause>` - using the CQL ``GROUP BY`` option you can condense into a single row all selected rows that share the same values for a set of columns.
* :ref:`Like Operator <like-operator>` - when used on ``SELECT`` statements informs Scylla that you are looking for a pattern match. The expression ‘column LIKE pattern’ yields true only if the entire column value matches the pattern.
* :ref:`Open range deletions <open-range-deletions>` - deletes rows based on an open-ended request (>, <, >=, =<, etc.)
* :ref:`Auto-expanding Replication Factor <replication-strategy>` - allows you to set a single replication factor for all Data Centers, including all existing Data Centers.
* :ref:`Non-Frozen UDTs <udts>` - User Defined Types that are not in a collection do not have to be frozen. UDTs in a collection must be frozen.
* :ref:`CQL Per Partition Limit <limit-clause>` - This new per partition limit further allows you to set the number of partitions returned as a result. You can mix both row limits and per partition limits in the same CQL statement.
* :ref:`BYPASS CACHE <bypass-cache>` - This CQL command introduced in Scylla Enterprise 2019.1.1, now available in open source, informs the database that the data being read is unlikely to be read again in the near future, and also was unlikely to have been read in the near past; therefore no attempt should be made to read it from the cache or to populate the cache with the data.
Read the `Release Notes <https://www.scylladb.com/product/release-notes/>`_ for more information.
.. panel-box::
:title: Scylla Enterprise 2019.1 Features
:id: "getting-started"
:class: my-panel
The following are **new features** for Scylla Scylla Enterprise 2019.1.x:
* :ref:`Incremental Compaction Strategy <incremental-compaction-strategy-ics>` - (version 2019.1.4) - significantly lowers SA (size amplification) for workloads which run STCS and should be used instead of STCS.
* :ref:`IPv6 <ipv6_addresses>` (version 2019.1.4) support for client-to-node, node-to-node, Manager to node, and Monitoring to node communication - Scylla now supports IPv6 Global Scope Addresses for all IPs: seeds, listen_address, broadcast_address etc. This functionality is available for Scylla Manager in Scylla Manager 2.0.
* `Workload Prioritization <https://enterprise.docs.scylladb.com/stable/using-scylla/workload-prioritization.html>`_ - Grant a level of service to roles in your organization.
* :doc:`Scylla Materialized Views </using-scylla/materialized-views>` - An alternate view table for finding a partition by the value of another column.
* :doc:`Global Secondary Indexes </using-scylla/secondary-indexes>` - A mechanism for allowing efficient searches on non-partition keys using Materialized Views.
* :doc:`Local Secondary Indexes </using-scylla/local-secondary-indexes>` - More efficient Secondary Index searches when the base table and index share the same partition key.
* :ref:`ALLOW FILTERING CQL Command <allow-filtering>` that allows for server side data filtering that is not based on the primary key.
* :doc:`Hinted Handoff </architecture/anti-entropy/hinted-handoff>` - ensures availability and consistency
* :doc:`SSTable 3.0 </architecture/sstable/sstable3/index>` - new SSTable format
* `Full (multi-partition) <https://www.scylladb.com/2018/11/01/more-efficient-range-scan-paging-with-scylla-3-0/>`_ blog describing improvements for fulll scans.
* :doc:`Role Based Access Control (RBAC) </operating-scylla/security/rbac-usecase>` - compatible with Apache Cassandra 3.x using CQL commands to :ref:`grant roles <cql-security>` to users in an organization.
* :ref:`GoogleCloudSnitch <googlecloudsnitch>`- optimized for use with GCE instances
* `Large Partitions Support <https://www.scylladb.com/2018/09/11/large-partitions-support-scylla-2-3/>`_ - Scylla supports large partitions.
* `Encryption at Rest <https://enterprise.docs.scylladb.com/stable/operating-scylla/security/encryption-at-rest.html>`_ - protects your data persisted in storage or backup.
* :ref:`BYPASS CACHE <bypass-cache>` - This CQL command informs the database that the data being read is unlikely to be read again in the near future, and also was unlikely to have been read in the near past; therefore no attempt should be made to read it from the cache or to populate the cache with the data.
Read the `Release Notes <https://www.scylladb.com/product/release-notes/>`_ for more information.
.. panel-box::
:title: Scylla Enterprise 2018.1 Features
:id: "getting-started"
:class: my-panel
The following are **new features** for Scylla Scylla Enterprise 2018.1.x
* `Scylla Auditing Guide <https://enterprise.docs.scylladb.com/stable/operating-scylla/security/auditing.html>`_ - allows administrators to know which users performed what action at what time.
* :doc:`Scylla Counters </using-scylla/counters/>` - A data type for counting
* :ref:`Time Window Compaction Strategy <time-window-compactionstrategy-twcs>` - a replacement compaction strategy for Date-Tiered Compaction Strategy, refined for time-series data.
* `Heat Weighted Load Balancing <https://www.scylladb.com/2017/09/21/scylla-heat-weighted-load-balancing/>`_ a blog entry which investigates what happens if one of the nodes loses its cache and the solution Heat Weighted Load Balancing.
Read the `Release Notes <https://www.scylladb.com/product/release-notes/>`_ for more information.

93
docs/using-scylla/features-open-source.rst
View File

@@ -1,93 +0,0 @@
===========================
Scylla Open Source Features
===========================
.. toctree::
:maxdepth: 2
:hidden:
Lightweight Transactions </using-scylla/lwt/>
Global Secondary Indexes </using-scylla/secondary-indexes/>
Local Secondary Indexes </using-scylla/local-secondary-indexes/>
Materialized Views </using-scylla/materialized-views/>
Counters </using-scylla/counters/>
Change Data Capture </using-scylla/cdc/index>
.. panel-box::
:title: Scylla Open Source 5.x Features
:id: "getting-started"
:class: my-panel
The following are **new features** for Scylla Open Source 5.x:
* :doc:`Strongly consistent schema management based on the Raft consensus algorithm </architecture/raft/>`. With
the implementation of Raft, schema changes in ScyllaDB are safe, including concurrent schema updates.
This feature is experimental in version 5.0 and needs to be explicitly enabled.
* :doc:`Scylla SStable tool </operating-scylla/admin-tools/scylla-sstable/>` - An admin tool that allows you to examine the content of SStables by performing operations such as dumping the content of SStables, generating a histogram, validating the content of SStables, and more.
* :doc:`Scylla Types tool </operating-scylla/admin-tools/scylla-types/>` - An admin tool that allows you to examine raw values obtained from SStables, logs, coredumps, etc., by printing, validating or comparing the values.
* :doc:`Virtual Tables </operating-scylla/admin-tools/virtual-tables/>` - Tables that retrieve system-level information by generating their contents on-the-fly when queried.
* Virtual table for configuration - ``system.config``, allows you to query and update configuration over CQL.
* Virtual tables for exposing system-level information, such as cluster status, version-related information, etc.
* :ref:`Automatic management of tombstone garbage collection <ddl-tombstones-gc>` -
An automatic mechanism replaces the ``gc_grace_seconds`` option to ensure better database consistency
by removing a tombstone only after the range that covers the tombstone is repaired. This feature is
experimental in version 5.0 and needs to be explicitly enabled by configuring the ``tombstone_gc`` option.
* :doc:`Expiration service in Scylla Alternator </alternator/compatibility>` - Support
for DynamoDB's TTL feature for detecting and deleting expired items in the table. This feature is experimental in version 5.0
See the `Release Notes <https://www.scylladb.com/product/release-notes/>`_ for more information.
.. panel-box::
:title: Scylla Open Source 4.x Features
:id: "getting-started"
:class: my-panel
The following are **new features** for Scylla Open Source 4.x
* :doc:`Lightweight Transactions (LWT) </using-scylla/lwt>` - Allows you to create and manipulate data according to a specified condition. :ref:`Lightweight Transactions CQL <IF>` Reference.
* :doc:`Scylla Alternator: an Amazon DynamoDB™-compatible API </using-scylla/alternator/index>`
* :doc:`Change Data Capture (CDC) </using-scylla/cdc/index>` query the history of all changes made to the table. **GA** in Scylla 4.3. In versions prior to Scylla Open Source 4.3, CDC is an experimental feature and you need to enable it in order to use it.
.. panel-box::
:title: Scylla Open Source 3.x Features
:id: "getting-started"
:class: my-panel
The following are **new features** for Scylla Open Source 3.3
* :doc:`Clients Table </troubleshooting/clients-table>` real-time information on CQL clients connected to the Scylla cluster.
The following are **new features** for Scylla Open Source 3.2.x
* :ref:`IPv6 <ipv6_addresses>` support for client-to-node, node-to-node, Manager to node, and Monitor to node communication - Scylla now supports IPv6 Global Scope Addresses for all IPs: seeds, listen_address, broadcast_address etc. This functionality is available for Scylla Manager in Scylla Manager 2.0 and in Scylla Monitor in 3.0.
* :ref:`Like Operator <like-operator>` - when used on ``SELECT`` statements informs Scylla that you are looking for a pattern match. The expression ‘column LIKE pattern’ yields true only if the entire column value matches the pattern.
* :ref:`Group Results <group-by-clause>` - using the CQL ``GROUP BY`` option you can condense into a single row all selected rows that share the same values for a set of columns.
* :ref:`Non-Frozen UDTs <udts>` - User Defined Types that are not in a collection do not have to be frozen. UDTs in a collection must be frozen.
* :ref:`Auto-expanding Replication Factor <replication-strategy>` - allows you to set a single replication factor for all Data Centers, including all existing Data Centers.
* :ref:`Open range deletions <open-range-deletions>` - deletes rows based on an open-ended request (>, <, >=, =<, etc.)
The following are **new features** for Scylla Open Source 3.1.x
* :ref:`CQL Per Partition Limit <limit-clause>` - This new per partition limit further allows you to set the number of partitions returned as a result. You can mix both row limits and per partition limits in the same CQL statement.
* :doc:`Local Secondary Indexes </using-scylla/local-secondary-indexes>` - More efficient Secondary Index searches when the base table and index share the same partition key.
* :ref:`BYPASS CACHE <bypass-cache>` - This CQL command introduced in Scylla Enterprise 2019.1.1, now available in open source, informs the database that the data being read is unlikely to be read again in the near future, and also was unlikely to have been read in the near past; therefore no attempt should be made to read it from the cache or to populate the cache with the data.
* :doc:`Large Cell / Collection Detector </troubleshooting/large-rows-large-cells-tables>` - Makes finding large partitions easier.
* :doc:`Nodetool toppartitions </operating-scylla/nodetool-commands/toppartitions>` - Samples cluster writes and reads and reports the most active partitions in a specified table and time frame.
* :ref:`Row-level Repair <row-level-repair>` - :doc:`nodetool repair </operating-scylla/nodetool-commands/repair>` operation now uses row-level repair, adding additional granularity with repairs.
* :ref:`ALLOW FILTERING CQL Command <allow-filtering>` that allows for server side data filtering that is not based on the primary key. Introduced in 3.0, this feature was further enhanced in version 3.1.
The following are **new features** for Scylla Open Source 3.0.x
* :doc:`Scylla Materialized Views </using-scylla/materialized-views>` - An alternate view table for finding a partition by the value of another column. Experimental in prior versions, this feature was made production ready in Scylla Open Source 3.0.
* :doc:`Global Secondary Indexes </using-scylla/secondary-indexes>` - A mechanism for allowing efficient searches on non-partition keys using Materialized Views. Experimental in prior versions, this feature was made production ready in Scylla Open Source 3.0.
* :doc:`Hinted Handoff </architecture/anti-entropy/hinted-handoff>` - ensures availability and consistency
* :doc:`SSTable 3.0 </architecture/sstable/sstable3/index>` - new SSTable format
* :ref:`ALLOW FILTERING CQL Command <allow-filtering>` that allows for server side data filtering that is not based on the primary key.
More information in the `Release Notes <https://www.scylladb.com/product/release-notes/>`_.

22
docs/using-scylla/features.rst
View File

@@ -3,16 +3,16 @@ ScyllaDB Features
.. toctree::
:maxdepth: 2
:hidden:
:maxdepth: 1
features-open-source
features-ent
.. panel-box::
:title: Scylla Features
:id: "getting-started"
:class: my-panel
Lightweight Transactions </using-scylla/lwt/>
Global Secondary Indexes </using-scylla/secondary-indexes/>
Local Secondary Indexes </using-scylla/local-secondary-indexes/>
Materialized Views </using-scylla/materialized-views/>
Counters </using-scylla/counters/>
Change Data Capture </using-scylla/cdc/index>
Workload Attributes <workload-attributes>
* :doc:`ScyllaDB Open Source Features </using-scylla/features-open-source/>`
* :doc:`ScyllaDB Enterprise Features </using-scylla/features-ent/>`
`ScyllaDB Enterprise <https://enterprise.docs.scylladb.com/stable/overview.html#enterprise-only-features>`_
provides additional premium features, including Encryption at Rest,
workload prioritization, auditing, and more.

1
docs/using-scylla/index.rst
View File

@@ -11,7 +11,6 @@ ScyllaDB for Developers
ScyllaDB Alternator <alternator/index>
ScyllaDB Features <features>
ScyllaDB Drivers <drivers/index>
Workload Attributes <workload-attributes>
.. panel-box::