risingwave_frontend/catalog/system_catalog/pg_catalog/
pg_index.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use risingwave_common::types::Fields;
16use risingwave_frontend_macro::system_catalog;
17
18/// The catalog `pg_index` contains part of the information about indexes.
19/// Ref: [`https://www.postgresql.org/docs/current/catalog-pg-index.html`]
20#[system_catalog(
21    view,
22    "pg_catalog.pg_index",
23    "SELECT id AS indexrelid,
24        primary_table_id AS indrelid,
25        ARRAY_LENGTH(key_columns || include_columns)::smallint AS indnatts,
26        ARRAY_LENGTH(key_columns)::smallint AS indnkeyatts,
27        false AS indisunique,
28        key_columns || include_columns AS indkey,
29        ARRAY[]::smallint[] as indoption,
30        NULL AS indexprs,
31        NULL AS indpred,
32        FALSE AS indisprimary,
33        ARRAY[]::int[] AS indclass,
34        false AS indisexclusion,
35        true AS indimmediate,
36        false AS indisclustered,
37        true AS indisvalid,
38        false AS indcheckxmin,
39        true AS indisready,
40        true AS indislive,
41        false AS indisreplident
42    FROM rw_catalog.rw_indexes
43    UNION ALL
44    SELECT c.relation_id AS indexrelid,
45        c.relation_id AS indrelid,
46        COUNT(*)::smallint AS indnatts,
47        COUNT(*)::smallint AS indnkeyatts,
48        true AS indisunique,
49        ARRAY_AGG(c.position)::smallint[] AS indkey,
50        ARRAY[]::smallint[] as indoption,
51        NULL AS indexprs,
52        NULL AS indpred,
53        TRUE AS indisprimary,
54        ARRAY[]::int[] AS indclass,
55        false AS indisexclusion,
56        true AS indimmediate,
57        false AS indisclustered,
58        true AS indisvalid,
59        false AS indcheckxmin,
60        true AS indisready,
61        true AS indislive,
62        false AS indisreplident
63    FROM rw_catalog.rw_columns c
64    WHERE c.is_primary_key = true AND c.is_hidden = false
65    AND c.relation_id IN (
66        SELECT id
67        FROM rw_catalog.rw_tables
68    )
69    GROUP BY c.relation_id"
70)]
71#[derive(Fields)]
72struct PgIndex {
73    indexrelid: i32,
74    indrelid: i32,
75    indnatts: i16,
76    indnkeyatts: i16,
77    // We return false as default to indicate that this is NOT a unique index
78    indisunique: bool,
79    indkey: Vec<i16>,
80    indoption: Vec<i16>,
81    // None. We don't have `pg_node_tree` type yet, so we use `text` instead.
82    indexprs: Option<String>,
83    // None. We don't have `pg_node_tree` type yet, so we use `text` instead.
84    indpred: Option<String>,
85    // TODO: we return false as the default value.
86    indisprimary: bool,
87    // Empty array. We only have a dummy implementation of `pg_opclass` yet.
88    indclass: Vec<i32>,
89
90    // Unused columns. Kept for compatibility with PG.
91    indisexclusion: bool,
92    indimmediate: bool,
93    indisclustered: bool,
94    indisvalid: bool,
95    indcheckxmin: bool,
96    indisready: bool,
97    indislive: bool,
98    indisreplident: bool,
99}
risingwave_frontend/catalog/system_catalog/pg_catalog/pg_index.rs

risingwave_frontend/catalog/system_catalog/pg_catalog/
pg_index.rs
