# pg_idkit

> UUID and KSUID generators and timestamp utilities for Postgres.

Documents version 0.0.4, including randomness, ordering and timestamp precision limits.

## Guides and reference

- [Overview](https://id.postgres.tools/markdown/overview.md): pg_idkit adds four ID generators and a UUIDv7 timestamp extractor to Postgres. Functions run inside the database, so a column default can assign an ID on insert without an...
- [Install](https://id.postgres.tools/markdown/install.md): Install the extension files on a server you control, or load the SQL directly into a development database. Both methods below use a schema named extensions. Choose one method...
- [Quickstart](https://id.postgres.tools/markdown/get-started/quickstart.md): Create a table that assigns a UUIDv7 to each new row. First install version 0.0.4 into extensions. Run these statements as a role that can create a table and call the extension...
- [Choose an ID](https://id.postgres.tools/markdown/get-started/choose-an-id.md): Choose the database type and external representation your application needs. All four generators use the database clock and pseudo-random values; none promises collision-free...
- [Use IDs as primary keys](https://id.postgres.tools/markdown/guides/primary-keys.md): Use a column default to generate IDs and a primary key to enforce uniqueness. Install the functions into extensions first and run these examples as a table owner.
- [Read timestamps](https://id.postgres.tools/markdown/guides/timestamps.md): Extract the leading time field of a UUIDv7 for inspection. Install the functions into extensions first. You do not need a table for these examples.
- [UUID generators](https://id.postgres.tools/markdown/reference/uuid.md): These functions return native Postgres uuid values. Install into extensions before running the examples. Both functions are declared with Postgres's default volatility...
- [KSUID generators](https://id.postgres.tools/markdown/reference/ksuid.md): These functions return 27-character text values using the base62 alphabet 0-9, A-Z, a-z. Use text collate "C" for byte-order comparisons. Both read clock_timestamp() and use...
- [Timestamp extraction](https://id.postgres.tools/markdown/reference/timestamps.md): Read the leading time field of a UUIDv7. This utility decodes bits; it does not authenticate when an ID was created.
- [Errors and limits](https://id.postgres.tools/markdown/errors-and-limits.md): Version 0.0.4 generates IDs from the database clock and Postgres random(). Use a unique constraint for identity and a separate timestamp for application time.
- [pg_idkit documentation](https://id.postgres.tools/markdown/guide.md): Generate IDs inside Postgres and use them as table defaults. These docs describe the SQL shipped in version 0.0.4.

## Contributing

- [Documentation conventions](https://id.postgres.tools/markdown/contributing/style-guide.md): Write for a developer adding IDs to a Postgres application. Keep canonical Markdown in docs/; the site generates its routes and exports from site/navigation.mjs.