docs: missing documentation for system.password_policies system table

Open Beginner friendly
#3,206 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
sql

Research direction

Read the existing system-table documentation and inspect src/query/storages/system/src/password_policies_table.rs for the table definition. Add docs/en/sql-reference/00-sql-reference/31-system-tables/system-password-policies.md with the stated schema and options, then link it from the system tables index. Done means the page explains system.password_policies and is discoverable from that index.

Written by the indexing model from the issue text.

Description

automated issue documentation

Missing Documentation

The system.password_policies system table is implemented in the Databend source code but has no corresponding documentation page in databend-docs.

Source Code

  • /workspace/databend/src/query/storages/system/src/password_policies_table.rs
  • Table name: system.password_policies

Description

system.password_policies lists all password policies defined in the current tenant. Password policies control requirements such as minimum/maximum length, character class requirements, age limits, retry limits, and lockout behavior for user accounts.

Schema
Column Type Description
name String Password policy name
comment String User-defined comment
options String Comma-separated policy settings (e.g. MIN_LENGTH=8, MAX_LENGTH=256, MIN_UPPER_CASE_CHARS=1, ...)
created_on Timestamp Creation timestamp
updated_on Timestamp (Nullable) Last update timestamp
Options included in the options column
  • MIN_LENGTH / MAX_LENGTH
  • MIN_UPPER_CASE_CHARS / MIN_LOWER_CASE_CHARS
  • MIN_NUMERIC_CHARS / MIN_SPECIAL_CHARS
  • MIN_AGE_DAYS / MAX_AGE_DAYS
  • MAX_RETRIES / LOCKOUT_TIME_MINS
  • HISTORY

Suggested Doc Location

docs/en/sql-reference/00-sql-reference/31-system-tables/system-password-policies.md

This should be added alongside the existing system table docs and linked from the system tables index.

Dominant language
TypeScript
Stars
17
Forks
44
Avg merge
2d 7m
Merged PRs (30d)
4

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from databendlabs/databend-docs

All issues in databendlabs/databend-docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.