diff --git a/.github/vale/config/vocabularies/Backstage/accept.txt b/.github/vale/config/vocabularies/Backstage/accept.txt index 091b999dd7..7dea58e627 100644 --- a/.github/vale/config/vocabularies/Backstage/accept.txt +++ b/.github/vale/config/vocabularies/Backstage/accept.txt @@ -276,6 +276,7 @@ nohoist nonces noop npm +nullable nunjucks nvarchar nvm diff --git a/packages/backend-defaults/report-auth.sql.md b/packages/backend-defaults/report-auth.sql.md new file mode 100644 index 0000000000..9551c34bb0 --- /dev/null +++ b/packages/backend-defaults/report-auth.sql.md @@ -0,0 +1,15 @@ +## SQL Report file for "@backstage/backend-defaults/auth" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +## Table `backstage_backend_public_keys__keys` + +| Column | Type | Nullable | Max Length | Default | +| ------------ | ------------------- | -------- | ---------- | ------- | +| `expires_at` | `character varying` | false | 255 | - | +| `id` | `character varying` | false | 255 | - | +| `key` | `text` | false | - | - | + +### Indices + +- `backstage_backend_public_keys__keys_pkey` (`id`) unique primary diff --git a/packages/backend-defaults/report-scheduler.sql.md b/packages/backend-defaults/report-scheduler.sql.md new file mode 100644 index 0000000000..5542ac48b0 --- /dev/null +++ b/packages/backend-defaults/report-scheduler.sql.md @@ -0,0 +1,18 @@ +## SQL Report file for "@backstage/backend-defaults/scheduler" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +## Table `backstage_backend_tasks__tasks` + +| Column | Type | Nullable | Max Length | Default | +| ------------------------ | -------------------------- | -------- | ---------- | ------- | +| `current_run_expires_at` | `timestamp with time zone` | true | - | - | +| `current_run_started_at` | `timestamp with time zone` | true | - | - | +| `current_run_ticket` | `text` | true | - | - | +| `id` | `character varying` | false | 255 | - | +| `next_run_start_at` | `timestamp with time zone` | true | - | - | +| `settings_json` | `text` | false | - | - | + +### Indices + +- `backstage_backend_tasks__tasks_pkey` (`id`) unique primary diff --git a/plugins/app-backend/report.sql.md b/plugins/app-backend/report.sql.md new file mode 100644 index 0000000000..e7bc9780fc --- /dev/null +++ b/plugins/app-backend/report.sql.md @@ -0,0 +1,17 @@ +## SQL Report file for "@backstage/plugin-app-backend" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +## Table `static_assets_cache` + +| Column | Type | Nullable | Max Length | Default | +| ------------------ | -------------------------- | -------- | ---------- | ------------------------------ | +| `content` | `bytea` | false | - | - | +| `last_modified_at` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `namespace` | `character varying` | false | 255 | `'default'::character varying` | +| `path` | `text` | false | - | - | + +### Indices + +- `static_asset_cache_last_modified_at_idx` (`last_modified_at`) +- `static_assets_cache_pkey` (`namespace`, `path`) unique primary diff --git a/plugins/auth-backend/report.sql.md b/plugins/auth-backend/report.sql.md new file mode 100644 index 0000000000..7eef7a33cb --- /dev/null +++ b/plugins/auth-backend/report.sql.md @@ -0,0 +1,44 @@ +## SQL Report file for "@backstage/plugin-auth-backend" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +> [!WARNING] +> Failed to migrate down from '20220321100910_timestamptz_again.js' + +## Table `sessions` + +| Column | Type | Nullable | Max Length | Default | +| --------- | -------------------------- | -------- | ---------- | ------- | +| `expired` | `timestamp with time zone` | false | - | - | +| `sess` | `text` | false | - | - | +| `sid` | `character varying` | false | 255 | - | + +### Indices + +- `sessions_expired_idx` (`expired`) +- `sessions_pkey` (`sid`) unique primary +- `sessions_sid_idx` (`sid`) + +## Table `signing_keys` + +| Column | Type | Nullable | Max Length | Default | +| ------------ | -------------------------- | -------- | ---------- | ------------------- | +| `created_at` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `key` | `text` | false | - | - | +| `kid` | `character varying` | false | 255 | - | + +### Indices + +- `signing_keys_pkey` (`kid`) unique primary + +## Table `user_info` + +| Column | Type | Nullable | Max Length | Default | +| ----------------- | -------------------------- | -------- | ---------- | ------- | +| `exp` | `timestamp with time zone` | false | - | - | +| `user_entity_ref` | `character varying` | false | 255 | - | +| `user_info` | `text` | false | - | - | + +### Indices + +- `user_info_pkey` (`user_entity_ref`) unique primary diff --git a/plugins/catalog-backend-module-incremental-ingestion/report.sql.md b/plugins/catalog-backend-module-incremental-ingestion/report.sql.md new file mode 100644 index 0000000000..d904d73e0d --- /dev/null +++ b/plugins/catalog-backend-module-incremental-ingestion/report.sql.md @@ -0,0 +1,53 @@ +## SQL Report file for "@backstage/plugin-catalog-backend-module-incremental-ingestion" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +## Table `ingestion_mark_entities` + +| Column | Type | Nullable | Max Length | Default | +| ------------------- | ------------------- | -------- | ---------- | ------- | +| `id` | `uuid` | false | - | - | +| `ingestion_mark_id` | `uuid` | false | - | - | +| `ref` | `character varying` | false | 255 | - | + +### Indices + +- `ingestion_mark_entities_pkey` (`id`) unique primary +- `ingestion_mark_entity_ingestion_mark_id_idx` (`ingestion_mark_id`) + +## Table `ingestion_marks` + +| Column | Type | Nullable | Max Length | Default | +| -------------- | -------------------------- | -------- | ---------- | ------------------- | +| `created_at` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `cursor` | `json` | true | - | - | +| `id` | `uuid` | false | - | - | +| `ingestion_id` | `uuid` | false | - | - | +| `sequence` | `integer` | false | - | `0` | + +### Indices + +- `ingestion_mark_ingestion_id_idx` (`ingestion_id`) +- `ingestion_marks_pkey` (`id`) unique primary + +## Table `ingestions` + +| Column | Type | Nullable | Max Length | Default | +| ------------------------ | -------------------------- | -------- | ---------- | ------------------- | +| `attempts` | `integer` | false | - | `0` | +| `completion_ticket` | `character varying` | false | 255 | - | +| `created_at` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `id` | `uuid` | false | - | - | +| `ingestion_completed_at` | `timestamp with time zone` | true | - | - | +| `last_error` | `character varying` | true | 255 | - | +| `next_action` | `character varying` | false | 255 | - | +| `next_action_at` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `provider_name` | `character varying` | false | 255 | - | +| `rest_completed_at` | `timestamp with time zone` | true | - | - | +| `status` | `character varying` | false | 255 | - | + +### Indices + +- `ingestion_composite_index` (`provider_name`, `completion_ticket`) unique +- `ingestion_provider_name_idx` (`provider_name`) +- `ingestions_pkey` (`id`) unique primary diff --git a/plugins/catalog-backend/report.sql.md b/plugins/catalog-backend/report.sql.md new file mode 100644 index 0000000000..3402b05063 --- /dev/null +++ b/plugins/catalog-backend/report.sql.md @@ -0,0 +1,137 @@ +## SQL Report file for "@backstage/plugin-catalog-backend" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +> [!WARNING] +> Failed to migrate down from '20241003170511_alter_target_in_locations.js' + +## Sequences + +- `location_update_log_id_seq` (bigint) +- `refresh_state_references_id_seq` (integer) + +## Table `final_entities` + +| Column | Type | Nullable | Max Length | Default | +| ----------------- | -------------------------- | -------- | ---------- | ------- | +| `entity_id` | `character varying` | false | 255 | - | +| `entity_ref` | `character varying` | false | 255 | - | +| `final_entity` | `text` | true | - | - | +| `hash` | `character varying` | false | 255 | - | +| `last_updated_at` | `timestamp with time zone` | true | - | - | +| `stitch_ticket` | `text` | false | - | - | + +### Indices + +- `final_entities_entity_ref_uniq` (`entity_ref`) unique +- `final_entities_pkey` (`entity_id`) unique primary + +## Table `location_update_log` + +| Column | Type | Nullable | Max Length | Default | +| ------------- | -------------------------- | -------- | ---------- | ------------------------------------------------- | +| `created_at` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `entity_name` | `text` | true | - | - | +| `id` | `bigint` | false | - | `nextval('location_update_log_id_seq'::regclass)` | +| `location_id` | `uuid` | true | - | - | +| `message` | `text` | true | - | - | +| `status` | `text` | false | - | - | + +### Indices + +- `location_update_log_pkey` (`id`) unique primary +- `update_log_location_id_idx` (`location_id`) + +## Table `locations` + +| Column | Type | Nullable | Max Length | Default | +| -------- | ------------------- | -------- | ---------- | ------- | +| `id` | `uuid` | false | - | - | +| `target` | `text` | true | - | - | +| `type` | `character varying` | false | 255 | - | + +### Indices + +- `locations_pkey` (`id`) unique primary + +## Table `refresh_keys` + +| Column | Type | Nullable | Max Length | Default | +| ----------- | ------------------- | -------- | ---------- | ------- | +| `entity_id` | `character varying` | false | 255 | - | +| `key` | `character varying` | false | 255 | - | + +### Indices + +- `refresh_keys_entity_id_idx` (`entity_id`) +- `refresh_keys_key_idx` (`key`) + +## Table `refresh_state` + +| Column | Type | Nullable | Max Length | Default | +| -------------------- | -------------------------- | -------- | ---------- | ------- | +| `cache` | `text` | true | - | - | +| `entity_id` | `character varying` | false | 255 | - | +| `entity_ref` | `character varying` | false | 255 | - | +| `errors` | `text` | false | - | - | +| `last_discovery_at` | `timestamp with time zone` | false | - | - | +| `location_key` | `text` | true | - | - | +| `next_stitch_at` | `timestamp with time zone` | true | - | - | +| `next_stitch_ticket` | `character varying` | true | 255 | - | +| `next_update_at` | `timestamp with time zone` | false | - | - | +| `processed_entity` | `text` | true | - | - | +| `result_hash` | `text` | true | - | - | +| `unprocessed_entity` | `text` | false | - | - | +| `unprocessed_hash` | `text` | true | - | - | + +### Indices + +- `refresh_state_entity_ref_uniq` (`entity_ref`) unique +- `refresh_state_next_stitch_at_idx` (`next_stitch_at`) +- `refresh_state_next_update_at_idx` (`next_update_at`) +- `refresh_state_pkey` (`entity_id`) unique primary + +## Table `refresh_state_references` + +| Column | Type | Nullable | Max Length | Default | +| ------------------- | --------- | -------- | ---------- | ------------------------------------------------------ | +| `id` | `integer` | false | - | `nextval('refresh_state_references_id_seq'::regclass)` | +| `source_entity_ref` | `text` | true | - | - | +| `source_key` | `text` | true | - | - | +| `target_entity_ref` | `text` | false | - | - | + +### Indices + +- `refresh_state_references_pkey` (`id`) unique primary +- `refresh_state_references_source_entity_ref_idx` (`source_entity_ref`) +- `refresh_state_references_source_key_idx` (`source_key`) +- `refresh_state_references_target_entity_ref_idx` (`target_entity_ref`) + +## Table `relations` + +| Column | Type | Nullable | Max Length | Default | +| ----------------------- | ------------------- | -------- | ---------- | ------- | +| `originating_entity_id` | `character varying` | false | 255 | - | +| `source_entity_ref` | `character varying` | false | 255 | - | +| `target_entity_ref` | `character varying` | false | 255 | - | +| `type` | `character varying` | false | 255 | - | + +### Indices + +- `relations_source_entity_id_idx` (`originating_entity_id`) +- `relations_source_entity_ref_idx` (`source_entity_ref`) + +## Table `search` + +| Column | Type | Nullable | Max Length | Default | +| ---------------- | ------------------- | -------- | ---------- | ------- | +| `entity_id` | `character varying` | true | 255 | - | +| `key` | `character varying` | false | 255 | - | +| `original_value` | `character varying` | true | 255 | - | +| `value` | `character varying` | true | 255 | - | + +### Indices + +- `search_entity_id_idx` (`entity_id`) +- `search_key_original_value_idx` (`key`, `original_value`) +- `search_key_value_idx` (`key`, `value`) diff --git a/plugins/events-backend/report.sql.md b/plugins/events-backend/report.sql.md new file mode 100644 index 0000000000..117b41afd5 --- /dev/null +++ b/plugins/events-backend/report.sql.md @@ -0,0 +1,38 @@ +## SQL Report file for "@backstage/plugin-events-backend" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +## Sequences + +- `event_bus_events_id_seq` (bigint) + +## Table `event_bus_events` + +| Column | Type | Nullable | Max Length | Default | +| ---------------------- | -------------------------- | -------- | ---------- | ---------------------------------------------- | +| `created_at` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `created_by` | `text` | false | - | - | +| `data_json` | `text` | false | - | - | +| `id` | `bigint` | false | - | `nextval('event_bus_events_id_seq'::regclass)` | +| `notified_subscribers` | `ARRAY` | true | - | - | +| `topic` | `text` | false | - | - | + +### Indices + +- `event_bus_events_pkey` (`id`) unique primary +- `event_bus_events_topic_idx` (`topic`) + +## Table `event_bus_subscriptions` + +| Column | Type | Nullable | Max Length | Default | +| ------------ | -------------------------- | -------- | ---------- | ------------------- | +| `created_at` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `created_by` | `text` | false | - | - | +| `id` | `character varying` | false | 255 | - | +| `read_until` | `bigint` | false | - | - | +| `topics` | `ARRAY` | true | - | - | +| `updated_at` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | + +### Indices + +- `event_bus_subscriptions_pkey` (`id`) unique primary diff --git a/plugins/notifications-backend/report.sql.md b/plugins/notifications-backend/report.sql.md new file mode 100644 index 0000000000..6b9066e77c --- /dev/null +++ b/plugins/notifications-backend/report.sql.md @@ -0,0 +1,76 @@ +## SQL Report file for "@backstage/plugin-notifications-backend" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +## Table `broadcast` + +| Column | Type | Nullable | Max Length | Default | +| ------------- | -------------------------- | -------- | ---------- | ------------------- | +| `created` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `description` | `text` | true | - | - | +| `icon` | `character varying` | true | 255 | - | +| `id` | `uuid` | false | - | - | +| `link` | `text` | true | - | - | +| `origin` | `character varying` | false | 255 | - | +| `scope` | `character varying` | true | 255 | - | +| `severity` | `character varying` | false | 8 | - | +| `title` | `character varying` | false | 255 | - | +| `topic` | `character varying` | true | 255 | - | +| `updated` | `timestamp with time zone` | true | - | - | + +### Indices + +- `broadcast_cope_origin_idx` (`scope`, `origin`) +- `broadcast_pkey` (`id`) unique primary + +## Table `broadcast_user_status` + +| Column | Type | Nullable | Max Length | Default | +| -------------- | -------------------------- | -------- | ---------- | ------- | +| `broadcast_id` | `uuid` | false | - | - | +| `read` | `timestamp with time zone` | true | - | - | +| `saved` | `timestamp with time zone` | true | - | - | +| `user` | `character varying` | false | 255 | - | + +### Indices + +- `broadcast_user_idx` (`broadcast_id`, `user`) unique + +## Table `notification` + +| Column | Type | Nullable | Max Length | Default | +| ------------- | -------------------------- | -------- | ---------- | ------------------- | +| `created` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `description` | `text` | true | - | - | +| `icon` | `character varying` | true | 255 | - | +| `id` | `uuid` | false | - | - | +| `link` | `text` | true | - | - | +| `origin` | `character varying` | false | 255 | - | +| `read` | `timestamp with time zone` | true | - | - | +| `saved` | `timestamp with time zone` | true | - | - | +| `scope` | `character varying` | true | 255 | - | +| `severity` | `character varying` | false | 8 | - | +| `title` | `character varying` | false | 255 | - | +| `topic` | `character varying` | true | 255 | - | +| `updated` | `timestamp with time zone` | true | - | - | +| `user` | `character varying` | false | 255 | - | + +### Indices + +- `notification_pkey` (`id`) unique primary +- `notification_scope_origin_idx` (`scope`, `origin`) +- `notification_user_idx` (`user`) + +## Table `user_settings` + +| Column | Type | Nullable | Max Length | Default | +| --------- | ------------------- | -------- | ---------- | ------- | +| `channel` | `character varying` | false | 255 | - | +| `enabled` | `boolean` | false | - | `true` | +| `origin` | `character varying` | false | 255 | - | +| `user` | `character varying` | false | 255 | - | + +### Indices + +- `user_settings_unique_idx` (`user`, `channel`, `origin`) unique +- `user_settings_user_idx` (`user`) diff --git a/plugins/scaffolder-backend/report.sql.md b/plugins/scaffolder-backend/report.sql.md new file mode 100644 index 0000000000..34c57266aa --- /dev/null +++ b/plugins/scaffolder-backend/report.sql.md @@ -0,0 +1,40 @@ +## SQL Report file for "@backstage/plugin-scaffolder-backend" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +## Sequences + +- `task_events_id_seq` (bigint) + +## Table `task_events` + +| Column | Type | Nullable | Max Length | Default | +| ------------ | -------------------------- | -------- | ---------- | ----------------------------------------- | +| `body` | `text` | false | - | - | +| `created_at` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `event_type` | `text` | false | - | - | +| `id` | `bigint` | false | - | `nextval('task_events_id_seq'::regclass)` | +| `task_id` | `uuid` | false | - | - | + +### Indices + +- `task_events_pkey` (`id`) unique primary +- `task_events_task_id_idx` (`task_id`) + +## Table `tasks` + +| Column | Type | Nullable | Max Length | Default | +| ------------------- | -------------------------- | -------- | ---------- | ------------------- | +| `created_at` | `timestamp with time zone` | false | - | `CURRENT_TIMESTAMP` | +| `created_by` | `text` | true | - | - | +| `id` | `uuid` | false | - | - | +| `last_heartbeat_at` | `timestamp with time zone` | true | - | - | +| `secrets` | `text` | true | - | - | +| `spec` | `text` | false | - | - | +| `state` | `text` | true | - | - | +| `status` | `text` | false | - | - | +| `workspace` | `bytea` | true | - | - | + +### Indices + +- `tasks_pkey` (`id`) unique primary diff --git a/plugins/search-backend-module-pg/report.sql.md b/plugins/search-backend-module-pg/report.sql.md new file mode 100644 index 0000000000..ebb5bad3e4 --- /dev/null +++ b/plugins/search-backend-module-pg/report.sql.md @@ -0,0 +1,19 @@ +## SQL Report file for "@backstage/plugin-search-backend-module-pg" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +## Table `documents` + +| Column | Type | Nullable | Max Length | Default | +| ---------- | ---------- | -------- | ---------- | ------- | +| `body` | `tsvector` | false | - | - | +| `document` | `jsonb` | false | - | - | +| `hash` | `bytea` | false | - | - | +| `type` | `text` | false | - | - | + +### Indices + +- `documents_body_index` (`body`) +- `documents_document_index` (`document`) +- `documents_pkey` (`hash`) unique primary +- `documents_type_index` (`type`) diff --git a/plugins/user-settings-backend/report.sql.md b/plugins/user-settings-backend/report.sql.md new file mode 100644 index 0000000000..bb312cf015 --- /dev/null +++ b/plugins/user-settings-backend/report.sql.md @@ -0,0 +1,16 @@ +## SQL Report file for "@backstage/plugin-user-settings-backend" + +> Do not edit this file. It is a report generated by `yarn build:api-reports` + +## Table `user_settings` + +| Column | Type | Nullable | Max Length | Default | +| ----------------- | ------------------- | -------- | ---------- | ------- | +| `bucket` | `character varying` | false | 255 | - | +| `key` | `character varying` | false | 255 | - | +| `user_entity_ref` | `character varying` | false | 255 | - | +| `value` | `text` | false | - | - | + +### Indices + +- `user_settings_pkey` (`user_entity_ref`, `bucket`, `key`) unique primary