From dc1973e7ea80386a41942db1ad91a84269c28c00 Mon Sep 17 00:00:00 2001 From: Masato Onodera Date: Fri, 20 Dec 2024 15:51:23 -1000 Subject: [PATCH] add tbls schema info --- docs/tbls/README.md | 8 +++++++ docs/tbls/public.partner.md | 46 +++++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 docs/tbls/public.partner.md diff --git a/docs/tbls/README.md b/docs/tbls/README.md index 52450d8..b15a707 100644 --- a/docs/tbls/README.md +++ b/docs/tbls/README.md @@ -15,6 +15,7 @@ | [public.fluxstd](public.fluxstd.md) | 61 | | BASE TABLE | | [public.target](public.target.md) | 61 | | BASE TABLE | | [public.cluster](public.cluster.md) | 10 | | BASE TABLE | +| [public.partner](public.partner.md) | 5 | | BASE TABLE | ## Stored procedures and functions @@ -310,6 +311,13 @@ erDiagram timestamp_without_time_zone created_at timestamp_without_time_zone updated_at } +"public.partner" { + integer partner_id + varchar partner_name + varchar partner_description + timestamp_without_time_zone created_at + timestamp_without_time_zone updated_at +} ``` --- diff --git a/docs/tbls/public.partner.md b/docs/tbls/public.partner.md new file mode 100644 index 0000000..e29cc6a --- /dev/null +++ b/docs/tbls/public.partner.md @@ -0,0 +1,46 @@ +# public.partner + +## Description + +## Columns + +| Name | Type | Default | Nullable | Children | Parents | Comment | +| ---- | ---- | ------- | -------- | -------- | ------- | ------- | +| partner_id | integer | | false | | | Unique identifier of the partner | +| partner_name | varchar | | false | | | Name of the partner (e.g., subaru, gemini, keck, and uh) | +| partner_description | varchar | | true | | | Description of the partner | +| created_at | timestamp without time zone | timezone('utc'::text, CURRENT_TIMESTAMP) | true | | | The date and time in UTC when the record was created | +| updated_at | timestamp without time zone | | true | | | The date and time in UTC when the record was last updated | + +## Constraints + +| Name | Type | Definition | +| ---- | ---- | ---------- | +| partner_pkey | PRIMARY KEY | PRIMARY KEY (partner_id) | +| partner_partner_name_key | UNIQUE | UNIQUE (partner_name) | + +## Indexes + +| Name | Definition | +| ---- | ---------- | +| partner_pkey | CREATE UNIQUE INDEX partner_pkey ON public.partner USING btree (partner_id) | +| partner_partner_name_key | CREATE UNIQUE INDEX partner_partner_name_key ON public.partner USING btree (partner_name) | + +## Relations + +```mermaid +erDiagram + + +"public.partner" { + integer partner_id + varchar partner_name + varchar partner_description + timestamp_without_time_zone created_at + timestamp_without_time_zone updated_at +} +``` + +--- + +> Generated by [tbls](https://github.com/k1LoW/tbls)