Skip to content

Commit 24067a1

Browse files
committed
Documentation fixes
1 parent de270b4 commit 24067a1

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ include = ["src/**/*.rs", "Cargo.toml", "README.md"]
77
description = "Easy to use numeric compression"
88
categories = ["compression", "database"]
99
keywords = ["compression", "timeseries", "postgres"]
10+
repository = "https://github.com/pganalyze/pco_store"
1011

1112
[lib]
1213
proc-macro = true

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Compared to native Postgres arrays using binary compression, pco_store improves
1919

2020
The `pco_store::store` procedural macro accepts these arguments:
2121

22-
- `timestamp` accepts the field name for a timestamp in the struct. Timestamps are internally stored as an `i64` microsecond offset from the Unix epoch. This adds `start_at` and `end_at` timestamp columns to the resulting table. A compsite index should cover `start_at` and `end_at`.
22+
- `timestamp` accepts the field name for a timestamp in the struct. Timestamps are internally stored as an `i64` microsecond offset from the Unix epoch. This adds `start_at` and `end_at` timestamp columns to the resulting table. A composite index should cover `start_at` and `end_at`.
2323
- `group_by` accepts one or more field names that are stored as uncompressed fields on the Postgres table that all other fields are grouped by. The fields are added as `load` filters, and `store` automatically groups the input data by them. A composite index should cover these fields.
2424
- `float_round` sets the number of fractional decimal points to retain for float values. This helps improve the compression ratio when you don't need the full precision of the source data. Internally this stores the values as `i64`, with the fractional precision retained by multiplying by 10^N at write time, and then at read time casting to float and dividing by 10^N. Users should confirm that the generated integer values won't overflow past `i64::MAX`.
2525
- `table_name` overrides the Postgres table name. By default it underscores and pluralizes the struct name, so `QueryStat` becomes `query_stats`.

0 commit comments

Comments
 (0)