Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Improve documentation#3

Merged
amotl merged 2 commits into
mainfrom
this-and-that
Dec 8, 2023
Merged

Improve documentation#3
amotl merged 2 commits into
mainfrom
this-and-that

Conversation

@amotl
Copy link
Copy Markdown
Member

@amotl amotl commented Dec 8, 2023

About

Significantly improve the README, guiding the dear reader into the topics of Singer, the Singer Spec, Meltano, and PipelineWise.

Add two usage examples:

  1. Show Meltano YAML configuration snippet right away.
    - name: target-cratedb
      namespace: cratedb
      variant: cratedb
      pip_url: meltano-target-cratedb
      config:
        sqlalchemy_url: crate://crate@localhost/
        add_record_metadata: true
  2. Instructions how to load a data file in Singer format (JSONL) in standalone mode.
    # Acquire, configure, invoke -- at a glance.
    wget https://github.com/MeltanoLabs/target-postgres/raw/v0.0.9/target_postgres/tests/data_files/tap_countries.singer
    echo '{"sqlalchemy_url": "crate://crate@localhost/"}' > settings.json
    cat tap_countries.singer | target-cratedb --config=settings.json
    

Preview

The README.md can be inspected directly for best reading experience.

Backlog

Probably only happening in subsequent patches after the v0.0.1 release. See also docs/backlog.md.

  • Unlock configuring dedicated database schema, not just melty.
    "crate://crate@localhost/?schema=foo"
  • Document use with CrateDB Cloud.
  • Submit a few patches to meltanolabs-target-postgres, about proper
    quoting of schema and table names.
  • Submit a few other patches to crate-python, in order to clean up here.

@amotl amotl requested review from ckurze, matriv and seut December 8, 2023 18:50
@codecov
Copy link
Copy Markdown

codecov Bot commented Dec 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e10e76f) 78.02% compared to head (59dda4e) 78.10%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main       #3      +/-   ##
==========================================
+ Coverage   78.02%   78.10%   +0.08%     
==========================================
  Files           6        6              
  Lines         546      548       +2     
==========================================
+ Hits          426      428       +2     
  Misses        120      120              
Flag Coverage Δ
main 78.10% <100.00%> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@amotl amotl merged commit d58ebb0 into main Dec 8, 2023
@amotl amotl deleted the this-and-that branch December 8, 2023 20:47
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.

1 participant