@intentius/chant-lexicon-sql 0.0.0-stage → 0.112.0

package/dist/meta.json

@@ -0,0 +1,67 @@
+{
+  "Database": {
+    "resourceType": "ClickHouse::Database",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "Table": {
+    "resourceType": "ClickHouse::Table",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "View": {
+    "resourceType": "ClickHouse::View",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "MaterializedView": {
+    "resourceType": "ClickHouse::MaterializedView",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "PostgresSchema": {
+    "resourceType": "Postgres::Schema",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "PostgresTable": {
+    "resourceType": "Postgres::Table",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "PostgresIndex": {
+    "resourceType": "Postgres::Index",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "PostgresView": {
+    "resourceType": "Postgres::View",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "PostgresMaterializedView": {
+    "resourceType": "Postgres::MaterializedView",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "PostgresSequence": {
+    "resourceType": "Postgres::Sequence",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "PostgresEnum": {
+    "resourceType": "Postgres::Enum",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "PostgresDomain": {
+    "resourceType": "Postgres::Domain",
+    "kind": "resource",
+    "lexicon": "sql"
+  },
+  "PostgresExtension": {
+    "resourceType": "Postgres::Extension",
+    "kind": "resource",
+    "lexicon": "sql"
+  }
+}

package/dist/okf/index.md

@@ -0,0 +1,67 @@
+---
+okf_version: '0.2'
+---
+
+# Resource types
+
+* [Database](/types/Database.md) - ClickHouse::Database
+* [MaterializedView](/types/MaterializedView.md) - ClickHouse::MaterializedView
+* [PostgresDomain](/types/PostgresDomain.md) - Postgres::Domain
+* [PostgresEnum](/types/PostgresEnum.md) - Postgres::Enum
+* [PostgresExtension](/types/PostgresExtension.md) - Postgres::Extension
+* [PostgresIndex](/types/PostgresIndex.md) - Postgres::Index
+* [PostgresMaterializedView](/types/PostgresMaterializedView.md) - Postgres::MaterializedView
+* [PostgresSchema](/types/PostgresSchema.md) - Postgres::Schema
+* [PostgresSequence](/types/PostgresSequence.md) - Postgres::Sequence
+* [PostgresTable](/types/PostgresTable.md) - Postgres::Table
+* [PostgresView](/types/PostgresView.md) - Postgres::View
+* [Table](/types/Table.md) - ClickHouse::Table
+* [View](/types/View.md) - ClickHouse::View
+
+# Rules
+
+* [SQLCH001](/rules/SQLCH001.md) - the DDL in a `database`, `table` or `view` template does not parse, or holds another statement than its tag.
+* [SQLCH002](/rules/SQLCH002.md) - a `Nullable` column in a table's sort key or primary key.
+* [SQLCH003](/rules/SQLCH003.md) - a column written as `${events.kind}` instead of `${events.columns.kind}`.
+* [SQLCH101](/rules/SQLCH101.md) - A ClickHouse object names an engine the pinned server does not have
+* [SQLCH102](/rules/SQLCH102.md) - A PRIMARY KEY is not a prefix of ORDER BY
+* [SQLCH103](/rules/SQLCH103.md) - An engine's version, sign or is_deleted column has an unsupported type
+* [SQLCH104](/rules/SQLCH104.md) - A MergeTree engine argument names a column the table does not declare
+* [SQLCH105](/rules/SQLCH105.md) - A table key clause names a column the table does not declare
+* [SQLCH106](/rules/SQLCH106.md) - A skip index expression names a column the table does not declare
+* [SQLCH107](/rules/SQLCH107.md) - A TTL expression is built on a column that is not a Date or DateTime
+* [SQLCH108](/rules/SQLCH108.md) - CREATE OR REPLACE TABLE in a database that is not Atomic
+* [SQLCH109](/rules/SQLCH109.md) - A materialized view selects *
+* [SQLCH110](/rules/SQLCH110.md) - A materialized view writes a column its TO target does not declare
+* [SQLCH111](/rules/SQLCH111.md) - A String column limited to a few values is not LowCardinality
+* [SQLCH112](/rules/SQLCH112.md) - A PARTITION BY expression is finer than a day
+* [SQLCH113](/rules/SQLCH113.md) - A MergeTree table declares no sort key
+* [SQLCH114](/rules/SQLCH114.md) - A column codec is not one the pinned server has
+* [SQLCH115](/rules/SQLCH115.md) - A secret- or PII-named column carries no comment, TTL or encryption
+* [SQLCH116](/rules/SQLCH116.md) - A view is SQL SECURITY DEFINER with no DEFINER
+* [SQLCH117](/rules/SQLCH117.md) - A MergeTree setting is obsolete at the pinned server
+* [SQLCH118](/rules/SQLCH118.md) - A MergeTree setting is not one the pinned server has
+* [SQLCH119](/rules/SQLCH119.md) - An object uses a deprecated or experimental engine
+* [SQLCH120](/rules/SQLCH120.md) - A MergeTree engine uses the deprecated positional arguments
+* [SQLPG001](/rules/SQLPG001.md) - the DDL in a Postgres template does not parse, or does not hold
+* [SQLPG002](/rules/SQLPG002.md) - a column written as `${events.kind}` instead of `${events.columns.kind}`.
+* [SQLPG003](/rules/SQLPG003.md) - an object named in a string where Postgres reads a `regclass`:
+* [SQLPG004](/rules/SQLPG004.md) - a declared extension the configured provider does not allow.
+* [SQLPG101](/rules/SQLPG101.md) - A table declares no primary key
+* [SQLPG102](/rules/SQLPG102.md) - A foreign key's referencing columns have no index
+* [SQLPG103](/rules/SQLPG103.md) - A serial column where an identity column is preferred
+* [SQLPG104](/rules/SQLPG104.md) - A timestamp column without time zone
+* [SQLPG105](/rules/SQLPG105.md) - A json column where jsonb fits
+* [SQLPG106](/rules/SQLPG106.md) - A char(n) column
+* [SQLPG107](/rules/SQLPG107.md) - A money column
+* [SQLPG108](/rules/SQLPG108.md) - A varchar(n) column with a habitual length limit
+* [SQLPG109](/rules/SQLPG109.md) - An index duplicates a constraint or another index
+* [SQLPG110](/rules/SQLPG110.md) - A btree index is a prefix of another index
+* [SQLPG111](/rules/SQLPG111.md) - A materialized view has no unique index, so it cannot refresh concurrently
+* [SQLPG112](/rules/SQLPG112.md) - A secret- or PII-named column with no comment on it or its table
+* [SQLPG113](/rules/SQLPG113.md) - An object is in the public schema though the project declares schemas
+* [SQLPG114](/rules/SQLPG114.md) - A storage parameter the object's kind or the target major does not accept
+* [SQLPG115](/rules/SQLPG115.md) - A feature newer than the target major
+* [SQLPG116](/rules/SQLPG116.md) - An extension the target major no longer ships
+* [SQLPG117](/rules/SQLPG117.md) - A view without security_invoker runs with its owner's privileges
+* [SQLPG118](/rules/SQLPG118.md) - A table uses INHERITS where declarative partitioning replaced it

package/dist/okf/rules/SQLCH001.md

@@ -0,0 +1,11 @@
+---
+type: lint-rule
+title: SQLCH001
+description: the DDL in a `database`, `table` or `view` template does not parse, or holds another statement than its tag.
+id: SQLCH001
+severity: error
+category: correctness
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+the DDL in a `database`, `table` or `view` template does not parse, or holds another statement than its tag.

package/dist/okf/rules/SQLCH002.md

@@ -0,0 +1,11 @@
+---
+type: lint-rule
+title: SQLCH002
+description: a `Nullable` column in a table's sort key or primary key.
+id: SQLCH002
+severity: error
+category: correctness
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+a `Nullable` column in a table's sort key or primary key.

package/dist/okf/rules/SQLCH003.md

@@ -0,0 +1,11 @@
+---
+type: lint-rule
+title: SQLCH003
+description: a column written as `${events.kind}` instead of `${events.columns.kind}`.
+id: SQLCH003
+severity: error
+category: correctness
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+a column written as `${events.kind}` instead of `${events.columns.kind}`.

package/dist/okf/rules/SQLCH101.md

@@ -0,0 +1,15 @@
+---
+type: post-synth-check
+title: SQLCH101
+description: A ClickHouse object names an engine the pinned server does not have
+id: SQLCH101
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A ClickHouse object names an engine the pinned server does not have
+
+## Applies to
+
+- [Database](/types/Database.md)

package/dist/okf/rules/SQLCH102.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH102
+description: A PRIMARY KEY is not a prefix of ORDER BY
+id: SQLCH102
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A PRIMARY KEY is not a prefix of ORDER BY

package/dist/okf/rules/SQLCH103.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH103
+description: An engine's version, sign or is_deleted column has an unsupported type
+id: SQLCH103
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+An engine's version, sign or is_deleted column has an unsupported type

package/dist/okf/rules/SQLCH104.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH104
+description: A MergeTree engine argument names a column the table does not declare
+id: SQLCH104
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A MergeTree engine argument names a column the table does not declare

package/dist/okf/rules/SQLCH105.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH105
+description: A table key clause names a column the table does not declare
+id: SQLCH105
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A table key clause names a column the table does not declare

package/dist/okf/rules/SQLCH106.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH106
+description: A skip index expression names a column the table does not declare
+id: SQLCH106
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A skip index expression names a column the table does not declare

package/dist/okf/rules/SQLCH107.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH107
+description: A TTL expression is built on a column that is not a Date or DateTime
+id: SQLCH107
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A TTL expression is built on a column that is not a Date or DateTime

package/dist/okf/rules/SQLCH108.md

@@ -0,0 +1,15 @@
+---
+type: post-synth-check
+title: SQLCH108
+description: CREATE OR REPLACE TABLE in a database that is not Atomic
+id: SQLCH108
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+CREATE OR REPLACE TABLE in a database that is not Atomic
+
+## Applies to
+
+- [Database](/types/Database.md)

package/dist/okf/rules/SQLCH109.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH109
+description: A materialized view selects *
+id: SQLCH109
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A materialized view selects *

package/dist/okf/rules/SQLCH110.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH110
+description: A materialized view writes a column its TO target does not declare
+id: SQLCH110
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A materialized view writes a column its TO target does not declare

package/dist/okf/rules/SQLCH111.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH111
+description: A String column limited to a few values is not LowCardinality
+id: SQLCH111
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A String column limited to a few values is not LowCardinality

package/dist/okf/rules/SQLCH112.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH112
+description: A PARTITION BY expression is finer than a day
+id: SQLCH112
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A PARTITION BY expression is finer than a day

package/dist/okf/rules/SQLCH113.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH113
+description: A MergeTree table declares no sort key
+id: SQLCH113
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A MergeTree table declares no sort key

package/dist/okf/rules/SQLCH114.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH114
+description: A column codec is not one the pinned server has
+id: SQLCH114
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A column codec is not one the pinned server has

package/dist/okf/rules/SQLCH115.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH115
+description: A secret- or PII-named column carries no comment, TTL or encryption
+id: SQLCH115
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A secret- or PII-named column carries no comment, TTL or encryption

package/dist/okf/rules/SQLCH116.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLCH116
+description: A view is SQL SECURITY DEFINER with no DEFINER
+id: SQLCH116
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A view is SQL SECURITY DEFINER with no DEFINER

package/dist/okf/rules/SQLCH117.md

@@ -0,0 +1,15 @@
+---
+type: post-synth-check
+title: SQLCH117
+description: A MergeTree setting is obsolete at the pinned server
+id: SQLCH117
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A MergeTree setting is obsolete at the pinned server
+
+## Applies to
+
+- [MaterializedView](/types/MaterializedView.md)

package/dist/okf/rules/SQLCH118.md

@@ -0,0 +1,15 @@
+---
+type: post-synth-check
+title: SQLCH118
+description: A MergeTree setting is not one the pinned server has
+id: SQLCH118
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A MergeTree setting is not one the pinned server has
+
+## Applies to
+
+- [Table](/types/Table.md)

package/dist/okf/rules/SQLCH119.md

@@ -0,0 +1,15 @@
+---
+type: post-synth-check
+title: SQLCH119
+description: An object uses a deprecated or experimental engine
+id: SQLCH119
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+An object uses a deprecated or experimental engine
+
+## Applies to
+
+- [Database](/types/Database.md)

package/dist/okf/rules/SQLCH120.md

@@ -0,0 +1,15 @@
+---
+type: post-synth-check
+title: SQLCH120
+description: A MergeTree engine uses the deprecated positional arguments
+id: SQLCH120
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A MergeTree engine uses the deprecated positional arguments
+
+## Applies to
+
+- [Table](/types/Table.md)

package/dist/okf/rules/SQLPG001.md

@@ -0,0 +1,11 @@
+---
+type: lint-rule
+title: SQLPG001
+description: the DDL in a Postgres template does not parse, or does not hold
+id: SQLPG001
+severity: error
+category: correctness
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+the DDL in a Postgres template does not parse, or does not hold

package/dist/okf/rules/SQLPG002.md

@@ -0,0 +1,11 @@
+---
+type: lint-rule
+title: SQLPG002
+description: a column written as `${events.kind}` instead of `${events.columns.kind}`.
+id: SQLPG002
+severity: error
+category: correctness
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+a column written as `${events.kind}` instead of `${events.columns.kind}`.

package/dist/okf/rules/SQLPG003.md

@@ -0,0 +1,11 @@
+---
+type: lint-rule
+title: SQLPG003
+description: 'an object named in a string where Postgres reads a `regclass`:'
+id: SQLPG003
+severity: warning
+category: correctness
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+an object named in a string where Postgres reads a `regclass`:

package/dist/okf/rules/SQLPG004.md

@@ -0,0 +1,11 @@
+---
+type: lint-rule
+title: SQLPG004
+description: a declared extension the configured provider does not allow.
+id: SQLPG004
+severity: error
+category: correctness
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+a declared extension the configured provider does not allow.

package/dist/okf/rules/SQLPG101.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG101
+description: A table declares no primary key
+id: SQLPG101
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A table declares no primary key

package/dist/okf/rules/SQLPG102.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG102
+description: A foreign key's referencing columns have no index
+id: SQLPG102
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A foreign key's referencing columns have no index

package/dist/okf/rules/SQLPG103.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG103
+description: A serial column where an identity column is preferred
+id: SQLPG103
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A serial column where an identity column is preferred

package/dist/okf/rules/SQLPG104.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG104
+description: A timestamp column without time zone
+id: SQLPG104
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A timestamp column without time zone

package/dist/okf/rules/SQLPG105.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG105
+description: A json column where jsonb fits
+id: SQLPG105
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A json column where jsonb fits

package/dist/okf/rules/SQLPG106.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG106
+description: A char(n) column
+id: SQLPG106
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A char(n) column

package/dist/okf/rules/SQLPG107.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG107
+description: A money column
+id: SQLPG107
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A money column

package/dist/okf/rules/SQLPG108.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG108
+description: A varchar(n) column with a habitual length limit
+id: SQLPG108
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A varchar(n) column with a habitual length limit

package/dist/okf/rules/SQLPG109.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG109
+description: An index duplicates a constraint or another index
+id: SQLPG109
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+An index duplicates a constraint or another index

package/dist/okf/rules/SQLPG110.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG110
+description: A btree index is a prefix of another index
+id: SQLPG110
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A btree index is a prefix of another index

package/dist/okf/rules/SQLPG111.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG111
+description: A materialized view has no unique index, so it cannot refresh concurrently
+id: SQLPG111
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A materialized view has no unique index, so it cannot refresh concurrently

package/dist/okf/rules/SQLPG112.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: SQLPG112
+description: A secret- or PII-named column with no comment on it or its table
+id: SQLPG112
+severity: error
+category: post-synth
+lexicon: sql
+docs: https://intentius.io/chant/lexicons/sql/rules/
+---
+A secret- or PII-named column with no comment on it or its table