From fbb605ad49f2d8bbb4a63c1647603daf118d4c45 Mon Sep 17 00:00:00 2001 From: dat-a-man <98139823+dat-a-man@users.noreply.github.com> Date: Wed, 3 Apr 2024 04:13:49 +0000 Subject: [PATCH 1/2] Updated schema docs for naming convention --- docs/website/docs/general-usage/schema.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/website/docs/general-usage/schema.md b/docs/website/docs/general-usage/schema.md index cb1c73c340..b7dc068b13 100644 --- a/docs/website/docs/general-usage/schema.md +++ b/docs/website/docs/general-usage/schema.md @@ -64,6 +64,15 @@ The default naming convention: > 💡 Use simple, short small caps identifiers for everything! +To retain the original naming convention (like keeping `"createdAt"` as it is instead of converting it to `"created_at"`), you can use the direct naming convention, in "config.toml" as follows: +``` +[schema] +SCHEMA__NAMING = "direct" +``` +:::caution +Opting for `"direct"` naming bypasses most name normalization processes. This means any unusual characters present will be carried over unchanged to database tables and columns. Please be aware of this behavior to avoid potential issues. +::: + The naming convention is configurable and users can easily create their own conventions that i.e. pass all the identifiers unchanged if the destination accepts that (i.e. DuckDB). From ba07be46797f8c8837bc52a6a6a2888713f19c4e Mon Sep 17 00:00:00 2001 From: Zaeem Athar Date: Mon, 8 Apr 2024 14:24:20 +0200 Subject: [PATCH 2/2] Update schema.md Adding type toml to code snippet. --- docs/website/docs/general-usage/schema.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/website/docs/general-usage/schema.md b/docs/website/docs/general-usage/schema.md index b7dc068b13..60ae5147f9 100644 --- a/docs/website/docs/general-usage/schema.md +++ b/docs/website/docs/general-usage/schema.md @@ -65,7 +65,7 @@ The default naming convention: > 💡 Use simple, short small caps identifiers for everything! To retain the original naming convention (like keeping `"createdAt"` as it is instead of converting it to `"created_at"`), you can use the direct naming convention, in "config.toml" as follows: -``` +```toml [schema] SCHEMA__NAMING = "direct" ```