Skip to content

Commit

Permalink
Highlight "Important notes," add troubleshooting section in README
Browse files Browse the repository at this point in the history
The 'Important notes' header in the README file has been bolded to improve readability. A new troubleshooting section, 'If something went wrong,' has been added with instructions on how to dump and validate the schema.
  • Loading branch information
SmetDenis committed Apr 6, 2024
1 parent c21112b commit cfd0b50
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -949,7 +949,7 @@ used in a wide variety of CSV files.
In order not to care about integrity and not to suffer from copy and paste, you can reuse ANY(!) existing schema.
In fact, this can be considered as partial inheritance.

Important notes
**Important notes**
- You can make the chain of inheritance infinitely long.
I.e. make chains of the form `grant-parent.yml` -> `parent.yml` -> `child.yml` -> `grandchild.yml` -> `great-grandchild.yml` -> etc.
Of course if you like to take risks ;).
Expand All @@ -961,6 +961,14 @@ Important notes
<!-- auto-update:preset-regex -->"/^[a-z0-9-_]+$/i"<!-- auto-update:/preset-regex -->.
Otherwise, it might break the syntax.

**If something went wrong**
If you're having trouble working with presets and don't understand how the CSV Blueprint under the hood understands
it, just add `--dump-schema` to see it. Also, there is a separate CLI command for validating schema:

```shell
./csv-blueprint validate:schema --dump-schema --schema=./your/schema.yml
```


Let's take a look at what this looks like in code.
- Define a couple of basic rules for [database columns](schema-examples/preset_database.yml).
Expand Down

0 comments on commit cfd0b50

Please sign in to comment.