Best Practices for Naming Configs in Bragi
Clear, consistent, and meaningful names for your configurations improve clarity, collaboration, and maintainability across your data pipelines. Here are some best practices for naming configs like tables, models, or load configurations in Bragi:
1. Use a Clear Prefix for Environment or Layer
Start names with a prefix that indicates the environment or pipeline layer, such as
stage,load, orarchive.Example:
stage_for staging tables,load_for load configs. Bragi starts config names with this prefix by default.
2. Include a Team or Product Identifier
Add an abbreviation or code for the team, product, or data domain responsible for the data.
Example:
SALES, orFINto indicate ownership or subject area.
3. Use a Numeric Ordering Scheme to Indicate Execution Order
Use numerals to indicate the execution or processing order within your pipeline, which helps clarify dependencies and sequence of operations.
We generally number in increments of 10 (e.g., 10, 20, 30) to allow flexibility for inserting steps later without needing to rename everything.
4. Make the Core Name Descriptive
Clearly describe the content or purpose of the config. Use concise, meaningful words reflecting the table or model’s role.
Avoid overly generic names like
dataortemp.
5. Use Underscores to Separate Sections
Use underscores (
_) to separate different components of the name for readability.
6. Keep Names Consistent in Case and Style
Choose a case style (usually lowercase or PascalCase) and stick with it across all configs to reduce confusion.
Example Naming Patterns
Example Name | Description |
|---|---|
| Stage config for SALES team, early stage, customer data |
Additional Tips
Avoid overly long names to keep identifiers manageable.
Align naming conventions with your team's documentation and coding standards.
Regularly review and refactor names when pipeline structures change to maintain clarity.