docs icon indicating copy to clipboard operation
docs copied to clipboard

[Docs RFC] Unite and rewrite the write, query and ingest data sections

Open billy-the-fish opened this issue 1 year ago • 1 comments

Issue

Current docs in https://docs.timescale.com/use-timescale/latest/write-data/ and https://docs.timescale.com/use-timescale/latest/ingest-data/ are too segmented and do not give enough guidance for rapid ingestion of large amounts of data.

Solution

Combine and update the information in both sections in a new one called "Write and ingest data". The information structure is:

  • Ingest, write and query data: Full intro page with a diagram showing the efficiency of different methods. Includes links to prometheus and kafka.
    • Ingest large amounts of data: new doc with best practice
    • Bulk insert with parallel copy: https://docs.timescale.com/use-timescale/latest/ingest-data/about-timescaledb-parallel-copy/
    • Ingest from CSV: https://docs.timescale.com/use-timescale/latest/ingest-data/import-csv/
    • CRUD for small updates: All information from https://docs.timescale.com/use-timescale/latest/write-data/
    • Query your data: All information from https://docs.timescale.com/use-timescale/latest/query-data/

billy-the-fish avatar May 14 '24 09:05 billy-the-fish

I think we can remove ingesting data from Prometheus. While it's possible to do via some third party tool, it's not a use case that we support well since we stopped the work on Promscale.

the current write data page is for single or 10s of rows ingested. For larger batches, 100+ rows we should point to using COPY (new documentation)

Another common way to get data into a database is by using a CSV, especially at the beginning, so we should also make it easy to find.

Then we can have other more complex ways of getting data in.

For Upserting batches of data, engineering recommended using doing COPY to a temp table and them inserting into the final table via an insert query. Engineering will need to provide the best recommendation for this.

ramonguiu avatar May 14 '24 10:05 ramonguiu