diff --git a/doc/modules/cassandra/pages/developing/cql/indexing/sai/_sai-create.adoc b/doc/modules/cassandra/pages/developing/cql/indexing/sai/_sai-create.adoc index d7a5c708f8..1e5c4760b8 100644 --- a/doc/modules/cassandra/pages/developing/cql/indexing/sai/_sai-create.adoc +++ b/doc/modules/cassandra/pages/developing/cql/indexing/sai/_sai-create.adoc @@ -1,7 +1,9 @@ = Create SAI index :description: Create SAI index for CQL table schema using `cqlsh`. -To create an SAI index, you must define the index name, table name, and column name for the column to be indexed. +To create an SAI index, you must define the index name, table name, and column name for the column to be indexed. + +include::cassandra:partial$index-naming.adoc[] To create a simple SAI index: diff --git a/doc/modules/cassandra/pages/getting-started/sai-quickstart.adoc b/doc/modules/cassandra/pages/getting-started/sai-quickstart.adoc index 12cb6092e6..16cd3e66ff 100644 --- a/doc/modules/cassandra/pages/getting-started/sai-quickstart.adoc +++ b/doc/modules/cassandra/pages/getting-started/sai-quickstart.adoc @@ -40,6 +40,8 @@ Use xref:reference/cql-commands/create-custom-index.adoc[CREATE CUSTOM INDEX] co include::cassandra:example$CQL/sai/cyclist_semi_pro_sai_indices.cql[tag=createQuickStartIndices] ---- +include::cassandra:partial$index-naming.adoc[] + Let's take a look at the description of the table and its indexes: [tabs] ==== diff --git a/doc/modules/cassandra/pages/reference/cql-commands/create-custom-index.adoc b/doc/modules/cassandra/pages/reference/cql-commands/create-custom-index.adoc index b4dc08566f..85c56721b7 100644 --- a/doc/modules/cassandra/pages/reference/cql-commands/create-custom-index.adoc +++ b/doc/modules/cassandra/pages/reference/cql-commands/create-custom-index.adoc @@ -54,6 +54,8 @@ index_name:: Optional identifier for index. If no name is specified, the default used is `\_\_idx`. Enclose in quotes to use special characters or to preserve capitalization. ++ +include::cassandra:partial$index-naming.adoc[] column_name:: The name of the table column on which the SAI index is being defined. diff --git a/doc/modules/cassandra/pages/reference/cql-commands/create-index.adoc b/doc/modules/cassandra/pages/reference/cql-commands/create-index.adoc index ae95c33a1d..cf404dff04 100644 --- a/doc/modules/cassandra/pages/reference/cql-commands/create-index.adoc +++ b/doc/modules/cassandra/pages/reference/cql-commands/create-index.adoc @@ -65,7 +65,7 @@ SAI returns `InvalidRequestException` if you try to define an index on a column == Optional parameters -[cols="1,3"] +[cols="1,3"] |=== | Parameter | Description @@ -75,6 +75,8 @@ SAI returns `InvalidRequestException` if you try to define an index on a column Enclose in quotes to use special characters or preserve capitalization. If no name is specified, {product} names the index as `\_\_idx`. +include::cassandra:partial$index-naming.adoc[] + | keyspace_name | Name of the keyspace that contains the table to index. If no name is specified, the current keyspace is used. diff --git a/doc/modules/cassandra/partials/index-naming.adoc b/doc/modules/cassandra/partials/index-naming.adoc new file mode 100644 index 0000000000..ceb8320076 --- /dev/null +++ b/doc/modules/cassandra/partials/index-naming.adoc @@ -0,0 +1,6 @@ +[WARNING] +==== +Index names are unique per keyspace. +The index name must be a unique identifier for the index for each table within a keyspace. +This requirement is true for both vector and non-vector indexes. +==== \ No newline at end of file