kandra-core/io.kandra.core/CqlNaming

CqlNaming

object CqlNaming

Shared CQL identifier naming/validation logic.

This is consumed by two independent call sites that must never drift apart:

  • SchemaRegistry.buildSchema (this module, runtime schema validation — see GH-30)

  • kandra-codegen's KandraProcessor.resolveCqlName (compile-time *Table generation)

kandra-codegen already has an implementation(project(":kandra-core")) compile dependency (needed to reference the annotation classes), so it calls these functions directly rather than re-implementing them — see KandraProcessor.kt, which delegates here instead of keeping its own copy. If you ever change the blank-name fallback or the identifier-shape rule, this is the only place to change it; both SchemaRegistry and KandraProcessor pick it up automatically.

Functions

Link copied to clipboard
fun camelToSnake(name: String): String

Naive camelCase -> snake_case conversion: every individual uppercase letter is replaced with _ + its lowercase form, then a leading underscore (from a name starting with a capital) is trimmed. No special-casing for acronyms or existing underscores/digits — "userId" ->"user_id", but "userURL" ->"user_u_r_l".

Link copied to clipboard
fun isValidIdentifier(name: String): Boolean

Basic CQL identifier shape check: non-blank, first character is a letter or underscore, remaining characters are letters/digits/underscores. This is intentionally not a full CQL grammar validator (no reserved-word check, no quoted-identifier support) — it exists only to catch obvious mistakes (blank names, names starting with a digit, names containing spaces or punctuation) before they get spliced into DDL/DML strings.

Link copied to clipboard
fun resolveColumnName(columnAnnotationName: String?, propertyName: String): String

Resolves the CQL column name for a property given the raw @Column.name argument value, or null if the property carries no @Column annotation at all.