Skip to content

Commit 21b7344

Browse files
update wording in cli to properly match up cpr -> single multi
1 parent 9db8da7 commit 21b7344

7 files changed

Lines changed: 80 additions & 80 deletions

File tree

rust/crates/sift_cli/src/cli/mod.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use clap::{Parser, Subcommand, crate_description, crate_version};
22
use clap_complete::Shell;
3-
use parquet::{ComplexTypesMode, ScprMode};
3+
use parquet::{ComplexTypesMode, CprMode};
44
pub mod hdf5;
55
pub mod tdms;
66
use hdf5::Hdf5Schema;
@@ -343,7 +343,7 @@ pub enum ImportParquetCmd {
343343

344344
/// A parquet file laid out single-channel-per-row, either one channel for the whole file
345345
/// (single mode) or with a name column identifying the channel for each row (multi mode).
346-
Scpr(ScprArgs),
346+
Cpr(CprArgs),
347347
}
348348

349349
#[derive(clap::Args)]
@@ -394,13 +394,13 @@ pub struct FlatDatasetArgs {
394394
}
395395

396396
#[derive(clap::Args)]
397-
pub struct ScprArgs {
397+
pub struct CprArgs {
398398
#[command(flatten)]
399399
pub common: CommonImportArgs,
400400

401-
/// SCPR mode: single-channel or multi-channel
401+
/// Channel-per-row mode: single-channel or multi-channel
402402
#[arg(long)]
403-
pub mode: ScprMode,
403+
pub mode: CprMode,
404404

405405
/// Path to the time column
406406
#[arg(short, long)]

rust/crates/sift_cli/src/cli/parquet.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,16 @@ impl Display for ComplexTypesMode {
3939
}
4040
}
4141

42-
/// Single-channel-per-row mode: tells the importer how each row is shaped.
42+
/// Channel-per-row mode: tells the importer how each row is shaped.
4343
#[derive(Debug, Copy, Clone, PartialEq, Eq, ValueEnum)]
44-
pub enum ScprMode {
44+
pub enum CprMode {
4545
/// File has [time, value]. All rows belong to one named channel.
4646
Single,
4747
/// File has [time, name_column, value_column]. Channels created per unique name.
4848
Multi,
4949
}
5050

51-
impl Display for ScprMode {
51+
impl Display for CprMode {
5252
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
5353
match self {
5454
Self::Single => write!(f, "single"),

rust/crates/sift_cli/src/cmd/import/parquet/scpr_dataset.rs renamed to rust/crates/sift_cli/src/cmd/import/parquet/cpr_dataset.rs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ use sift_rs::{
1111
CreateDataImportFromUploadRequest, CreateDataImportFromUploadResponse,
1212
ParquetComplexTypesImportMode, ParquetConfig,
1313
data_import_service_client::DataImportServiceClient, parquet_config::Config,
14-
parquet_single_channel_per_row_config::Config as ScprInnerConfig,
14+
parquet_single_channel_per_row_config::Config as CprInnerConfig,
1515
},
1616
};
1717

18-
use crate::cli::ScprArgs;
19-
use crate::cmd::import::parquet::detect_parquet_schema::detect_scpr_config;
18+
use crate::cli::CprArgs;
19+
use crate::cmd::import::parquet::detect_parquet_schema::detect_cpr_config;
2020
use crate::cmd::{
2121
Context,
2222
import::{
@@ -26,14 +26,14 @@ use crate::cmd::{
2626
};
2727
use crate::util::{api::create_grpc_channel, tty::Output};
2828

29-
pub async fn run(ctx: Context, args: ScprArgs) -> Result<ExitCode> {
29+
pub async fn run(ctx: Context, args: CprArgs) -> Result<ExitCode> {
3030
let grpc_channel = create_grpc_channel(&ctx)?;
3131
let mut data_imports_client = DataImportServiceClient::new(grpc_channel.clone());
3232
let mut file = File::open(&args.common.path).context("failed to open parquet file")?;
3333
let footer_md = FooterMetadata::try_from(&mut file)?;
3434

35-
let scpr_config =
36-
detect_scpr_config(&file, &args).context("failed to detect parquet schema")?;
35+
let cpr_config =
36+
detect_cpr_config(&file, &args).context("failed to detect parquet schema")?;
3737

3838
if args.common.preview {
3939
let run_label = args
@@ -44,9 +44,9 @@ pub async fn run(ctx: Context, args: ScprArgs) -> Result<ExitCode> {
4444
.or(args.common.run.as_deref())
4545
.unwrap_or("");
4646

47-
let multi_channels: Vec<ChannelConfig> = match scpr_config.config.as_ref() {
48-
Some(ScprInnerConfig::MultiChannel(multi)) => {
49-
let data_type = scpr_config
47+
let multi_channels: Vec<ChannelConfig> = match cpr_config.config.as_ref() {
48+
Some(CprInnerConfig::MultiChannel(multi)) => {
49+
let data_type = cpr_config
5050
.columns
5151
.iter()
5252
.find(|c| c.path == multi.data_path)
@@ -68,9 +68,9 @@ pub async fn run(ctx: Context, args: ScprArgs) -> Result<ExitCode> {
6868
_ => Vec::new(),
6969
};
7070

71-
let preview_channels: Vec<&ChannelConfig> = match scpr_config.config.as_ref() {
72-
Some(ScprInnerConfig::SingleChannel(single)) => single.channel.iter().collect(),
73-
Some(ScprInnerConfig::MultiChannel(_)) => multi_channels.iter().collect(),
71+
let preview_channels: Vec<&ChannelConfig> = match cpr_config.config.as_ref() {
72+
Some(CprInnerConfig::SingleChannel(single)) => single.channel.iter().collect(),
73+
Some(CprInnerConfig::MultiChannel(_)) => multi_channels.iter().collect(),
7474
None => Vec::new(),
7575
};
7676

@@ -79,7 +79,7 @@ pub async fn run(ctx: Context, args: ScprArgs) -> Result<ExitCode> {
7979
}
8080

8181
let parquet_config = ParquetConfig {
82-
config: Some(Config::SingleChannelPerRow(scpr_config)),
82+
config: Some(Config::SingleChannelPerRow(cpr_config)),
8383
..Default::default()
8484
};
8585
let create_data_import_req = create_data_import_request(&args, parquet_config, footer_md)?;
@@ -114,7 +114,7 @@ pub async fn run(ctx: Context, args: ScprArgs) -> Result<ExitCode> {
114114
}
115115

116116
fn create_data_import_request(
117-
args: &ScprArgs,
117+
args: &CprArgs,
118118
config: ParquetConfig,
119119
footer_md: FooterMetadata,
120120
) -> Result<CreateDataImportFromUploadRequest> {

rust/crates/sift_cli/src/cmd/import/parquet/detect_parquet_schema.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ use sift_rs::{
1212
ParquetColumn, ParquetDataColumn, ParquetFlatDatasetConfig,
1313
ParquetSingleChannelPerRowConfig, ParquetSingleChannelPerRowMultiChannelConfig,
1414
ParquetSingleChannelPerRowSingleChannelConfig, ParquetTimeColumn, TimeFormat,
15-
parquet_single_channel_per_row_config::Config as ScprInnerConfig,
15+
parquet_single_channel_per_row_config::Config as CprInnerConfig,
1616
},
1717
};
1818

1919
use crate::cli::channel::DataType as CliDataType;
20-
use crate::cli::parquet::ScprMode;
21-
use crate::cli::{FlatDatasetArgs, ScprArgs};
20+
use crate::cli::parquet::CprMode;
21+
use crate::cli::{FlatDatasetArgs, CprArgs};
2222

2323
pub fn detect_flat_dataset_config<R: ChunkReader>(
2424
file: &R,
@@ -82,9 +82,9 @@ pub fn detect_flat_dataset_config<R: ChunkReader>(
8282
})
8383
}
8484

85-
pub fn detect_scpr_config<R: ChunkReader>(
85+
pub fn detect_cpr_config<R: ChunkReader>(
8686
file: &R,
87-
args: &ScprArgs,
87+
args: &CprArgs,
8888
) -> Result<ParquetSingleChannelPerRowConfig> {
8989
validate_time_format(args.time_format, &args.relative_start_time)
9090
.context("validating time format")?;
@@ -94,7 +94,7 @@ pub fn detect_scpr_config<R: ChunkReader>(
9494
metadata.file_metadata().schema_descr(),
9595
metadata.file_metadata().key_value_metadata(),
9696
)
97-
.context("detecting scpr arrow schema")?;
97+
.context("detecting cpr arrow schema")?;
9898

9999
let relative_start_time = match &args.relative_start_time {
100100
Some(start) => {
@@ -144,7 +144,7 @@ pub fn detect_scpr_config<R: ChunkReader>(
144144
}];
145145

146146
let inner_config = match args.mode {
147-
ScprMode::Single => {
147+
CprMode::Single => {
148148
let channel_name = args
149149
.channel_name
150150
.as_ref()
@@ -155,7 +155,7 @@ pub fn detect_scpr_config<R: ChunkReader>(
155155
Some(ref dt) => ChannelDataType::from(dt.clone()),
156156
};
157157

158-
ScprInnerConfig::SingleChannel(ParquetSingleChannelPerRowSingleChannelConfig {
158+
CprInnerConfig::SingleChannel(ParquetSingleChannelPerRowSingleChannelConfig {
159159
data_path: args.data_path.clone(),
160160
channel: Some(ChannelConfig {
161161
name: channel_name.clone(),
@@ -166,7 +166,7 @@ pub fn detect_scpr_config<R: ChunkReader>(
166166
}),
167167
})
168168
}
169-
ScprMode::Multi => {
169+
CprMode::Multi => {
170170
let name_path = args
171171
.name_path
172172
.as_ref()
@@ -190,7 +190,7 @@ pub fn detect_scpr_config<R: ChunkReader>(
190190
}),
191191
});
192192

193-
ScprInnerConfig::MultiChannel(ParquetSingleChannelPerRowMultiChannelConfig {
193+
CprInnerConfig::MultiChannel(ParquetSingleChannelPerRowMultiChannelConfig {
194194
name_path: name_path.clone(),
195195
data_path: args.data_path.clone(),
196196
})

rust/crates/sift_cli/src/cmd/import/parquet/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use windows::{FooterMetadata, get_footer};
66

77
pub mod detect_parquet_schema;
88
pub mod flat_dataset;
9-
pub mod scpr_dataset;
9+
pub mod cpr_dataset;
1010

1111
#[cfg(test)]
1212
mod tests;

0 commit comments

Comments
 (0)