#config-parser #questdb #parser #key2-value2 #key1-value1

questdb-confstr

A parser for a configuration string format handling service names and parameters

2 releases

0.1.1 Apr 4, 2025
0.1.0 Jan 31, 2024

#136 in Configuration

Download history 4978/week @ 2025-02-03 5167/week @ 2025-02-10 5093/week @ 2025-02-17 4902/week @ 2025-02-24 4997/week @ 2025-03-03 4529/week @ 2025-03-10 3140/week @ 2025-03-17 3891/week @ 2025-03-24 3020/week @ 2025-03-31 578/week @ 2025-04-07 428/week @ 2025-04-14 440/week @ 2025-04-21 381/week @ 2025-04-28 680/week @ 2025-05-05 728/week @ 2025-05-12 598/week @ 2025-05-19

2,406 downloads per month
Used in 2 crates

Apache-2.0

15KB
292 lines

questdb-confstr

Format

Parser for a configuration string format used by QuestDB clients.

The format is as follows:

service::key1=value1;key2=value2;key3=value3;

A few rules:

  • The last semicolon is optional.
  • Service name and keys are case-sensitive.
  • Keys are ASCII alphanumeric and can contain underscores.
  • Values are case-sensitive unicode strings which can contain any characters,
    • Except control characters (0x00..=0x1f and 0x7f..=0x9f).
    • If semicolons ; appears in a value, these are escaped as double semicolon ;;.

Grammar

conf_str ::= service "::" params | service
service ::= identifier
params ::= param (";" param)* ";"?
param ::= key "=" value
key ::= identifier
value ::= { value_char }

identifier ::= alpha_num_under { alpha_num_under }
alpha_num_under ::= "a".."z" | "A".."Z" | "0".."9" | "_"
value_char ::= non_semicolon_char | escaped_semicolon
escaped_semicolon ::= ";;"
non_semicolon_char ::= ? any unicode character except ';', 0x00..=0x1f and 0x7f..=0x9f ?

Usage

Add dependency to Cargo.toml

cargo add questdb-confstr

Usage

Use the parse_conf_str function to parse into a ConfStr struct.

You can then access the service name as &str and parameters as a &HashMap<String, String>.

Where we use it

We use this config parsing format in our Rust, C, C++ and Python clients.

We also use it to configure object stores for database replication.

No runtime deps