Browse Source

Added all field types supported by core tantivy to cli dialog

Left F64 in comments, as it's already in tantivy master branch, but hasn't been
published yet

Added a todo list on our way to integrating tantivy-cli as a subcrate in core tantivy
develop
petr-tik 4 years ago
parent
commit
27e3405570
2 changed files with 91 additions and 14 deletions
  1. +18
    -0
      integration_plan.org
  2. +73
    -14
      src/commands/new.rs

+ 18
- 0
integration_plan.org View File

@@ -0,0 +1,18 @@
* Integrate cli as a binary built as part of tantivy-core
** Pros
*** Builds every commit
*** Allows prospective users to try tantivy
** Cons
*** Increases build time
*** Slows down core feature development
If every core feature requires changing the example cli, it will slow down review and fixing of core library functionality

* Outline
** DONE Update to rust edition 2018
CLOSED: [2019-10-19 Sat 20:28]
** DONE Add all datatypes supported by the library to the dialog
CLOSED: [2019-10-19 Sat 22:33]
** TODO test locally with a dependency on master of local tantivy
* Further work
** TODO Skip fields found in json, but not in the schema instead of erroring


+ 73
- 14
src/commands/new.rs View File

@@ -3,6 +3,7 @@ use ansi_term::Style;
use clap::ArgMatches; use clap::ArgMatches;
use serde_json; use serde_json;
use std::convert::From; use std::convert::From;
use std::fs;
use std::io; use std::io;
use std::io::Write; use std::io::Write;
use std::path::PathBuf; use std::path::PathBuf;
@@ -10,8 +11,6 @@ use tantivy;
use tantivy::schema::Cardinality; use tantivy::schema::Cardinality;
use tantivy::schema::*; use tantivy::schema::*;
use tantivy::Index; use tantivy::Index;
use std::fs;



pub fn run_new_cli(matches: &ArgMatches) -> Result<(), String> { pub fn run_new_cli(matches: &ArgMatches) -> Result<(), String> {
let index_directory = PathBuf::from(matches.value_of("index").unwrap()); let index_directory = PathBuf::from(matches.value_of("index").unwrap());
@@ -42,6 +41,7 @@ fn prompt_input<P: Fn(&str) -> Result<(), String>>(prompt_text: &str, predicate:
} }
} }


// TODO move into core tantivy
fn field_name_validate(field_name: &str) -> Result<(), String> { fn field_name_validate(field_name: &str) -> Result<(), String> {
if is_valid_field_name(field_name) { if is_valid_field_name(field_name) {
Ok(()) Ok(())
@@ -71,6 +71,30 @@ fn prompt_options(msg: &str, codes: Vec<char>) -> char {
entry.chars().next().unwrap().to_ascii_uppercase() entry.chars().next().unwrap().to_ascii_uppercase()
} }


fn prompt_field_type(msg: &str, codes: Vec<&str>) -> tantivy::schema::Type {
let options = codes.join("/");
let predicate = |entry: &str| {
// TODO make case-insensitive, currently has to match the options precisely
if codes.contains(&entry) {
return Ok(());
} else {
return Err(format!("Invalid input. Options are ({})", options));
}
};
let message = format!("{} ({})", msg, options);
let prompt_output = prompt_input(&message, predicate);
match prompt_output.to_ascii_uppercase().as_ref() {
"TEXT" => Type::Str,
"U64" => Type::U64,
"I64" => Type::I64,
// "F64" => Type::F64,
"DATE" => Type::Date,
"FACET" => Type::HierarchicalFacet,
"BYTES" => Type::Bytes,
&_ => Type::Str, // shouldn't be here, the `predicate` fails before here
}
}

fn prompt_yn(msg: &str) -> bool { fn prompt_yn(msg: &str) -> bool {
prompt_options(msg, vec!['Y', 'N']) == 'Y' prompt_options(msg, vec!['Y', 'N']) == 'Y'
} }
@@ -106,28 +130,63 @@ fn ask_add_field_text(field_name: &str, schema_builder: &mut SchemaBuilder) {
schema_builder.add_text_field(field_name, text_options); schema_builder.add_text_field(field_name, text_options);
} }


fn ask_add_field_u64(field_name: &str, schema_builder: &mut SchemaBuilder) {
let mut u64_options = IntOptions::default();
fn ask_add_num_field_with_options(
field_name: &str,
field_type: Type,
schema_builder: &mut SchemaBuilder,
) {
let mut int_options = IntOptions::default();
if prompt_yn("Should the field be stored") { if prompt_yn("Should the field be stored") {
u64_options = u64_options.set_stored();
int_options = int_options.set_stored();
} }
if prompt_yn("Should the field be fast") { if prompt_yn("Should the field be fast") {
u64_options = u64_options.set_fast(Cardinality::SingleValue);
int_options = int_options.set_fast(Cardinality::SingleValue);
} }
if prompt_yn("Should the field be indexed") { if prompt_yn("Should the field be indexed") {
u64_options = u64_options.set_indexed();
int_options = int_options.set_indexed();
}
match field_type {
Type::U64 => {
schema_builder.add_u64_field(field_name, int_options);
}
// Type::F64 => {
// schema_builder.add_f64_field(field_name, int_options);
// }
Type::I64 => {
schema_builder.add_i64_field(field_name, int_options);
}
Type::Date => {
schema_builder.add_date_field(field_name, int_options);
}
_ => {
// We only pass to this function if the field type is numeric
unreachable!();
}
} }
schema_builder.add_u64_field(field_name, u64_options);
} }


fn ask_add_field(schema_builder: &mut SchemaBuilder) { fn ask_add_field(schema_builder: &mut SchemaBuilder) {
println!("\n\n"); println!("\n\n");
let field_name = prompt_input("New field name ", field_name_validate); let field_name = prompt_input("New field name ", field_name_validate);
let text_or_integer = prompt_options("Text or unsigned 32-bit integer", vec!['T', 'I']);
if text_or_integer == 'T' {
ask_add_field_text(&field_name, schema_builder);
} else {
ask_add_field_u64(&field_name, schema_builder);

// Manually iterate over tantivy::schema::Type and make strings out of them
// Can introduce a dependency to do it automatically, but this should be easier
let possible_field_types = vec!["Text", "u64", "i64", "f64", "Date", "Facet", "Bytes"];
let field_type = prompt_field_type("Choose Field Type", possible_field_types);
match field_type {
Type::Str => {
ask_add_field_text(&field_name, schema_builder);
}
Type::U64 | Type::Date | Type::I64 => {
// Type::U64 | Type::F64 | Type::Date | Type::I64 => {
ask_add_num_field_with_options(&field_name, field_type, schema_builder);
}
Type::HierarchicalFacet => {
schema_builder.add_facet_field(&field_name);
}
Type::Bytes => {
schema_builder.add_bytes_field(&field_name);
}
} }
} }


@@ -141,7 +200,7 @@ fn run_new(directory: PathBuf) -> tantivy::Result<()> {
Style::new() Style::new()
.bold() .bold()
.fg(Green) .fg(Green)
.paint("Let's define it's schema!")
.paint("First define its schema!")
); );
let mut schema_builder = SchemaBuilder::default(); let mut schema_builder = SchemaBuilder::default();
loop { loop {


Loading…
Cancel
Save