Skip to main content

Module cli

Module cli 

Source
Expand description

CLI Parser - Command-line argument parsing with clap

This module defines the CLI structure using clap derive macros.

Structs§

Cli
Alopex CLI - Command-line interface for Alopex DB
ClusterMutationRequest
Mutation input. A target and explicit confirmation are kept in the grammar instead of being inferred from a positional argument or an interactive prompt, so automation and the HTTP contract cannot disagree.
ClusterOperationRequest
Shared operation identity and optimistic-concurrency input for cluster management requests. The request ID is deliberately operator-supplied so a retry can use the same idempotency key.
ClusterTargetedReadRequest
Read operation which addresses a specific public metadata target.
SqlCommand
SQL subcommand

Enums§

ClusterCommand
Cluster metadata management areas.
ClusterMembersCommand
Member management commands.
ClusterMetadataCommand
Metadata inspection commands.
ClusterPlacementCommand
Range placement commands.
ClusterRangesCommand
Range management commands.
ClusterReadPolicyCommand
Cluster read-policy commands.
ClusterRecoveryCommand
Recovery management commands.
ClusterSchemaCommand
Cluster schema ownership and rollout commands.
ClusterSchemaOwnerCommand
Schema ownership commands.
ClusterSchemaRolloutCommand
Schema rollout commands.
ClusterUpgradeCommand
Upgrade management commands.
ColumnarCommand
Columnar subcommands
Command
Top-level subcommands
CompactionCommand
Server compaction subcommands
DistanceMetric
Distance metric for HNSW index
HnswCommand
HNSW subcommands
IndexCommand
Columnar index subcommands
KvCommand
KV subcommands
KvTxnCommand
KV transaction subcommands
LifecycleBackupCommand
Backup lifecycle subcommands
LifecycleCommand
Lifecycle subcommands
LifecycleRestoreCommand
Restore lifecycle subcommands
OutputFormat
Output format for query results
ProfileCommand
Profile subcommands
RoutingReportFormat
Requested format for the distributed-read routing report. The report is emitted by the later output adapter and is intentionally separate from query stdout formats.
ServerCommand
Server management subcommands
SqlReadMode
Requested SQL read routing mode. local remains the compatibility default; all other modes require an explicitly configured cluster profile.
ThreadMode
Thread mode for database operations
VectorCommand
Vector subcommands