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
The DataStax Astra Command-Line Interface ({astra_cli}) is a set of commands used to create and manage Astra resources.
6
+
{astra_cli} is available across Astra services and is designed to get you working quickly with {astra_db} and {astra_stream}, with an emphasis on automation.
6
7
7
-
++++
8
-
<div class="landing-row">
9
-
++++
8
+
{astra_cli} makes it possible to submit commands instead of *or in addition to* using {astra_ui} and DataStax API calls.
10
9
11
-
[sidebar.landing-card]
12
-
.Create your first thing
13
-
****
14
-
--
15
-
You can do amazing things with {astra_cli}.
10
+
{astra_cli} features are for operators, Site Reliability Engineers (SREs), and developers who want the option of using commands when working with {astra_db} databases and {astra_stream} tenants.
11
+
The tools should be complementary and not restrictive, so choose what tool works best for you.
16
12
17
-
* Create a thing.
18
-
* Create a more advanced thing.
19
-
--
20
-
[.landing-card-body-icon]
21
-
image::what-is-astra-db.svg[icon description,40]
22
-
****
13
+
{astra_cli} is free.
23
14
24
-
++++
25
-
</div>
26
-
++++
15
+
Any user with the **Organization Administrator** role may use {astra_cli} commands with:
Notice that the output is raw. This command is expected to be used in scripts.
362
+
Notice that the output is raw. This command is expected to be used in scripts.
363
363
364
364
Example:
365
365
@@ -428,7 +428,7 @@ astra help db list-keyspaces
428
428
429
429
=== Create a new keyspace
430
430
431
-
To add a keyspace named `ks2` to an existing database named `demo`, use the following command.
431
+
To add a keyspace named `ks2` to an existing database named `demo`, use the following command.
432
432
The option `--if-not-exist` is optional but could help you provide idempotent scripts. Example:
433
433
434
434
[source,bash]
@@ -447,7 +447,7 @@ astra db list-keyspaces demo
447
447
448
448
== Use cqlsh
449
449
450
-
https://cassandra.apache.org/doc/latest/cassandra/tools/cqlsh.html[cqlsh^] is a standalone shell to work with Apache Cassandra®.
450
+
https://cassandra.apache.org/doc/latest/cassandra/tools/cqlsh.html[cqlsh^] is a standalone shell to work with Apache Cassandra®.
451
451
It is compliant with {astra_cli} but requires a few extra steps of configuration.
452
452
The purpose of {astra_cli} is to integrate with `cqlsh` and do the integration for you.
453
453
@@ -500,7 +500,7 @@ astra db cqlsh demo -f sample.cql
500
500
501
501
== Use DSBulk with {astra_cli} to load, unload, and count data
502
502
503
-
https://github.com/datastax/dsbulk[DataStax Bulk Loader^] (`dsbulk`) allows you to you load, unload, and count data from Cassandra-based database tables, such as those in Apache Cassandra, DataStax Enterprise, and Astra DB. {astra_cli} commands can invoke dsbulk.
503
+
https://github.com/datastax/dsbulk[DataStax Bulk Loader^] (`dsbulk`) allows you to you load, unload, and count data from Cassandra-based database tables, such as those in Apache Cassandra, DataStax Enterprise, and Astra DB. {astra_cli} commands can invoke dsbulk.
504
504
505
505
As for `cqlsh`, {astra_cli} will *download*, *install*, *setup* and *wrap* the `dsbulk` command for you.
The first time you run the `astra db load` command, the message -- `DSBulk is starting please wait` -- may take a few seconds to appear because
562
+
The first time you run the `astra db load` command, the message -- `DSBulk is starting please wait` -- may take a few seconds to appear because
563
563
{astra_cli} is downloading `dsbulk` (if it wasn't downloaded previously).
564
564
565
565
Sample output:
@@ -724,7 +724,7 @@ Sample output:
724
724
725
725
== Resume a hibernated database
726
726
727
-
If you are using the {astra_db} Free plan, your database will be hibernated (inactive) after 23 hours of inactivity. (This behavior does not occur when you upgrade to a paid {astra_db} plan.)
727
+
If you are using the {astra_db} Free plan, your database will be hibernated (inactive) after 23 hours of inactivity. (This behavior does not occur when you upgrade to a paid {astra_db} plan.)
728
728
729
729
To wake up the database, you can use the `astra db resume` command.
0 commit comments