Skip to content

Commit e852cba

Browse files
committed
GEOMESA-3435. mention scylladb in docs
1 parent 06c6b41 commit e852cba

File tree

15 files changed

+75
-59
lines changed

15 files changed

+75
-59
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ geospatial analytics.
2929
* Quick Starts:
3030
[Accumulo](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-accumulo.html) |
3131
[HBase](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-hbase.html) |
32-
[Cassandra](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-cassandra.html) |
32+
[Cassandra / ScyllaDB](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-cassandra.html) |
3333
[Kafka](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-kafka.html) |
3434
[Redis](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-redis.html) |
3535
[FileSystem](https://www.geomesa.org/documentation/current/tutorials/geomesa-quickstart-fsds.html)
@@ -42,7 +42,7 @@ geospatial analytics.
4242
    
4343
[**Accumulo**](https://github.com/locationtech/geomesa/releases/download/geomesa-5.1.0/geomesa-accumulo_2.12-5.1.0-bin.tar.gz) |
4444
[**HBase**](https://github.com/locationtech/geomesa/releases/download/geomesa-5.1.0/geomesa-hbase_2.12-5.1.0-bin.tar.gz) |
45-
[**Cassandra**](https://github.com/locationtech/geomesa/releases/download/geomesa-5.1.0/geomesa-cassandra_2.12-5.1.0-bin.tar.gz) |
45+
[**Cassandra / ScyllaDB**](https://github.com/locationtech/geomesa/releases/download/geomesa-5.1.0/geomesa-cassandra_2.12-5.1.0-bin.tar.gz) |
4646
[**Kafka**](https://github.com/locationtech/geomesa/releases/download/geomesa-5.1.0/geomesa-kafka_2.12-5.1.0-bin.tar.gz) |
4747
[**Redis**](https://github.com/locationtech/geomesa/releases/download/geomesa-5.1.0/geomesa-redis_2.12-5.1.0-bin.tar.gz) |
4848
[**FileSystem**](https://github.com/locationtech/geomesa/releases/download/geomesa-5.1.0/geomesa-fs_2.12-5.1.0-bin.tar.gz) |

build/templates/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ geospatial analytics.
2929
* Quick Starts:
3030
[Accumulo](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-accumulo.html) |
3131
[HBase](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-hbase.html) |
32-
[Cassandra](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-cassandra.html) |
32+
[Cassandra / ScyllaDB](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-cassandra.html) |
3333
[Kafka](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-kafka.html) |
3434
[Redis](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-redis.html) |
3535
[FileSystem](https://www.geomesa.org/documentation/current/tutorials/geomesa-quickstart-fsds.html)
@@ -42,7 +42,7 @@ geospatial analytics.
4242
    
4343
[**Accumulo**](https://github.com/locationtech/geomesa/releases/download/geomesa-${geomesa.release.version}/geomesa-accumulo_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz) |
4444
[**HBase**](https://github.com/locationtech/geomesa/releases/download/geomesa-${geomesa.release.version}/geomesa-hbase_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz) |
45-
[**Cassandra**](https://github.com/locationtech/geomesa/releases/download/geomesa-${geomesa.release.version}/geomesa-cassandra_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz) |
45+
[**Cassandra / ScyllaDB**](https://github.com/locationtech/geomesa/releases/download/geomesa-${geomesa.release.version}/geomesa-cassandra_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz) |
4646
[**Kafka**](https://github.com/locationtech/geomesa/releases/download/geomesa-${geomesa.release.version}/geomesa-kafka_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz) |
4747
[**Redis**](https://github.com/locationtech/geomesa/releases/download/geomesa-${geomesa.release.version}/geomesa-redis_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz) |
4848
[**FileSystem**](https://github.com/locationtech/geomesa/releases/download/geomesa-${geomesa.release.version}/geomesa-fs_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz) |

docs/common.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@
9999
100100
.. |cassandra_version| replace:: 3
101101
102+
.. |scylladb_version| replace:: 6.2
103+
102104
.. |redis_supported_versions| replace:: versions 5.0 and later
103105
104106
.. |spark_required_version| replace:: %(spark_version)s

docs/tutorials/geomesa-quickstart-cassandra.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
GeoMesa Cassandra Quick Start
2-
=============================
1+
GeoMesa Cassandra / ScyllaDB Quick Start
2+
========================================
33

4-
This tutorial is the fastest and easiest way to get started with GeoMesa using Cassandra.
4+
This tutorial is the fastest and easiest way to get started with GeoMesa using Cassandra / ScyllaDB.
55
It is a good stepping-stone on the path to the other tutorials, that present increasingly
66
involved examples of how to use GeoMesa.
77

@@ -12,9 +12,9 @@ In the spirit of keeping things simple, the code in this tutorial only
1212
does a few small things:
1313

1414
1. Establishes a new (static) SimpleFeatureType
15-
2. Prepares the Cassandra tables to store this type of data
15+
2. Prepares the Cassandra / ScyllaDB tables to store this type of data
1616
3. Creates a few thousand example SimpleFeatures
17-
4. Writes these SimpleFeatures to Cassandra
17+
4. Writes these SimpleFeatures to Cassandra / ScyllaDB
1818
5. Queries for a given geographic rectangle, time range, and attribute
1919
filter, writing out the entries in the result set
2020
6. Uses GeoServer to visualize the data (optional)
@@ -27,22 +27,22 @@ Before you begin, you must have the following installed and configured:
2727
- `Java <https://adoptium.net/temurin/releases/>`__ JDK 1.8
2828
- Apache `Maven <https://maven.apache.org/>`__ |maven_version|
2929
- a GitHub client
30-
- a Cassandra |cassandra_version| instance, either standalone or cluster
31-
- a Cassandra user that has both create-table and write permissions
30+
- a Cassandra |cassandra_version| instance or a ScyllaDB |scylladb_version| instance, either standalone or cluster
31+
- a Cassandra / ScyllaDB user that has both create-table and write permissions
3232
(not needed for standalone instances)
3333

34-
Create A Cassandra Namespace
35-
----------------------------
34+
Create A Cassandra / ScyllaDB Namespace
35+
---------------------------------------
3636

37-
You will need a namespace in Cassandra to contain the tutorial tables. The easiest way to do
37+
You will need a namespace in Cassandra / ScyllaDB to contain the tutorial tables. The easiest way to do
3838
this is with the ``cqlsh`` tool provided with Cassandra distributions. Start ``cqlsh``, then type:
3939

4040
.. code-block:: bash
4141
4242
cqlsh> CREATE KEYSPACE geomesa WITH REPLICATION = {'class': 'SimpleStrategy', 'replication_factor' : 3};
4343
4444
This creates a key space called "geomesa". This is a top-level name
45-
space within Cassandra and it will provide a place for GeoMesa to put
45+
space within Cassandra / ScyllaDB and it will provide a place for GeoMesa to put
4646
all of its data, including data for spatial features and associated
4747
metadata.
4848

@@ -88,20 +88,20 @@ On the command line, run:
8888
8989
where you provide the following arguments:
9090

91-
- ``<host:port>`` the hostname and port your Cassandra instance is
92-
running on. For Cassandra standalone this will be ``localhost:9042``. More
91+
- ``<host:port>`` the hostname and port your Cassandra / ScyllaDB instance is
92+
running on. For Cassandra / ScyllaDB standalone this will be ``localhost:9042``. More
9393
information on how to find your connection is available
94-
`here <https://www.geomesa.org/documentation/user/cassandra/install.html#connecting-to-cassandra>`__.
94+
`here <https://www.geomesa.org/documentation/user/cassandra/install.html#connecting-to-cassandra-/-scylladb>`__.
9595
- ``<keyspace>`` keyspace your table will be put into. If you followed the instructions above,
9696
this will be ``geomesa``. More information on how to setup keyspaces is available
97-
`here <https://www.geomesa.org/documentation/user/cassandra/install.html#connecting-to-cassandra>`__.
97+
`here <https://www.geomesa.org/documentation/user/cassandra/install.html#connecting-to-cassandra-/-scylladb>`__.
9898
- ``<table>`` the name of the destination table that will
9999
accept these test records. This table should either not exist or
100100
should be empty
101-
- ``<user>`` (optional) the name of a Cassandra user that has
101+
- ``<user>`` (optional) the name of a Cassandra / ScyllaDB user that has
102102
permissions to create, read and write tables
103103
- ``<password>`` (optional) the password for the previously-mentioned
104-
Cassandra user
104+
Cassandra / ScyllaDB user
105105

106106
Optionally, you can also specify that the quick start should delete its data upon completion. Use the
107107
``--cleanup`` flag when you run to enable this behavior.
@@ -256,7 +256,7 @@ Register the GeoMesa Store with GeoServer
256256
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
257257

258258
Log into GeoServer using your user and password credentials. Click
259-
"Stores" and "Add new Store". Select the ``Cassandra (GeoMesa)`` vector data
259+
"Stores" and "Add new Store". Select the ``Cassandra / ScyllaDB (GeoMesa)`` vector data
260260
source, and fill in the required parameters.
261261

262262
Basic store info:
@@ -269,7 +269,7 @@ Connection parameters:
269269

270270
- these are the same parameter values that you supplied on the
271271
command line when you ran the tutorial; they describe how to connect
272-
to the Cassandra instance where your data reside
272+
to the Cassandra / ScyllaDB instance where your data reside
273273

274274
Click "Save", and GeoServer will search your Cassandra table for any
275275
GeoMesa-managed feature types.

docs/user/cassandra/commandline.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ Once installed, the tools should be available through the command ``geomesa-cass
1515
Commands:
1616
...
1717

18-
All Cassandra commands are described in the common tools chapter :doc:`/user/cli/index`.
18+
All Cassandra / ScyllaDB commands are described in the common tools chapter :doc:`/user/cli/index`.
1919

2020
General Arguments
2121
-----------------
2222

23-
Most commands require you to specify the connection to Cassandra. This generally includes a contact point,
23+
Most commands require you to specify the connection to Cassandra / ScyllaDB. This generally includes a contact point,
2424
key space, username and password. Specify the contact point and key space with ``--contact-point`` and
2525
``--key-space`` (or ``-P`` and ``-k``). Specify the username and password with ``--user`` and ``--password``
2626
(or ``-u`` and ``-p``). In order to avoid plaintext passwords in the bash history

docs/user/cassandra/configuration.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
Cassandra Configuration
2-
=======================
1+
Cassandra / ScyllaDB Configuration
2+
==================================
33

4-
This section details Cassandra-specific configuration properties. For general properties,
4+
This section details Cassandra / ScyllaDB specific configuration properties. For general properties,
55
see :ref:`geomesa_site_xml`.
66

77
Connection Properties
88
---------------------
99

10-
The following properties control the configuration of the Cassandra session.
10+
The following properties control the configuration of the Cassandra / ScyllaDB session.
1111

1212
geomesa.cassandra.connection.timeout
1313
++++++++++++++++++++++++++++++++++++

docs/user/cassandra/geoserver.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ interface by clicking "Data > Stores" in the left-hand menu and then
1212
clicking "Add new Store".
1313

1414
If you have properly installed the GeoMesa Cassandra GeoServer plugin as described
15-
in :ref:`install_cassandra_geoserver`, "Cassandra (GeoMesa)" should be included in the list
15+
in :ref:`install_cassandra_geoserver`, "Cassandra / ScyllaDB (GeoMesa)" should be included in the list
1616
under **Vector Data Sources**. If you do not see this, check that you unpacked the
1717
plugin JARs into in the right directory and restart GeoServer.
1818

19-
On the "Add Store" page, select "Cassandra (GeoMesa)", and fill out the
19+
On the "Add Store" page, select "Cassandra / ScyllaDB (GeoMesa)", and fill out the
2020
parameters. The parameters are described in :ref:`cassandra_parameters`.
2121

22-
Click "Save", and GeoServer will search Cassandra for any GeoMesa-managed feature types.
22+
Click "Save", and GeoServer will search Cassandra / ScyllaDB for any GeoMesa-managed feature types.

docs/user/cassandra/heatmaps.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Cassandra Heatmaps
22
==================
33

4-
Cassandra can generate client-side heatmaps in GeoServer by defining a style and using the built in ``gs:Heatmap``
4+
Cassandra / ScyllaDB can generate client-side heatmaps in GeoServer by defining a style and using the built in ``gs:Heatmap``
55
process within GeoServer.
66

77
To start, add a new SLD style to GeoServer named "heatmap" and use this sld

docs/user/cassandra/index.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,25 @@
1-
Cassandra Data Store
1+
Cassandra / ScyllaDB Data Store
22
====================
33

44
.. note::
55

66
GeoMesa currently supports Cassandra version |cassandra_version|.
77

8+
.. note::
9+
10+
GeoMesa currently supports ScyllaDB version |scylladb_version|.
11+
812
The GeoMesa Cassandra Data Store is an implementation of the GeoTools
9-
``DataStore`` interface that is backed by `Apache Cassandra`_.
13+
``DataStore`` interface that is backed by `Apache Cassandra`_ or `ScyllaDB`.
1014
It is found in the ``geomesa-cassandra`` directory of the GeoMesa
11-
source distribution.
15+
source distribution. As `ScyllaDB` is API-compatible with `Apache Cassandra`_,
16+
it is also supported and work with the same configuration
17+
just by pointing to `ScyllaDB`_ in connection string.
1218

1319
.. _Apache Cassandra: https://cassandra.apache.org/
1420

21+
.. _ScyllaDB: https://www.scylladb.com/
22+
1523
.. toctree::
1624
:maxdepth: 1
1725

docs/user/cassandra/install.rst

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ Installing GeoMesa Cassandra
55

66
GeoMesa currently supports Cassandra version |cassandra_version|.
77

8+
.. note::
9+
10+
GeoMesa currently supports ScyllaDB version |scylladb_version|.
11+
812
.. note::
913

1014
The examples below expect a version to be set in the environment:
@@ -14,23 +18,25 @@ Installing GeoMesa Cassandra
1418
$ export TAG="|release_version|"
1519
$ export VERSION="|scala_binary_version|-${TAG}" # note: |scala_binary_version| is the Scala build version
1620
17-
Connecting to Cassandra
18-
-----------------------
21+
Connecting to Cassandra or ScyllaDB
22+
-----------------------------------
1923

20-
The first step to getting started with Cassandra and GeoMesa is to install
21-
Cassandra itself. You can find good directions for downloading and installing
22-
Cassandra online. For example, see Cassandra's official `getting started`_ documentation.
24+
The first step to getting started with Cassandra / ScyllaDB and GeoMesa is to install
25+
Cassandra / ScyllaDB itself. You can find good directions for downloading and installing
26+
Cassandra / ScyllaDB online. For example, see Cassandra's official `getting started`_ or official `ScyllaDB's getting started`_ documentation.
2327

2428
.. _getting started: https://cassandra.apache.org/doc/latest/getting_started/index.html
2529

26-
Once you have Cassandra installed, the next step is to prepare your Cassandra installation
27-
to integrate with GeoMesa. First, create a key space within Cassandra. The easiest way to
28-
do this with ``cqlsh``, which should have been installed as part of your Cassandra installation.
30+
.. _ScyllaDB's getting started: https://opensource.docs.scylladb.com/stable/getting-started/index.html
31+
32+
Once you have Cassandra / ScyllaDB installed, the next step is to prepare your Cassandra / ScyllaDB installation
33+
to integrate with GeoMesa. First, create a key space within Cassandra / ScyllaDB. The easiest way to
34+
do this with ``cqlsh``, which should have been installed as part of your Cassandra / ScyllaDB installation.
2935
Start ``cqlsh``, then type::
3036

3137
CREATE KEYSPACE mykeyspace WITH REPLICATION = {'class': 'SimpleStrategy', 'replication_factor' : 3};
3238

33-
This creates a key space called "mykeyspace". This is a top-level name space within Cassandra
39+
This creates a key space called "mykeyspace". This is a top-level name space within Cassandra / ScyllaDB
3440
and it will provide a place for GeoMesa to put all of its data, including data for spatial features
3541
and associated metadata.
3642

@@ -40,12 +46,12 @@ installation. To set the variable add the following line to your ``.profile`` or
4046

4147
export CASSANDRA_HOME=/path/to/cassandra
4248

43-
Finally, make sure you know a contact point for your Cassandra instance.
44-
If you are just trying things locally, and using the default Cassandra settings,
49+
Finally, make sure you know a contact point for your Cassandra / ScyllaDB instance.
50+
If you are just trying things locally, and using the default Cassandra / ScyllaDB settings,
4551
the contact point would be ``127.0.0.1:9042``. You can check and configure the
46-
port you are using using the ``native_transport_port`` in the Cassandra
52+
port you are using using the ``native_transport_port`` in the Cassandra / ScyllaDB
4753
configuration file (located at ``conf/cassandra.yaml`` in your Cassandra
48-
installation directory).
54+
installation directory, ``/etc/scylla/scylla.yaml`` for ScyllaDB accordingly).
4955

5056
Installing from the Binary Distribution
5157
---------------------------------------

0 commit comments

Comments
 (0)