Index naming standards in PostgreSQL
For indexes, use the following naming standards:
- `idx_tablename_columnname` for single column indexes,
- `idx_tablename_col1_col2` for multi-column indexes
## Bad
```sql
-- Bad: Inconsistent and unclear index names
Install this rule for wispbit
Add this rule to wispbit and it will run when you open a pull request
Install this rule for Coderabbit
Copy the configuration below and add it to your repository as .coderabbit.yml
in your project root.
reviews:
path_instructions:
- path: "*.sql"
instructions: |
For indexes, use the following naming standards:
- `idx_tablename_columnname` for single column indexes,
- `idx_tablename_col1_col2` for multi-column indexes
## Bad
```sql
-- Bad: Inconsistent and unclear index names
CREATE INDEX email_index ON users(email);
CREATE INDEX user_orders ON orders(user_id);
CREATE INDEX idx_prod_cat_stat ON products(category, status);
```
## Good
```sql
-- Good: Consistent index naming
CREATE INDEX idx_users_email ON users(email);
CREATE INDEX idx_orders_user_id ON orders(user_id);
CREATE INDEX idx_products_category_status ON products(category, status);
```
Install this rule for Greptile
Greptile rules can be added through the web interface. Please see this documentation for details on how to add custom rules and context.
For indexes, use the following naming standards:
- `idx_tablename_columnname` for single column indexes,
- `idx_tablename_col1_col2` for multi-column indexes
## Bad
```sql
-- Bad: Inconsistent and unclear index names
CREATE INDEX email_index ON users(email);
CREATE INDEX user_orders ON orders(user_id);
CREATE INDEX idx_prod_cat_stat ON products(category, status);
```
## Good
```sql
-- Good: Consistent index naming
CREATE INDEX idx_users_email ON users(email);
CREATE INDEX idx_orders_user_id ON orders(user_id);
CREATE INDEX idx_products_category_status ON products(category, status);
```
File Path Patterns:
Install this rule for GitHub Copilot
Copilot instructions can be added through the interface. See the documentation for details on how to create coding guidelines.
For indexes, use the following naming standards:
- `idx_tablename_columnname` for single column indexes,
- `idx_tablename_col1_col2` for multi-column indexes
## Bad
```sql
-- Bad: Inconsistent and unclear index names
CREATE INDEX email_index ON users(email);
CREATE INDEX user_orders ON orders(user_id);
CREATE INDEX idx_prod_cat_stat ON products(category, status);
```
## Good
```sql
-- Good: Consistent index naming
CREATE INDEX idx_users_email ON users(email);
CREATE INDEX idx_orders_user_id ON orders(user_id);
CREATE INDEX idx_products_category_status ON products(category, status);
```
File Path Patterns:
Install this rule for Graphite Diamond
Diamond custom rules can be added through the interface. See the documentation for details on how to create custom rules.
For indexes, use the following naming standards:
- `idx_tablename_columnname` for single column indexes,
- `idx_tablename_col1_col2` for multi-column indexes
## Bad
```sql
-- Bad: Inconsistent and unclear index names
CREATE INDEX email_index ON users(email);
CREATE INDEX user_orders ON orders(user_id);
CREATE INDEX idx_prod_cat_stat ON products(category, status);
```
## Good
```sql
-- Good: Consistent index naming
CREATE INDEX idx_users_email ON users(email);
CREATE INDEX idx_orders_user_id ON orders(user_id);
CREATE INDEX idx_products_category_status ON products(category, status);
```
File Path Patterns:
Use with Cline
Copy the rule below and ask Cline to review your code using this rule
For indexes, use the following naming standards:
- `idx_tablename_columnname` for single column indexes,
- `idx_tablename_col1_col2` for multi-column indexes
## Bad
```sql
-- Bad: Inconsistent and unclear index names
CREATE INDEX email_index ON users(email);
CREATE INDEX user_orders ON orders(user_id);
CREATE INDEX idx_prod_cat_stat ON products(category, status);
```
## Good
```sql
-- Good: Consistent index naming
CREATE INDEX idx_users_email ON users(email);
CREATE INDEX idx_orders_user_id ON orders(user_id);
CREATE INDEX idx_products_category_status ON products(category, status);
```
Use with OpenAI Codex
Copy the rule below and ask OpenAI Codex to review your code using this rule
For indexes, use the following naming standards:
- `idx_tablename_columnname` for single column indexes,
- `idx_tablename_col1_col2` for multi-column indexes
## Bad
```sql
-- Bad: Inconsistent and unclear index names
CREATE INDEX email_index ON users(email);
CREATE INDEX user_orders ON orders(user_id);
CREATE INDEX idx_prod_cat_stat ON products(category, status);
```
## Good
```sql
-- Good: Consistent index naming
CREATE INDEX idx_users_email ON users(email);
CREATE INDEX idx_orders_user_id ON orders(user_id);
CREATE INDEX idx_products_category_status ON products(category, status);
```
Use with Cursor
Copy the rule below and ask Cursor to review your code using this rule
For indexes, use the following naming standards:
- `idx_tablename_columnname` for single column indexes,
- `idx_tablename_col1_col2` for multi-column indexes
## Bad
```sql
-- Bad: Inconsistent and unclear index names
CREATE INDEX email_index ON users(email);
CREATE INDEX user_orders ON orders(user_id);
CREATE INDEX idx_prod_cat_stat ON products(category, status);
```
## Good
```sql
-- Good: Consistent index naming
CREATE INDEX idx_users_email ON users(email);
CREATE INDEX idx_orders_user_id ON orders(user_id);
CREATE INDEX idx_products_category_status ON products(category, status);
```
Use with Claude Code
Copy the rule below and ask Claude Code to review your code using this rule
For indexes, use the following naming standards:
- `idx_tablename_columnname` for single column indexes,
- `idx_tablename_col1_col2` for multi-column indexes
## Bad
```sql
-- Bad: Inconsistent and unclear index names
CREATE INDEX email_index ON users(email);
CREATE INDEX user_orders ON orders(user_id);
CREATE INDEX idx_prod_cat_stat ON products(category, status);
```
## Good
```sql
-- Good: Consistent index naming
CREATE INDEX idx_users_email ON users(email);
CREATE INDEX idx_orders_user_id ON orders(user_id);
CREATE INDEX idx_products_category_status ON products(category, status);
```
Install this rule for Windsurf
To set up rules for Windsurf Reviews, please see this documentation
For indexes, use the following naming standards:
- `idx_tablename_columnname` for single column indexes,
- `idx_tablename_col1_col2` for multi-column indexes
## Bad
```sql
-- Bad: Inconsistent and unclear index names
CREATE INDEX email_index ON users(email);
CREATE INDEX user_orders ON orders(user_id);
CREATE INDEX idx_prod_cat_stat ON products(category, status);
```
## Good
```sql
-- Good: Consistent index naming
CREATE INDEX idx_users_email ON users(email);
CREATE INDEX idx_orders_user_id ON orders(user_id);
CREATE INDEX idx_products_category_status ON products(category, status);
```