You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: in-progress/administration.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -352,8 +352,8 @@ OPTIONS
352
352
====
353
353
Removing a user removes their access to your organization, but it doesn't delete their account.
354
354
355
-
The user retains their personal {astra_db} account under their associated email address, including access to their default (personal) organization and any other organizations they belong to.
356
-
The user can still access their personal {astra_db} account, if they have access to the associated xref:astra-db-serverless:administration:invite-users-to-organization.adoc#accept-the-invite[authentication method].
355
+
The user retains their personal {product-short} account under their associated email address, including access to their default (personal) organization and any other organizations they belong to.
356
+
The user can still access their personal {product-short} account, if they have access to the associated xref:astra-db-serverless:administration:invite-users-to-organization.adoc#accept-the-invite[authentication method].
357
357
358
358
If your organization uses SSO, make sure that you also remove the user from your IdP, if necessary.
CDC for {astra_db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra_stream}] where it can be processed by client applications or sent to downstream systems.
962
+
CDC for {astra-db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra-stream}] where it can be processed by client applications or sent to downstream systems.
963
963
964
964
For more information about using the {product} to configure CDC, see xref:ROOT:managing.adoc#cdc[Configure Change Data Capture].
965
965
@@ -1033,12 +1033,12 @@ OPTIONS
1033
1033
1034
1034
== Create environment variables
1035
1035
1036
-
When developing applications with {astra_stream} APIs, you will notice common values that are frequently reused, such as Pulsar tokens, broker URLs, and web service URLs.
1036
+
When developing applications with {astra-stream} APIs, you will notice common values that are frequently reused, such as Pulsar tokens, broker URLs, and web service URLs.
1037
1037
It's a good practice to store these values in environment variables to facilitate reuse in your scripts, simplify token rotation, and increase security by keeping sensitive information separate from your core application code.
1038
1038
1039
-
The {product} can automatically generate a set of relevant variables for an {astra_stream} tenant that you can use in your applications.
1039
+
The {product} can automatically generate a set of relevant variables for an {astra-stream} tenant that you can use in your applications.
1040
1040
1041
-
Use the `astra streaming create-dotenv` command to generate a `.env` file containing relevant environment variables for a specific {astra_stream} tenant:
1041
+
Use the `astra streaming create-dotenv` command to generate a `.env` file containing relevant environment variables for a specific {astra-stream} tenant:
Copy file name to clipboardExpand all lines: in-progress/change-data-capture.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
= Configure Change Data Capture (CDC) with the {product}
2
2
:navtitle: Change Data Capture quickstart
3
3
4
-
Change Data Capture (CDC) for {astra_db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra_stream}] where it can be processed by client applications or sent to downstream systems.
4
+
Change Data Capture (CDC) for {astra-db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra-stream}] where it can be processed by client applications or sent to downstream systems.
5
5
6
-
This page provides an end-to-end example that shows you how to use the {product} to enable CDC for an {astra-db} database.
6
+
This page provides an end-to-end example that shows you how to use the {product} to enable CDC for an {astra} database.
7
7
8
8
== Create a database
9
9
10
-
Create an {astra_db} database:
10
+
Create a database:
11
11
12
12
[source,shell]
13
13
----
@@ -25,7 +25,7 @@ Database 'cdc_demo_db' has been created with id 'ce5e563c-3248-4064-b03c-5892433
25
25
26
26
== Create a streaming tenant
27
27
28
-
Create an {astra_stream} tenant in the same region as your database:
28
+
Create an {astra-stream} tenant in the same region as your database:
Copy file name to clipboardExpand all lines: in-progress/dsbulk.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -151,7 +151,7 @@ To resume the current operation, re-run it with the same settings, and add the f
151
151
152
152
The following end-to-end example shows how to use the {product}'s built-in DSBulk support to load data into a database, get information about the data, and unload the data into CSV files:
Copy file name to clipboardExpand all lines: in-progress/managing.adoc
+23-18Lines changed: 23 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
// Writer's note: This page is no longer published but there is still content that should be retained and reformatted for Astra CLI 1.0.
2
-
= {astra_db} commands
2
+
= {astra-db} commands
3
3
:embedding-provider-name: NVIDIA
4
4
:embedding-provider-name-api: nvidia
5
5
:embedding-provider-model-name-api: NV-Embed-QA
6
6
7
-
Use the {product} to manage your {astra_db} deployments.
7
+
Use the {product} to manage your {astra-db} databases.
8
8
9
9
[TIP]
10
10
====
@@ -14,7 +14,7 @@ You can use `**DATABASE_NAME**` instead of `**DATABASE_ID**` in all `astra db` c
14
14
== Create a database
15
15
16
16
The {product} can create {db-serverless} and {db-serverless-vector} databases with on-demand (non-PCU) capacity only.
17
-
It cannot create {db-classic} databases; however, you can use the {product} to <<get-database-details,get information>> about your existing {db-classic} databases.
17
+
It cannot create {product-short} {db-classic} (Classic) databases; however, you can use the {product} to <<get-database-details,get information>> about your existing {db-classic} databases.
18
18
19
19
If your organization requires that new databases to belong to a xref:astra-db-serverless:administration:provisioned-capacity-units.adoc[PCU group], you must xref:astra-db-serverless:databases:create-database.adoc[use the {astra-ui} or {devops-api} to create databases] because the {product} doesn't support PCU group assignment with database creation.
20
20
@@ -171,7 +171,7 @@ astra db create **DATABASE_NAME** \
171
171
172
172
//TODO: Confirm that this no longer applies.
173
173
////
174
-
The database ID, not the database name, ensures uniqueness within your {astra_db} organization.
174
+
The database ID, not the database name, ensures uniqueness within your {product-short} organization.
175
175
Consequently, if you issue the `astra db create` command multiple times, you will create multiple database instances.
176
176
To ensure that you don't create a database with the same name as another existing database, use the `--if-not-exist` option:
{astra_db} databases store data in <<manage-collections,collections>> and <<manage-tables,tables>>, which exist inside keyspaces.
186
+
{astra-db} databases store data in <<manage-collections,collections>> and <<manage-tables,tables>>, which exist inside keyspaces.
187
187
Each database must have at least one keyspace, and you can create more as needed.
188
188
189
189
Use the `astra db create-keyspace` command to create a new keyspace in a database:
@@ -282,7 +282,7 @@ The database enters *Maintenance* status while it deletes the keyspace along wit
282
282
283
283
include::ROOT:partial$async-option-active.adoc[]
284
284
285
-
If you delete the default keyspace, {astra_db} automatically selects another keyspace to be the default keyspace.
285
+
If you delete the default keyspace, {astra-db} automatically selects another keyspace to be the default keyspace.
286
286
287
287
=== `db create-keyspace` options
288
288
@@ -501,7 +501,7 @@ astra db create-collection 58747660-464b-4085-bef2-c3f3e5401e3d \
501
501
Use an {product-short}-hosted provider::
502
502
+
503
503
--
504
-
To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{astra_db} vectorize], add an embedding provider integration to your collection.
504
+
To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{product-short} vectorize], add an embedding provider integration to your collection.
505
505
Embedding provider integrations are either {product-short}-hosted or external.
506
506
507
507
This option uses an {product-short}-hosted provider:
@@ -552,10 +552,10 @@ astra db create-collection 58747660-464b-4085-bef2-c3f3e5401e3d \
552
552
Use an external provider::
553
553
+
554
554
--
555
-
To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{astra_db} vectorize], add an embedding provider integration to your collection.
555
+
To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{product-short} vectorize], add an embedding provider integration to your collection.
556
556
Embedding provider integrations are either {product-short}-hosted or external.
557
557
558
-
To use an external embedding provider, you must add an xref:astra-db-serverless:databases:embedding-generation.adoc#supported-embedding-providers[embedding provider integration] to your {astra_db} organization, and then you can select that embedding provider when you create a collection:
558
+
To use an external embedding provider, you must add an xref:astra-db-serverless:databases:embedding-generation.adoc#supported-embedding-providers[embedding provider integration] to your {product-short} organization, and then you can select that embedding provider when you create a collection:
559
559
560
560
[source,bash,subs="+quotes"]
561
561
----
@@ -1920,7 +1920,7 @@ OPTIONS
1920
1920
----
1921
1921
====
1922
1922
1923
-
== Get a list of available {astra_db} regions
1923
+
== Get a list of available {astra-db} regions
1924
1924
1925
1925
Use the `astra db list-regions-serverless` command to get a list of available regions that support {db-serverless} databases:
1926
1926
@@ -1936,7 +1936,7 @@ Use the `astra db list-regions-vector` command to get a list of available cloud
1936
1936
astra db list-regions-vector
1937
1937
----
1938
1938
1939
-
Use the `astra db list-regions-classic` command to get a list of available cloud provider regions that support {db-classic} databases:
1939
+
Use the `astra db list-regions-classic` command to get a list of available cloud provider regions that support {product-short} {db-classic} (Classic) databases:
1940
1940
1941
1941
[source,bash]
1942
1942
----
@@ -2057,6 +2057,11 @@ OPTIONS
2057
2057
2058
2058
=== `db list-regions-classic` options
2059
2059
2060
+
[TIP]
2061
+
====
2062
+
`classic` refers to {product-short} {db-classic} databases, which were previously known as {astra-db} Classic databases.
2063
+
====
2064
+
2060
2065
.Expand to see all `db list-regions-classic` options
2061
2066
[%collapsible]
2062
2067
====
@@ -3462,7 +3467,7 @@ OPTIONS
3462
3467
3463
3468
The following end-to-end example shows how to use the {product}'s built-in DSBulk support to load data into a database, get information about the data, and unload the data into CSV files:
3464
3469
3465
-
. Create an {astra_db} {db-serverless} database:
3470
+
. Create an {astra-db} {db-serverless} database:
3466
3471
+
3467
3472
[source,bash]
3468
3473
----
@@ -3680,11 +3685,11 @@ This command unloads row data from the `cities_by_country` table, and stores it
3680
3685
3681
3686
[IMPORTANT]
3682
3687
====
3683
-
CDC for {astra_db} incurs billed charges based on your {astra_stream} usage.
3684
-
For more information, see https://www.ibm.com/docs/en/astra-streaming?topic=astra-streaming-annual-price-plans[{astra_stream} pricing].
3688
+
CDC for {astra-db} incurs billed charges based on your {astra-stream} usage.
3689
+
For more information, see https://www.ibm.com/docs/en/astra-streaming?topic=astra-streaming-annual-price-plans[{astra-stream} pricing].
3685
3690
====
3686
3691
3687
-
CDC for {astra_db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra_stream}] where it can be processed by client applications or sent to downstream systems.
3692
+
CDC for {astra-db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra-stream}] where it can be processed by client applications or sent to downstream systems.
3688
3693
3689
3694
Use the `astra db create-cdc` command to create a CDC connection for a table in a {db-serverless} database:
3690
3695
@@ -3927,7 +3932,7 @@ OPTIONS
3927
3932
3928
3933
The following end-to-end example shows how to use the {product} to create a CDC connection for a table in a {db-serverless} database:
3929
3934
3930
-
. Create an {astra_db} {db-serverless} database:
3935
+
. Create an {astra-db} {db-serverless} database:
3931
3936
+
3932
3937
[source,bash]
3933
3938
----
@@ -3952,7 +3957,7 @@ get CLoud provider
3952
3957
----
3953
3958
====
3954
3959
3955
-
. Create an {astra_stream} tenant in the same region as your database:
3960
+
. Create an {astra-stream} tenant in the same region as your database:
3956
3961
+
3957
3962
[source,bash]
3958
3963
----
@@ -4203,7 +4208,7 @@ astra db download-scb **DATABASE_ID** -f **DESTINATION_FILE**.zip
4203
4208
4204
4209
== Create environment variables
4205
4210
4206
-
When developing applications with {astra_db} APIs, you will notice common values that are frequently reused, such as application tokens, database API endpoints, database IDs, and keyspace names.
4211
+
When developing applications with {astra-db} APIs, you will notice common values that are frequently reused, such as application tokens, database API endpoints, database IDs, and keyspace names.
4207
4212
It's a good practice to store these values in environment variables to facilitate reuse in your scripts, simplify token rotation, and increase security by keeping sensitive information separate from your core application code.
4208
4213
4209
4214
The {product} can automatically generate a set of relevant variables for a database that you can use in your applications.
Copy file name to clipboardExpand all lines: in-progress/quickstart-databases.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -292,5 +292,5 @@ See xref:databases:create-database.adoc#get-db-id[Get your database ID].
292
292
293
293
== Find embedding providers
294
294
295
-
Get information about embedding providers for xref:databases:embedding-generation.adoc[{astra-db} vectorize], including supported providers, models, dimensions, and other configuration parameters.
295
+
Get information about embedding providers for xref:databases:embedding-generation.adoc[{product-short} vectorize], including supported providers, models, dimensions, and other configuration parameters.
:description: {product} makes it easier to integrate {product-short} into your applications and workflows by letting you perform common platform tasks for {astra_db} and {astra_stream} from the command line.
4
+
:description: {product} makes it easier to integrate {product-short} into your applications and workflows by letting you perform common platform tasks for {astra-db} and {astra-stream} from the command line.
5
5
6
-
Install the {product} to create and manage {astra_db} databases and {astra_stream} tenants from the command line.
6
+
Install the {product} to create and manage {astra-db} databases and {astra-stream} tenants from the command line.
Copy file name to clipboardExpand all lines: modules/quickstarts/pages/cqlsh.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
= Issue CQL commands with cqlsh in the {product}
2
2
:navtitle: CQL quickstart
3
3
4
-
The {cass-short} Query Language Shell (`cqlsh`) is a utility that you can use to issue xref:astra@cql:reference:cql-quick-reference.adoc[CQL commands] to your {astra-db}database.
4
+
The {cass-short} Query Language Shell (`cqlsh`) is a utility that you can use to issue xref:astra@cql:reference:cql-quick-reference.adoc[CQL commands] to your {astra-db}databases.
5
5
6
6
The {product} provides embedded `cqlsh` support by downloading and installing the `cqlsh` utility in the background and exposing it through the `xref:commands:astra-db-cqlsh.adoc[]` commands.
7
7
This can act as a convenient alternative to installing and configuring a xref:astra-db-serverless:cql:develop-with-cql.adoc#connect-to-the-cql-shell[standalone cqlsh].
0 commit comments