Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/simplifies naming convention writing #1523

Merged
merged 7 commits into from
Jun 27, 2024

Conversation

rudolfix
Copy link
Collaborator

Description

A followup on #998

  • adds examples for custom naming conventions
  • simplifies how naming conventions are implemented and configured
  • adds some tests

@rudolfix rudolfix requested a review from sh-rp June 27, 2024 13:31
Copy link

netlify bot commented Jun 27, 2024

Deploy Preview for dlt-hub-docs ready!

Name Link
🔨 Latest commit a87b6b8
🔍 Latest deploy log https://app.netlify.com/sites/dlt-hub-docs/deploys/667d9243f3927f0008096788
😎 Deploy Preview https://deploy-preview-1523--dlt-hub-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -0,0 +1,34 @@
from typing import ClassVar
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these extra files will not show up in the docs, maybe this is ok for now, but we might need to adapt this somehow?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

heh true but people may click in the link and they will go to github. LGTM, for now

try:
with open(example_file, "r", encoding="utf-8") as f:
lines = f.read().split("\n")
except FileNotFoundError:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is this for? when does this happen?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

something (I think Airflow) creates logs folder in the examples folder when I run any example. this prevents me from refreshing examples and I must remove the logs folder each time

* `dlt` applies final naming convention in `normalize` step. Naming convention comes from (1) explicit configuration (2) from destination capabilities.
* Naming convention will be used to put destination is case sensitive/insensitive mode and apply the right case folding function.

:::caution
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should add here that we do not recommend to change the naming convention for an existing dataset and if need to do it, a fresh load to a new dataset would be the least errorprone.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this documentation needs at least a day of work...

@rudolfix rudolfix merged commit af77527 into devel Jun 27, 2024
51 of 52 checks passed
@rudolfix rudolfix deleted the feat/simplifies-naming-convention-writing branch June 27, 2024 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants