diff --git a/changelog.d/754.added.md b/changelog.d/754.added.md new file mode 100644 index 000000000..297d16b7f --- /dev/null +++ b/changelog.d/754.added.md @@ -0,0 +1 @@ +The Get started page of the documentation now holds the quickstart, and every generated reference page (SQL functions, Python, Rust, configuration, metrics, Spark Connect coverage) carries a description. diff --git a/crates/krishiv-cli/tests/check_compat.rs b/crates/krishiv-cli/tests/check_compat.rs index 8337843ff..6f3254c9a 100644 --- a/crates/krishiv-cli/tests/check_compat.rs +++ b/crates/krishiv-cli/tests/check_compat.rs @@ -451,7 +451,7 @@ fn an_unwritable_report_exits_2() { fn the_docs_examples_pass_check_compat() { let docs = repo_root().join("docs"); let scratch = tempfile::tempdir().expect("tempdir"); - for (i, page) in ["get-started/quickstart.md", "guides/pyspark-migration.md"] + for (i, page) in ["get-started/index.md", "guides/pyspark-migration.md"] .iter() .enumerate() { diff --git a/crates/krishiv-common/src/config/mod.rs b/crates/krishiv-common/src/config/mod.rs index ff6c8e3b4..f4a8b9fe6 100644 --- a/crates/krishiv-common/src/config/mod.rs +++ b/crates/krishiv-common/src/config/mod.rs @@ -647,7 +647,8 @@ pub fn docs_markdown() -> String { let mut entries: Vec<&ConfigEntry> = REGISTRY.to_vec(); entries.sort_by_key(|e| e.key); let mut out = String::from( - "# Krishiv configuration reference\n\n\ + "---\ndescription: \"Every krishiv.* configuration key, with its type, default, scope and Spark alias.\"\n---\n\n\ + # Krishiv configuration reference\n\n\ \n\n\ Keys under `krishiv.experimental.` are experimental and off by default. \ Spark aliases are accepted in place of the Krishiv key; other unknown \ diff --git a/crates/krishiv-common/src/config/tests.rs b/crates/krishiv-common/src/config/tests.rs index c677e202c..07c660809 100644 --- a/crates/krishiv-common/src/config/tests.rs +++ b/crates/krishiv-common/src/config/tests.rs @@ -613,7 +613,7 @@ fn registry_is_well_formed() { #[test] fn docs_markdown_lists_every_entry_deterministically() { let md = docs_markdown(); - assert!(md.starts_with("# Krishiv configuration reference\n")); + assert!(md.contains("\n# Krishiv configuration reference\n")); assert!(md.contains( "| Key | Type | Default | Scope | Settable by | Since | Spark alias | Description |" )); diff --git a/crates/krishiv-exec/src/metrics/registry.rs b/crates/krishiv-exec/src/metrics/registry.rs index 55aeb6bcf..3a35719a9 100644 --- a/crates/krishiv-exec/src/metrics/registry.rs +++ b/crates/krishiv-exec/src/metrics/registry.rs @@ -897,7 +897,8 @@ impl MetricsRegistry { #[must_use] pub fn catalogue_markdown() -> String { let mut out = String::from( - "# Krishiv engine metrics (v1)\n\n\ + "---\ndescription: \"Every engine metric: name, type, unit, labels and what it counts.\"\n---\n\n\ + # Krishiv engine metrics (v1)\n\n\ \n\n\ Engine metrics, scraped per engine (`Session::metrics`, `krishiv.metrics()`): \ OTel-style dotted names with the mechanical Prometheus rendering next to them \ diff --git a/docs/get-started/_meta.json b/docs/get-started/_meta.json index e2e96dcdb..315088871 100644 --- a/docs/get-started/_meta.json +++ b/docs/get-started/_meta.json @@ -1,4 +1,3 @@ { - "index": "Get started", - "quickstart": "Quickstart" + "index": "Get started" } diff --git a/docs/get-started/index.md b/docs/get-started/index.md index 06e1662a7..e60710efc 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -1,14 +1,77 @@ --- -description: "Install Krishiv, run your first query and decide where to go next." +description: "Install Krishiv, run your first SQL and DataFrame query, and decide where to go next." --- # Get started -This section is for someone who has not run Krishiv yet. The [Quickstart](quickstart.md) installs the Python package, -starts a session, runs a SQL query and a DataFrame query, and reads the result back as Arrow data. It takes a few -minutes and needs Python 3.11 or newer. +This section is for someone who has not run Krishiv yet. The steps below install the Python package, start a session, +run a SQL query and a DataFrame query, and read the result back as Arrow data. They take a few minutes. -Once it runs, pick the next step by what you came to do: + + +Install the package with pyarrow for the Arrow results: + +```bash +pip install "krishiv[pyarrow]" +``` + +Krishiv needs Python 3.11 or newer (the floor of the Spark 4.3 Python client); the examples run on 3.11 to 3.14. The `pyarrow` extra is needed for `collect()` and `toArrow()`, which return Arrow data. + +SQL and DataFrames: + +```python +import tempfile +from pathlib import Path + +import pyarrow as pa +import pyarrow.parquet as pq + +import krishiv +from krishiv.sql import functions as F + +spark = krishiv.session() # a PySpark-style SparkSession, in process + +# SQL. +spark.sql("SELECT 1 AS answer").show() + +# DataFrames over a Parquet file; the same file is also a temp view for SQL. +path = str(Path(tempfile.mkdtemp()) / "orders.parquet") +pq.write_table( + pa.table( + { + "region": ["east", "west", "east", "north", "west"], + "amount": [10.0, 20.0, 5.5, 7.25, 30.0], + } + ), + path, +) +orders = spark.read.parquet(path) +orders.createOrReplaceTempView("orders") + +by_region = ( + orders.filter(F.col("amount") > 6) + .groupBy("region") + .agg(F.sum("amount").alias("revenue")) + .orderBy("region") +) +by_region.show() +print(by_region.toArrow()) # a pyarrow.Table; also pa.table(by_region), polars.DataFrame(by_region) + +same = spark.sql("SELECT region, sum(amount) AS revenue FROM orders WHERE amount > 6 GROUP BY region ORDER BY region") +assert same.collect() == by_region.collect() +``` + +`EXPLAIN` and `EXPLAIN ANALYZE` (per-operator rows, time, peak memory and spill bytes): + +```python +by_region.explain() # the physical plan +by_region.explain(analyze=True) # runs the query and prints each operator's metrics + +plan = spark.sql("EXPLAIN ANALYZE SELECT region, sum(amount) FROM orders GROUP BY region").collect()[0][0] +assert plan.startswith("== Physical Plan (analyzed) ==") +``` + +## Next - Moving an existing Spark job: [migrate a PySpark job](../guides/pyspark-migration.md), and scan your code first with [check-compat](../guides/check-compat.md). diff --git a/docs/get-started/quickstart.md b/docs/get-started/quickstart.md deleted file mode 100644 index b0c563c1c..000000000 --- a/docs/get-started/quickstart.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -description: "Install the Python package and run your first SQL and DataFrame query." ---- - -# Quickstart - - - -Nothing is published to PyPI yet: build the wheel from the repository (`maturin build`) and install it with the same extras. Once released, install with pyarrow for the Arrow results: - -```bash -pip install "krishiv[pyarrow]" -``` - -Krishiv needs Python 3.11 or newer (the floor of the Spark 4.3 Python client); the examples run on 3.11 to 3.14. The `pyarrow` extra is needed for `collect()` and `toArrow()`, which return Arrow data. - -SQL and DataFrames: - -```python -import tempfile -from pathlib import Path - -import pyarrow as pa -import pyarrow.parquet as pq - -import krishiv -from krishiv.sql import functions as F - -spark = krishiv.session() # a PySpark-style SparkSession, in process - -# SQL. -spark.sql("SELECT 1 AS answer").show() - -# DataFrames over a Parquet file; the same file is also a temp view for SQL. -path = str(Path(tempfile.mkdtemp()) / "orders.parquet") -pq.write_table( - pa.table( - { - "region": ["east", "west", "east", "north", "west"], - "amount": [10.0, 20.0, 5.5, 7.25, 30.0], - } - ), - path, -) -orders = spark.read.parquet(path) -orders.createOrReplaceTempView("orders") - -by_region = ( - orders.filter(F.col("amount") > 6) - .groupBy("region") - .agg(F.sum("amount").alias("revenue")) - .orderBy("region") -) -by_region.show() -print(by_region.toArrow()) # a pyarrow.Table; also pa.table(by_region), polars.DataFrame(by_region) - -same = spark.sql("SELECT region, sum(amount) AS revenue FROM orders WHERE amount > 6 GROUP BY region ORDER BY region") -assert same.collect() == by_region.collect() -``` - -`EXPLAIN` and `EXPLAIN ANALYZE` (per-operator rows, time, peak memory and spill bytes): - -```python -by_region.explain() # the physical plan -by_region.explain(analyze=True) # runs the query and prints each operator's metrics - -plan = spark.sql("EXPLAIN ANALYZE SELECT region, sum(amount) FROM orders GROUP BY region").collect()[0][0] -assert plan.startswith("== Physical Plan (analyzed) ==") -``` - -## Next - -- [Notebooks and sample data](../guides/notebooks-and-datasets.md): three notebooks over generated order data. -- [Migrate a PySpark job](../guides/pyspark-migration.md): what differs from Spark and the workarounds. diff --git a/docs/guides/index.md b/docs/guides/index.md index b540c98cb..f59ddd7c2 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -4,7 +4,7 @@ description: "Task-by-task guides for migrating, checking, deploying and diagnos # Guides -Each guide solves one task and is written for someone who already ran the [Quickstart](../get-started/quickstart.md). +Each guide solves one task and is written for someone who already ran the [Quickstart](../get-started/index.md). Moving a Spark job? Start with [Migrate a PySpark job](pyspark-migration.md) and run [check-compat](check-compat.md) over your project first. Choosing where Krishiv runs: [Deployment](deploy.md) (embedded, single-node, distributed). To work with it interactively, see diff --git a/docs/index.md b/docs/index.md index 53d1ee0fa..d6406f6a5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,7 +14,7 @@ write. ## Install Nothing is on PyPI yet, so build the wheel from the repository (`maturin build` in `python/`) and install it. Once -released, `pip install "krishiv[pyarrow]"` is all it takes; the [Quickstart](get-started/quickstart.md) has the steps. +released, `pip install "krishiv[pyarrow]"` is all it takes; the [Quickstart](get-started/index.md) has the steps. ## Where to start diff --git a/docs/reference/config/index.md b/docs/reference/config/index.md index 646fe656b..1b571608b 100644 --- a/docs/reference/config/index.md +++ b/docs/reference/config/index.md @@ -1,3 +1,7 @@ +--- +description: "Every krishiv.* configuration key, with its type, default, scope and Spark alias." +--- + # Krishiv configuration reference diff --git a/docs/reference/connect/_meta.json b/docs/reference/connect/_meta.json new file mode 100644 index 000000000..ff6f67d51 --- /dev/null +++ b/docs/reference/connect/_meta.json @@ -0,0 +1,4 @@ +{ + "index": "Spark Connect", + "coverage": "Coverage" +} diff --git a/docs/reference/connect/coverage.md b/docs/reference/connect/coverage.md index f8e702aba..e6a6c5c9c 100644 --- a/docs/reference/connect/coverage.md +++ b/docs/reference/connect/coverage.md @@ -1,3 +1,7 @@ +--- +description: "Which Spark Connect relations, commands and expressions Krishiv supports, one row per protocol arm." +--- + # Spark Connect coverage diff --git a/docs/reference/connect/index.md b/docs/reference/connect/index.md new file mode 100644 index 000000000..92ff6534a --- /dev/null +++ b/docs/reference/connect/index.md @@ -0,0 +1,10 @@ +--- +description: "How much of the Spark Connect protocol Krishiv serves, arm by arm, for the vendored protocol version." +--- + +# Spark Connect + +Spark Connect lets a Spark client talk to an engine over gRPC. Krishiv serves a subset of the protocol today: the +[coverage page](coverage.md) lists every relation, command and expression the translator dispatches on and whether +Krishiv handles it, partly handles it, does not handle it yet or leaves it out of scope. A request that uses an arm +Krishiv does not handle fails with `CONNECT_INVALID_PLAN.INVALID_ONE_OF_FIELD_NOT_SUPPORTED`. diff --git a/docs/reference/metrics-v1.md b/docs/reference/metrics-v1.md index aafbeccc1..5fdebfdc2 100644 --- a/docs/reference/metrics-v1.md +++ b/docs/reference/metrics-v1.md @@ -1,3 +1,7 @@ +--- +description: "Every engine metric: name, type, unit, labels and what it counts." +--- + # Krishiv engine metrics (v1) diff --git a/docs/reference/python/index.md b/docs/reference/python/index.md index 03b671abf..94aafa240 100644 --- a/docs/reference/python/index.md +++ b/docs/reference/python/index.md @@ -1,3 +1,7 @@ +--- +description: "Every public module of the krishiv Python package: classes, functions and signatures." +--- + # Python API reference diff --git a/docs/reference/python/krishiv.errors.md b/docs/reference/python/krishiv.errors.md index 60081d722..326633b33 100644 --- a/docs/reference/python/krishiv.errors.md +++ b/docs/reference/python/krishiv.errors.md @@ -1,3 +1,7 @@ +--- +description: "Exceptions, shaped like `pyspark.errors` (Spark 4.2); no dependency on `pyspark`." +--- + # `krishiv.errors` diff --git a/docs/reference/python/krishiv.md b/docs/reference/python/krishiv.md index 8961a3f8c..c0d681fd0 100644 --- a/docs/reference/python/krishiv.md +++ b/docs/reference/python/krishiv.md @@ -1,3 +1,7 @@ +--- +description: "Krishiv: a Rust-native, Spark-compatible batch and streaming engine." +--- + # `krishiv` diff --git a/docs/reference/python/krishiv.sql.column.md b/docs/reference/python/krishiv.sql.column.md index c9756074b..83d03bf1b 100644 --- a/docs/reference/python/krishiv.sql.column.md +++ b/docs/reference/python/krishiv.sql.column.md @@ -1,3 +1,7 @@ +--- +description: "`Column`: a column expression, as `pyspark.sql.Column` (a thin wrapper on the native handle)." +--- + # `krishiv.sql.column` diff --git a/docs/reference/python/krishiv.sql.conf.md b/docs/reference/python/krishiv.sql.conf.md index b52c4f3c9..2a82e5c9d 100644 --- a/docs/reference/python/krishiv.sql.conf.md +++ b/docs/reference/python/krishiv.sql.conf.md @@ -1,3 +1,7 @@ +--- +description: "`RuntimeConfig`: `spark.conf`." +--- + # `krishiv.sql.conf` diff --git a/docs/reference/python/krishiv.sql.dataframe.md b/docs/reference/python/krishiv.sql.dataframe.md index 79706033f..f52fb9adc 100644 --- a/docs/reference/python/krishiv.sql.dataframe.md +++ b/docs/reference/python/krishiv.sql.dataframe.md @@ -1,3 +1,7 @@ +--- +description: "`DataFrame`: a lazily evaluated query, as `pyspark.sql.DataFrame`." +--- + # `krishiv.sql.dataframe` diff --git a/docs/reference/python/krishiv.sql.functions.md b/docs/reference/python/krishiv.sql.functions.md index d55e4b0c8..6e0241b5e 100644 --- a/docs/reference/python/krishiv.sql.functions.md +++ b/docs/reference/python/krishiv.sql.functions.md @@ -1,3 +1,7 @@ +--- +description: "`pyspark.sql.functions`: column builders. A function resolves by name in the engine's" +--- + # `krishiv.sql.functions` diff --git a/docs/reference/python/krishiv.sql.group.md b/docs/reference/python/krishiv.sql.group.md index ec14611e0..785182126 100644 --- a/docs/reference/python/krishiv.sql.group.md +++ b/docs/reference/python/krishiv.sql.group.md @@ -1,3 +1,7 @@ +--- +description: "`GroupedData`: a DataFrame grouped by key columns, as `pyspark.sql.GroupedData`." +--- + # `krishiv.sql.group` diff --git a/docs/reference/python/krishiv.sql.md b/docs/reference/python/krishiv.sql.md index b406adaa6..746bb35eb 100644 --- a/docs/reference/python/krishiv.sql.md +++ b/docs/reference/python/krishiv.sql.md @@ -1,3 +1,7 @@ +--- +description: "The PySpark-shaped API: `from krishiv.sql import functions as F`." +--- + # `krishiv.sql` diff --git a/docs/reference/python/krishiv.sql.na.md b/docs/reference/python/krishiv.sql.na.md index 7a6c27cc9..293a768d2 100644 --- a/docs/reference/python/krishiv.sql.na.md +++ b/docs/reference/python/krishiv.sql.na.md @@ -1,3 +1,7 @@ +--- +description: "`DataFrameNaFunctions` (`DataFrame.na`): handling of missing data, as `pyspark.sql.DataFrameNaFunctions`." +--- + # `krishiv.sql.na` diff --git a/docs/reference/python/krishiv.sql.pandas.functions.md b/docs/reference/python/krishiv.sql.pandas.functions.md index 133c1d220..f24e5c3dc 100644 --- a/docs/reference/python/krishiv.sql.pandas.functions.md +++ b/docs/reference/python/krishiv.sql.pandas.functions.md @@ -1,3 +1,7 @@ +--- +description: "`pyspark.sql.pandas.functions`: `pandas_udf` and `arrow_udf`." +--- + # `krishiv.sql.pandas.functions` diff --git a/docs/reference/python/krishiv.sql.pandas.md b/docs/reference/python/krishiv.sql.pandas.md index a37ec5899..003ed1b78 100644 --- a/docs/reference/python/krishiv.sql.pandas.md +++ b/docs/reference/python/krishiv.sql.pandas.md @@ -1,3 +1,7 @@ +--- +description: "`pyspark.sql.pandas`: the pandas and Arrow vectorized UDFs (`krishiv.sql.pandas.functions`)." +--- + # `krishiv.sql.pandas` diff --git a/docs/reference/python/krishiv.sql.profile_view.md b/docs/reference/python/krishiv.sql.profile_view.md index ce61b42d9..ed1f342a7 100644 --- a/docs/reference/python/krishiv.sql.profile_view.md +++ b/docs/reference/python/krishiv.sql.profile_view.md @@ -1,3 +1,7 @@ +--- +description: "An offline viewer for `krishiv.query-profile` documents." +--- + # `krishiv.sql.profile_view` diff --git a/docs/reference/python/krishiv.sql.readwriter.md b/docs/reference/python/krishiv.sql.readwriter.md index 4b991c1ff..00b586f2b 100644 --- a/docs/reference/python/krishiv.sql.readwriter.md +++ b/docs/reference/python/krishiv.sql.readwriter.md @@ -1,3 +1,7 @@ +--- +description: "`DataFrameReader` (`spark.read`), `DataFrameWriter` (`df.write`)" +--- + # `krishiv.sql.readwriter` diff --git a/docs/reference/python/krishiv.sql.row.md b/docs/reference/python/krishiv.sql.row.md index fdad8990c..f733ba28f 100644 --- a/docs/reference/python/krishiv.sql.row.md +++ b/docs/reference/python/krishiv.sql.row.md @@ -1,3 +1,7 @@ +--- +description: "`Row`: a result row, as `pyspark.sql.Row` (a tuple with field names)." +--- + # `krishiv.sql.row` diff --git a/docs/reference/python/krishiv.sql.session.md b/docs/reference/python/krishiv.sql.session.md index 151183d22..7788fe96e 100644 --- a/docs/reference/python/krishiv.sql.session.md +++ b/docs/reference/python/krishiv.sql.session.md @@ -1,3 +1,7 @@ +--- +description: "`SparkSession`: the entry point, as `pyspark.sql.SparkSession` (embedded: no server)." +--- + # `krishiv.sql.session` diff --git a/docs/reference/python/krishiv.sql.stat.md b/docs/reference/python/krishiv.sql.stat.md index a190aabae..10d0d85b8 100644 --- a/docs/reference/python/krishiv.sql.stat.md +++ b/docs/reference/python/krishiv.sql.stat.md @@ -1,3 +1,7 @@ +--- +description: "`DataFrameStatFunctions` (`DataFrame.stat`), as `pyspark.sql.DataFrameStatFunctions`." +--- + # `krishiv.sql.stat` diff --git a/docs/reference/python/krishiv.sql.types.md b/docs/reference/python/krishiv.sql.types.md index 654614031..401907fcf 100644 --- a/docs/reference/python/krishiv.sql.types.md +++ b/docs/reference/python/krishiv.sql.types.md @@ -1,3 +1,7 @@ +--- +description: "Spark data types, as `pyspark.sql.types`." +--- + # `krishiv.sql.types` diff --git a/docs/reference/python/krishiv.sql.udf.md b/docs/reference/python/krishiv.sql.udf.md index 8d1a0dc7f..7be3f8c8d 100644 --- a/docs/reference/python/krishiv.sql.udf.md +++ b/docs/reference/python/krishiv.sql.udf.md @@ -1,3 +1,7 @@ +--- +description: "`pyspark.sql.udf`: `UserDefinedFunction` and `UDFRegistration`." +--- + # `krishiv.sql.udf` diff --git a/docs/reference/python/krishiv.sql.variant.md b/docs/reference/python/krishiv.sql.variant.md index 46e898718..c79590271 100644 --- a/docs/reference/python/krishiv.sql.variant.md +++ b/docs/reference/python/krishiv.sql.variant.md @@ -1,3 +1,7 @@ +--- +description: "`VariantVal`: a `VARIANT` value as PySpark hands it out (`pyspark.sql.types.VariantVal`)." +--- + # `krishiv.sql.variant` diff --git a/docs/reference/python/krishiv.sql.window.md b/docs/reference/python/krishiv.sql.window.md index ab6bdefe3..34bdbc74c 100644 --- a/docs/reference/python/krishiv.sql.window.md +++ b/docs/reference/python/krishiv.sql.window.md @@ -1,3 +1,7 @@ +--- +description: "`pyspark.sql.Window` and `pyspark.sql.WindowSpec`: windows for `Column.over`." +--- + # `krishiv.sql.window` diff --git a/docs/reference/python/krishiv.storagelevel.md b/docs/reference/python/krishiv.storagelevel.md index 59c05e379..9c985a680 100644 --- a/docs/reference/python/krishiv.storagelevel.md +++ b/docs/reference/python/krishiv.storagelevel.md @@ -1,3 +1,7 @@ +--- +description: "Storage levels for `krishiv.sql.DataFrame.persist`, as `pyspark.StorageLevel`." +--- + # `krishiv.storagelevel` diff --git a/docs/reference/python/krishiv.testing.md b/docs/reference/python/krishiv.testing.md index 93c56ee34..256dd1248 100644 --- a/docs/reference/python/krishiv.testing.md +++ b/docs/reference/python/krishiv.testing.md @@ -1,3 +1,7 @@ +--- +description: "Test helpers, as `pyspark.testing`: `assertDataFrameEqual` and `assertSchemaEqual`." +--- + # `krishiv.testing` diff --git a/docs/reference/python/krishiv.testing.pytest_plugin.md b/docs/reference/python/krishiv.testing.pytest_plugin.md index e162ab392..2963bea9d 100644 --- a/docs/reference/python/krishiv.testing.pytest_plugin.md +++ b/docs/reference/python/krishiv.testing.pytest_plugin.md @@ -1,3 +1,7 @@ +--- +description: "A pytest fixture for tests that run Spark code on Krishiv: `krishiv_session`." +--- + # `krishiv.testing.pytest_plugin` diff --git a/docs/reference/python/krishiv.testing.utils.md b/docs/reference/python/krishiv.testing.utils.md index c8bc0932e..8e5104016 100644 --- a/docs/reference/python/krishiv.testing.utils.md +++ b/docs/reference/python/krishiv.testing.utils.md @@ -1,3 +1,7 @@ +--- +description: "Equality assertions for tests, as `pyspark.testing.utils`." +--- + # `krishiv.testing.utils` diff --git a/docs/reference/rust/index.md b/docs/reference/rust/index.md index caf60c95a..122812a74 100644 --- a/docs/reference/rust/index.md +++ b/docs/reference/rust/index.md @@ -1,3 +1,7 @@ +--- +description: "The public Rust API of the crates users build against, one page per crate." +--- + # Rust API reference diff --git a/docs/reference/rust/krishiv-session.md b/docs/reference/rust/krishiv-session.md index 50fc3c757..f3606c24c 100644 --- a/docs/reference/rust/krishiv-session.md +++ b/docs/reference/rust/krishiv-session.md @@ -1,3 +1,7 @@ +--- +description: "Krishiv sessions: Spark SQL and DataFrames over the engine." +--- + **Version:** 0.2.0 # Module `krishiv_session` diff --git a/docs/reference/rust/krishiv-types.md b/docs/reference/rust/krishiv-types.md index b3e89b9bd..d06c2be85 100644 --- a/docs/reference/rust/krishiv-types.md +++ b/docs/reference/rust/krishiv-types.md @@ -1,3 +1,7 @@ +--- +description: "Internal type representations." +--- + **Version:** 0.2.0 # Module `krishiv_types` diff --git a/docs/reference/rust/krishiv-udf-sdk.md b/docs/reference/rust/krishiv-udf-sdk.md index bb9ba288f..a6567ca1c 100644 --- a/docs/reference/rust/krishiv-udf-sdk.md +++ b/docs/reference/rust/krishiv-udf-sdk.md @@ -1,3 +1,7 @@ +--- +description: "Native Rust scalar and aggregate UDFs (layer SDK)." +--- + **Version:** 0.2.0 # Module `krishiv_udf_sdk` diff --git a/docs/reference/rust/krishiv.md b/docs/reference/rust/krishiv.md index 7516a8d71..176b16f4a 100644 --- a/docs/reference/rust/krishiv.md +++ b/docs/reference/rust/krishiv.md @@ -1,3 +1,7 @@ +--- +description: "Krishiv: a Spark-compatible query engine, embedded." +--- + **Version:** 0.2.0 # Module `krishiv` diff --git a/docs/reference/sql/functions/abs.md b/docs/reference/sql/functions/abs.md index 364499ed9..ab24fd5e0 100644 --- a/docs/reference/sql/functions/abs.md +++ b/docs/reference/sql/functions/abs.md @@ -1,3 +1,7 @@ +--- +description: "Returns the absolute value of the numeric or interval value." +--- + # `abs` diff --git a/docs/reference/sql/functions/acos.md b/docs/reference/sql/functions/acos.md index 03a741022..6c87f591d 100644 --- a/docs/reference/sql/functions/acos.md +++ b/docs/reference/sql/functions/acos.md @@ -1,3 +1,7 @@ +--- +description: "Returns the inverse cosine (a.k.a." +--- + # `acos` diff --git a/docs/reference/sql/functions/acosh.md b/docs/reference/sql/functions/acosh.md index 3b172851b..316b9e1fb 100644 --- a/docs/reference/sql/functions/acosh.md +++ b/docs/reference/sql/functions/acosh.md @@ -1,3 +1,7 @@ +--- +description: "Returns inverse hyperbolic cosine of `expr`." +--- + # `acosh` diff --git a/docs/reference/sql/functions/add_months.md b/docs/reference/sql/functions/add_months.md index cf5d161a5..e6821faa1 100644 --- a/docs/reference/sql/functions/add_months.md +++ b/docs/reference/sql/functions/add_months.md @@ -1,3 +1,7 @@ +--- +description: "Returns the date that is `num_months` after `start_date`." +--- + # `add_months` diff --git a/docs/reference/sql/functions/aes_decrypt.md b/docs/reference/sql/functions/aes_decrypt.md index 6163d0d01..5f48983e9 100644 --- a/docs/reference/sql/functions/aes_decrypt.md +++ b/docs/reference/sql/functions/aes_decrypt.md @@ -1,3 +1,7 @@ +--- +description: "Returns a decrypted value of `expr` using AES in `mode` with `padding`." +--- + # `aes_decrypt` diff --git a/docs/reference/sql/functions/aes_encrypt.md b/docs/reference/sql/functions/aes_encrypt.md index 143c664c3..5d2231d18 100644 --- a/docs/reference/sql/functions/aes_encrypt.md +++ b/docs/reference/sql/functions/aes_encrypt.md @@ -1,3 +1,7 @@ +--- +description: "Returns an encrypted value of `expr` using AES in given `mode` with the specified `padding`." +--- + # `aes_encrypt` diff --git a/docs/reference/sql/functions/aggregate.md b/docs/reference/sql/functions/aggregate.md index 3555aa351..7034c560c 100644 --- a/docs/reference/sql/functions/aggregate.md +++ b/docs/reference/sql/functions/aggregate.md @@ -1,3 +1,7 @@ +--- +description: "Applies a binary operator to an initial state and all elements in the array, and reduces this to a single state." +--- + # `aggregate` diff --git a/docs/reference/sql/functions/and.md b/docs/reference/sql/functions/and.md index 6eca94a54..f622e8757 100644 --- a/docs/reference/sql/functions/and.md +++ b/docs/reference/sql/functions/and.md @@ -1,3 +1,7 @@ +--- +description: "Logical AND." +--- + # `and` diff --git a/docs/reference/sql/functions/any.md b/docs/reference/sql/functions/any.md index 02289d66b..d84675c39 100644 --- a/docs/reference/sql/functions/any.md +++ b/docs/reference/sql/functions/any.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if at least one value of `expr` is true." +--- + # `any` diff --git a/docs/reference/sql/functions/any_value.md b/docs/reference/sql/functions/any_value.md index 0b39c0bcb..968eb1bd0 100644 --- a/docs/reference/sql/functions/any_value.md +++ b/docs/reference/sql/functions/any_value.md @@ -1,3 +1,7 @@ +--- +description: "Returns some value of `expr` for a group of rows." +--- + # `any_value` diff --git a/docs/reference/sql/functions/approx_count_distinct.md b/docs/reference/sql/functions/approx_count_distinct.md index 60bedac86..cfb53df09 100644 --- a/docs/reference/sql/functions/approx_count_distinct.md +++ b/docs/reference/sql/functions/approx_count_distinct.md @@ -1,3 +1,7 @@ +--- +description: "Returns the estimated cardinality by HyperLogLog++." +--- + # `approx_count_distinct` diff --git a/docs/reference/sql/functions/approx_percentile.md b/docs/reference/sql/functions/approx_percentile.md index 5f4f7c222..327f30f2d 100644 --- a/docs/reference/sql/functions/approx_percentile.md +++ b/docs/reference/sql/functions/approx_percentile.md @@ -1,3 +1,7 @@ +--- +description: "Returns the approximate `percentile` of the numeric or ansi interval column `col` which is the smallest value in the ordered `col` values (sorted from least to greatest) such that no more than `percentage` of `col` values is less than the value or equal to that value." +--- + # `approx_percentile` diff --git a/docs/reference/sql/functions/approx_top_k.md b/docs/reference/sql/functions/approx_top_k.md index 24b9c6aef..eb99467d8 100644 --- a/docs/reference/sql/functions/approx_top_k.md +++ b/docs/reference/sql/functions/approx_top_k.md @@ -1,3 +1,7 @@ +--- +description: "Returns top k items with their frequency." +--- + # `approx_top_k` diff --git a/docs/reference/sql/functions/approx_top_k_accumulate.md b/docs/reference/sql/functions/approx_top_k_accumulate.md index fb0750312..67e029528 100644 --- a/docs/reference/sql/functions/approx_top_k_accumulate.md +++ b/docs/reference/sql/functions/approx_top_k_accumulate.md @@ -1,3 +1,7 @@ +--- +description: "Accumulates items into a sketch." +--- + # `approx_top_k_accumulate` diff --git a/docs/reference/sql/functions/approx_top_k_combine.md b/docs/reference/sql/functions/approx_top_k_combine.md index 32f6f91de..767e9bd9f 100644 --- a/docs/reference/sql/functions/approx_top_k_combine.md +++ b/docs/reference/sql/functions/approx_top_k_combine.md @@ -1,3 +1,7 @@ +--- +description: "Combines multiple sketches into a single sketch." +--- + # `approx_top_k_combine` diff --git a/docs/reference/sql/functions/approx_top_k_estimate.md b/docs/reference/sql/functions/approx_top_k_estimate.md index 4da0824af..3e204e68c 100644 --- a/docs/reference/sql/functions/approx_top_k_estimate.md +++ b/docs/reference/sql/functions/approx_top_k_estimate.md @@ -1,3 +1,7 @@ +--- +description: "Returns top k items with their frequency." +--- + # `approx_top_k_estimate` diff --git a/docs/reference/sql/functions/array.md b/docs/reference/sql/functions/array.md index ebb6307a7..91e76385d 100644 --- a/docs/reference/sql/functions/array.md +++ b/docs/reference/sql/functions/array.md @@ -1,3 +1,7 @@ +--- +description: "Returns an array with the given elements." +--- + # `array` diff --git a/docs/reference/sql/functions/array_agg.md b/docs/reference/sql/functions/array_agg.md index e84fcd09c..bf1770657 100644 --- a/docs/reference/sql/functions/array_agg.md +++ b/docs/reference/sql/functions/array_agg.md @@ -1,3 +1,7 @@ +--- +description: "Collects and returns a list of non-unique elements." +--- + # `array_agg` diff --git a/docs/reference/sql/functions/array_append.md b/docs/reference/sql/functions/array_append.md index 0a0adb231..90471608d 100644 --- a/docs/reference/sql/functions/array_append.md +++ b/docs/reference/sql/functions/array_append.md @@ -1,3 +1,7 @@ +--- +description: "Add the element at the end of the array passed as first argument." +--- + # `array_append` diff --git a/docs/reference/sql/functions/array_compact.md b/docs/reference/sql/functions/array_compact.md index abf0799f6..42cc57bf5 100644 --- a/docs/reference/sql/functions/array_compact.md +++ b/docs/reference/sql/functions/array_compact.md @@ -1,3 +1,7 @@ +--- +description: "Removes null values from the array." +--- + # `array_compact` diff --git a/docs/reference/sql/functions/array_contains.md b/docs/reference/sql/functions/array_contains.md index 126190838..b02824161 100644 --- a/docs/reference/sql/functions/array_contains.md +++ b/docs/reference/sql/functions/array_contains.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if the array contains the value." +--- + # `array_contains` diff --git a/docs/reference/sql/functions/array_distinct.md b/docs/reference/sql/functions/array_distinct.md index 9943ea10c..34acf9006 100644 --- a/docs/reference/sql/functions/array_distinct.md +++ b/docs/reference/sql/functions/array_distinct.md @@ -1,3 +1,7 @@ +--- +description: "Removes duplicate values from the array." +--- + # `array_distinct` diff --git a/docs/reference/sql/functions/array_except.md b/docs/reference/sql/functions/array_except.md index e9296d6d2..1aba6dd8c 100644 --- a/docs/reference/sql/functions/array_except.md +++ b/docs/reference/sql/functions/array_except.md @@ -1,3 +1,7 @@ +--- +description: "Returns an array of the elements in array1 but not in array2, without duplicates." +--- + # `array_except` diff --git a/docs/reference/sql/functions/array_insert.md b/docs/reference/sql/functions/array_insert.md index d1d3facce..4fa1fbea8 100644 --- a/docs/reference/sql/functions/array_insert.md +++ b/docs/reference/sql/functions/array_insert.md @@ -1,3 +1,7 @@ +--- +description: "Places val into index pos of array x." +--- + # `array_insert` diff --git a/docs/reference/sql/functions/array_intersect.md b/docs/reference/sql/functions/array_intersect.md index 226e1ef3a..92b35045f 100644 --- a/docs/reference/sql/functions/array_intersect.md +++ b/docs/reference/sql/functions/array_intersect.md @@ -1,3 +1,7 @@ +--- +description: "Returns an array of the elements in the intersection of array1 and array2, without duplicates." +--- + # `array_intersect` diff --git a/docs/reference/sql/functions/array_join.md b/docs/reference/sql/functions/array_join.md index 96cf498a1..618bd9937 100644 --- a/docs/reference/sql/functions/array_join.md +++ b/docs/reference/sql/functions/array_join.md @@ -1,3 +1,7 @@ +--- +description: "Concatenates the elements of the given array using the delimiter and an optional string to replace nulls." +--- + # `array_join` diff --git a/docs/reference/sql/functions/array_max.md b/docs/reference/sql/functions/array_max.md index 5e4e6e4bb..df54d107f 100644 --- a/docs/reference/sql/functions/array_max.md +++ b/docs/reference/sql/functions/array_max.md @@ -1,3 +1,7 @@ +--- +description: "Returns the maximum value in the array." +--- + # `array_max` diff --git a/docs/reference/sql/functions/array_min.md b/docs/reference/sql/functions/array_min.md index 9702e9725..aaa64d93c 100644 --- a/docs/reference/sql/functions/array_min.md +++ b/docs/reference/sql/functions/array_min.md @@ -1,3 +1,7 @@ +--- +description: "Returns the minimum value in the array." +--- + # `array_min` diff --git a/docs/reference/sql/functions/array_position.md b/docs/reference/sql/functions/array_position.md index 00f9ddfaa..0016e899d 100644 --- a/docs/reference/sql/functions/array_position.md +++ b/docs/reference/sql/functions/array_position.md @@ -1,3 +1,7 @@ +--- +description: "Returns the (1-based) index of the first matching element of the array as long, or 0 if no match is found." +--- + # `array_position` diff --git a/docs/reference/sql/functions/array_prepend.md b/docs/reference/sql/functions/array_prepend.md index a2ab40187..ea453d605 100644 --- a/docs/reference/sql/functions/array_prepend.md +++ b/docs/reference/sql/functions/array_prepend.md @@ -1,3 +1,7 @@ +--- +description: "Add the element at the beginning of the array passed as first argument." +--- + # `array_prepend` diff --git a/docs/reference/sql/functions/array_remove.md b/docs/reference/sql/functions/array_remove.md index 654efe30b..ea2183824 100644 --- a/docs/reference/sql/functions/array_remove.md +++ b/docs/reference/sql/functions/array_remove.md @@ -1,3 +1,7 @@ +--- +description: "Remove all elements that equal to element from array." +--- + # `array_remove` diff --git a/docs/reference/sql/functions/array_repeat.md b/docs/reference/sql/functions/array_repeat.md index 9b56c05af..9c3309411 100644 --- a/docs/reference/sql/functions/array_repeat.md +++ b/docs/reference/sql/functions/array_repeat.md @@ -1,3 +1,7 @@ +--- +description: "Returns the array containing element count times." +--- + # `array_repeat` diff --git a/docs/reference/sql/functions/array_size.md b/docs/reference/sql/functions/array_size.md index 13dbea752..891cc89c8 100644 --- a/docs/reference/sql/functions/array_size.md +++ b/docs/reference/sql/functions/array_size.md @@ -1,3 +1,7 @@ +--- +description: "Returns the size of an array." +--- + # `array_size` diff --git a/docs/reference/sql/functions/array_sort.md b/docs/reference/sql/functions/array_sort.md index 29385c697..102ccdd07 100644 --- a/docs/reference/sql/functions/array_sort.md +++ b/docs/reference/sql/functions/array_sort.md @@ -1,3 +1,7 @@ +--- +description: "Sorts the input array." +--- + # `array_sort` diff --git a/docs/reference/sql/functions/array_union.md b/docs/reference/sql/functions/array_union.md index 520fce69b..e90db5d8d 100644 --- a/docs/reference/sql/functions/array_union.md +++ b/docs/reference/sql/functions/array_union.md @@ -1,3 +1,7 @@ +--- +description: "Returns an array of the elements in the union of array1 and array2, without duplicates." +--- + # `array_union` diff --git a/docs/reference/sql/functions/arrays_overlap.md b/docs/reference/sql/functions/arrays_overlap.md index f043b3046..d51878f3a 100644 --- a/docs/reference/sql/functions/arrays_overlap.md +++ b/docs/reference/sql/functions/arrays_overlap.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if a1 contains at least a non-null element present also in a2." +--- + # `arrays_overlap` diff --git a/docs/reference/sql/functions/arrays_zip.md b/docs/reference/sql/functions/arrays_zip.md index 7cbed3230..383697b07 100644 --- a/docs/reference/sql/functions/arrays_zip.md +++ b/docs/reference/sql/functions/arrays_zip.md @@ -1,3 +1,7 @@ +--- +description: "Returns a merged array of structs in which the N-th struct contains all N-th values of input arrays." +--- + # `arrays_zip` diff --git a/docs/reference/sql/functions/ascii.md b/docs/reference/sql/functions/ascii.md index 11d4da1ba..ee79c1638 100644 --- a/docs/reference/sql/functions/ascii.md +++ b/docs/reference/sql/functions/ascii.md @@ -1,3 +1,7 @@ +--- +description: "Returns the numeric value of the first character of `str`." +--- + # `ascii` diff --git a/docs/reference/sql/functions/asin.md b/docs/reference/sql/functions/asin.md index ad2c386be..a5681a65c 100644 --- a/docs/reference/sql/functions/asin.md +++ b/docs/reference/sql/functions/asin.md @@ -1,3 +1,7 @@ +--- +description: "Returns the inverse sine (a.k.a." +--- + # `asin` diff --git a/docs/reference/sql/functions/asinh.md b/docs/reference/sql/functions/asinh.md index 57aadef2b..f49df68ce 100644 --- a/docs/reference/sql/functions/asinh.md +++ b/docs/reference/sql/functions/asinh.md @@ -1,3 +1,7 @@ +--- +description: "Returns inverse hyperbolic sine of `expr`." +--- + # `asinh` diff --git a/docs/reference/sql/functions/assert_true.md b/docs/reference/sql/functions/assert_true.md index c4a1c23dc..985241f48 100644 --- a/docs/reference/sql/functions/assert_true.md +++ b/docs/reference/sql/functions/assert_true.md @@ -1,3 +1,7 @@ +--- +description: "Throws an exception if `expr` is not true." +--- + # `assert_true` diff --git a/docs/reference/sql/functions/atan.md b/docs/reference/sql/functions/atan.md index 8a528f12f..4c71f7fde 100644 --- a/docs/reference/sql/functions/atan.md +++ b/docs/reference/sql/functions/atan.md @@ -1,3 +1,7 @@ +--- +description: "Returns the inverse tangent (a.k.a." +--- + # `atan` diff --git a/docs/reference/sql/functions/atan2.md b/docs/reference/sql/functions/atan2.md index 59dbddf62..a4e253ff0 100644 --- a/docs/reference/sql/functions/atan2.md +++ b/docs/reference/sql/functions/atan2.md @@ -1,3 +1,7 @@ +--- +description: "Returns the angle in radians between the positive x-axis of a plane and the point given by the coordinates (`exprX`, `exprY`), as if computed by `java.lang.Math.atan2`." +--- + # `atan2` diff --git a/docs/reference/sql/functions/atanh.md b/docs/reference/sql/functions/atanh.md index 7842a96ae..e54301870 100644 --- a/docs/reference/sql/functions/atanh.md +++ b/docs/reference/sql/functions/atanh.md @@ -1,3 +1,7 @@ +--- +description: "Returns inverse hyperbolic tangent of `expr`." +--- + # `atanh` diff --git a/docs/reference/sql/functions/avg.md b/docs/reference/sql/functions/avg.md index f7902c887..624212c59 100644 --- a/docs/reference/sql/functions/avg.md +++ b/docs/reference/sql/functions/avg.md @@ -1,3 +1,7 @@ +--- +description: "Returns the mean calculated from values of a group." +--- + # `avg` diff --git a/docs/reference/sql/functions/base64.md b/docs/reference/sql/functions/base64.md index 53cb79e2a..5e77fd451 100644 --- a/docs/reference/sql/functions/base64.md +++ b/docs/reference/sql/functions/base64.md @@ -1,3 +1,7 @@ +--- +description: "Converts the argument from a binary `bin` to a base 64 string." +--- + # `base64` diff --git a/docs/reference/sql/functions/between.md b/docs/reference/sql/functions/between.md index c53bbec5f..aa8a0c02f 100644 --- a/docs/reference/sql/functions/between.md +++ b/docs/reference/sql/functions/between.md @@ -1,3 +1,7 @@ +--- +description: "evaluate if `input` is [not] in between `lower` and `upper`" +--- + # `between` diff --git a/docs/reference/sql/functions/bigint.md b/docs/reference/sql/functions/bigint.md index 3d3d7e7b9..1858c8690 100644 --- a/docs/reference/sql/functions/bigint.md +++ b/docs/reference/sql/functions/bigint.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `bigint`." +--- + # `bigint` diff --git a/docs/reference/sql/functions/bin.md b/docs/reference/sql/functions/bin.md index 050e8706f..495e97224 100644 --- a/docs/reference/sql/functions/bin.md +++ b/docs/reference/sql/functions/bin.md @@ -1,3 +1,7 @@ +--- +description: "Returns the string representation of the long value `expr` represented in binary." +--- + # `bin` diff --git a/docs/reference/sql/functions/binary.md b/docs/reference/sql/functions/binary.md index eaf3013c8..2de3f2e36 100644 --- a/docs/reference/sql/functions/binary.md +++ b/docs/reference/sql/functions/binary.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `binary`." +--- + # `binary` diff --git a/docs/reference/sql/functions/bit_and.md b/docs/reference/sql/functions/bit_and.md index 716c789b4..f59545a12 100644 --- a/docs/reference/sql/functions/bit_and.md +++ b/docs/reference/sql/functions/bit_and.md @@ -1,3 +1,7 @@ +--- +description: "Returns the bitwise AND of all non-null input values, or null if none." +--- + # `bit_and` diff --git a/docs/reference/sql/functions/bit_count.md b/docs/reference/sql/functions/bit_count.md index cfe557823..13469abc6 100644 --- a/docs/reference/sql/functions/bit_count.md +++ b/docs/reference/sql/functions/bit_count.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of bits that are set in the argument expr as an unsigned 64-bit integer, or NULL if the argument is NULL." +--- + # `bit_count` diff --git a/docs/reference/sql/functions/bit_get.md b/docs/reference/sql/functions/bit_get.md index 3a3b9ff6c..40deb488c 100644 --- a/docs/reference/sql/functions/bit_get.md +++ b/docs/reference/sql/functions/bit_get.md @@ -1,3 +1,7 @@ +--- +description: "Returns the value of the bit (0 or 1) at the specified position." +--- + # `bit_get` diff --git a/docs/reference/sql/functions/bit_length.md b/docs/reference/sql/functions/bit_length.md index cd14ff4e8..787c38b33 100644 --- a/docs/reference/sql/functions/bit_length.md +++ b/docs/reference/sql/functions/bit_length.md @@ -1,3 +1,7 @@ +--- +description: "Returns the bit length of string data or number of bits of binary data." +--- + # `bit_length` diff --git a/docs/reference/sql/functions/bit_or.md b/docs/reference/sql/functions/bit_or.md index 097934b16..1c1246ae2 100644 --- a/docs/reference/sql/functions/bit_or.md +++ b/docs/reference/sql/functions/bit_or.md @@ -1,3 +1,7 @@ +--- +description: "Returns the bitwise OR of all non-null input values, or null if none." +--- + # `bit_or` diff --git a/docs/reference/sql/functions/bit_xor.md b/docs/reference/sql/functions/bit_xor.md index 6845ae6b7..c84b1b31b 100644 --- a/docs/reference/sql/functions/bit_xor.md +++ b/docs/reference/sql/functions/bit_xor.md @@ -1,3 +1,7 @@ +--- +description: "Returns the bitwise XOR of all non-null input values, or null if none." +--- + # `bit_xor` diff --git a/docs/reference/sql/functions/bitmap_and_agg.md b/docs/reference/sql/functions/bitmap_and_agg.md index f806bbc40..1e84fa261 100644 --- a/docs/reference/sql/functions/bitmap_and_agg.md +++ b/docs/reference/sql/functions/bitmap_and_agg.md @@ -1,3 +1,7 @@ +--- +description: "Returns a bitmap that is the bitwise AND of all of the bitmaps from the child expression." +--- + # `bitmap_and_agg` diff --git a/docs/reference/sql/functions/bitmap_bit_position.md b/docs/reference/sql/functions/bitmap_bit_position.md index 52df9f92e..fa9f7cd7f 100644 --- a/docs/reference/sql/functions/bitmap_bit_position.md +++ b/docs/reference/sql/functions/bitmap_bit_position.md @@ -1,3 +1,7 @@ +--- +description: "Returns the bit position for the given input child expression." +--- + # `bitmap_bit_position` diff --git a/docs/reference/sql/functions/bitmap_bucket_number.md b/docs/reference/sql/functions/bitmap_bucket_number.md index 6326fda95..0fc9f181b 100644 --- a/docs/reference/sql/functions/bitmap_bucket_number.md +++ b/docs/reference/sql/functions/bitmap_bucket_number.md @@ -1,3 +1,7 @@ +--- +description: "Returns the bucket number for the given input child expression." +--- + # `bitmap_bucket_number` diff --git a/docs/reference/sql/functions/bitmap_construct_agg.md b/docs/reference/sql/functions/bitmap_construct_agg.md index c57b9b3c6..6909d473d 100644 --- a/docs/reference/sql/functions/bitmap_construct_agg.md +++ b/docs/reference/sql/functions/bitmap_construct_agg.md @@ -1,3 +1,7 @@ +--- +description: "Returns a bitmap with the positions of the bits set from all the values from the child expression." +--- + # `bitmap_construct_agg` diff --git a/docs/reference/sql/functions/bitmap_count.md b/docs/reference/sql/functions/bitmap_count.md index 0c0936081..88f54179b 100644 --- a/docs/reference/sql/functions/bitmap_count.md +++ b/docs/reference/sql/functions/bitmap_count.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of set bits in the child bitmap." +--- + # `bitmap_count` diff --git a/docs/reference/sql/functions/bitmap_or_agg.md b/docs/reference/sql/functions/bitmap_or_agg.md index fbc90978f..46127ede2 100644 --- a/docs/reference/sql/functions/bitmap_or_agg.md +++ b/docs/reference/sql/functions/bitmap_or_agg.md @@ -1,3 +1,7 @@ +--- +description: "Returns a bitmap that is the bitwise OR of all of the bitmaps from the child expression." +--- + # `bitmap_or_agg` diff --git a/docs/reference/sql/functions/bool_and.md b/docs/reference/sql/functions/bool_and.md index d8c6410ca..8af90ecd4 100644 --- a/docs/reference/sql/functions/bool_and.md +++ b/docs/reference/sql/functions/bool_and.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if all values of `expr` are true." +--- + # `bool_and` diff --git a/docs/reference/sql/functions/bool_or.md b/docs/reference/sql/functions/bool_or.md index 91ebca931..03ff1950f 100644 --- a/docs/reference/sql/functions/bool_or.md +++ b/docs/reference/sql/functions/bool_or.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if at least one value of `expr` is true." +--- + # `bool_or` diff --git a/docs/reference/sql/functions/boolean.md b/docs/reference/sql/functions/boolean.md index a062c0ab3..0bef145bd 100644 --- a/docs/reference/sql/functions/boolean.md +++ b/docs/reference/sql/functions/boolean.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `boolean`." +--- + # `boolean` diff --git a/docs/reference/sql/functions/bround.md b/docs/reference/sql/functions/bround.md index e5ea861bc..14a979ecc 100644 --- a/docs/reference/sql/functions/bround.md +++ b/docs/reference/sql/functions/bround.md @@ -1,3 +1,7 @@ +--- +description: "Returns `expr` rounded to `d` decimal places using HALF_EVEN rounding mode." +--- + # `bround` diff --git a/docs/reference/sql/functions/btrim.md b/docs/reference/sql/functions/btrim.md index 57095f3b7..40bafb241 100644 --- a/docs/reference/sql/functions/btrim.md +++ b/docs/reference/sql/functions/btrim.md @@ -1,3 +1,7 @@ +--- +description: "Removes the leading and trailing space characters from `str`." +--- + # `btrim` diff --git a/docs/reference/sql/functions/cardinality.md b/docs/reference/sql/functions/cardinality.md index aa6abc4d0..7aa261ecb 100644 --- a/docs/reference/sql/functions/cardinality.md +++ b/docs/reference/sql/functions/cardinality.md @@ -1,3 +1,7 @@ +--- +description: "Returns the size of an array or a map." +--- + # `cardinality` diff --git a/docs/reference/sql/functions/case.md b/docs/reference/sql/functions/case.md index 4b5a64573..bc8431b36 100644 --- a/docs/reference/sql/functions/case.md +++ b/docs/reference/sql/functions/case.md @@ -1,3 +1,7 @@ +--- +description: "When `expr1` = `expr2`, returns `expr3`; when `expr1` = `expr4`, return `expr5`; else return `expr6`." +--- + # `case` diff --git a/docs/reference/sql/functions/cast.md b/docs/reference/sql/functions/cast.md index 1bbb451fb..06eb6e8ed 100644 --- a/docs/reference/sql/functions/cast.md +++ b/docs/reference/sql/functions/cast.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `type`." +--- + # `cast` diff --git a/docs/reference/sql/functions/cbrt.md b/docs/reference/sql/functions/cbrt.md index 978e9dbc6..a6f008c86 100644 --- a/docs/reference/sql/functions/cbrt.md +++ b/docs/reference/sql/functions/cbrt.md @@ -1,3 +1,7 @@ +--- +description: "Returns the cube root of `expr`." +--- + # `cbrt` diff --git a/docs/reference/sql/functions/ceil.md b/docs/reference/sql/functions/ceil.md index 20ec08662..ea7f8f64a 100644 --- a/docs/reference/sql/functions/ceil.md +++ b/docs/reference/sql/functions/ceil.md @@ -1,3 +1,7 @@ +--- +description: "Returns the smallest number after rounding up that is not smaller than `expr`." +--- + # `ceil` diff --git a/docs/reference/sql/functions/ceiling.md b/docs/reference/sql/functions/ceiling.md index 29c3d52d9..18efff4a3 100644 --- a/docs/reference/sql/functions/ceiling.md +++ b/docs/reference/sql/functions/ceiling.md @@ -1,3 +1,7 @@ +--- +description: "Returns the smallest number after rounding up that is not smaller than `expr`." +--- + # `ceiling` diff --git a/docs/reference/sql/functions/char.md b/docs/reference/sql/functions/char.md index 2e90cfd4b..9380fc485 100644 --- a/docs/reference/sql/functions/char.md +++ b/docs/reference/sql/functions/char.md @@ -1,3 +1,7 @@ +--- +description: "Returns the ASCII character having the binary equivalent to `expr`." +--- + # `char` diff --git a/docs/reference/sql/functions/char_length.md b/docs/reference/sql/functions/char_length.md index 49f3a20c4..53d60a50a 100644 --- a/docs/reference/sql/functions/char_length.md +++ b/docs/reference/sql/functions/char_length.md @@ -1,3 +1,7 @@ +--- +description: "Returns the character length of string data or number of bytes of binary data." +--- + # `char_length` diff --git a/docs/reference/sql/functions/character_length.md b/docs/reference/sql/functions/character_length.md index 542ce7457..0cb3bd406 100644 --- a/docs/reference/sql/functions/character_length.md +++ b/docs/reference/sql/functions/character_length.md @@ -1,3 +1,7 @@ +--- +description: "Returns the character length of string data or number of bytes of binary data." +--- + # `character_length` diff --git a/docs/reference/sql/functions/chr.md b/docs/reference/sql/functions/chr.md index f0582178c..4105c8335 100644 --- a/docs/reference/sql/functions/chr.md +++ b/docs/reference/sql/functions/chr.md @@ -1,3 +1,7 @@ +--- +description: "Returns the ASCII character having the binary equivalent to `expr`." +--- + # `chr` diff --git a/docs/reference/sql/functions/coalesce.md b/docs/reference/sql/functions/coalesce.md index f7ea9ead8..2d82b080e 100644 --- a/docs/reference/sql/functions/coalesce.md +++ b/docs/reference/sql/functions/coalesce.md @@ -1,3 +1,7 @@ +--- +description: "Returns the first non-null argument if exists." +--- + # `coalesce` diff --git a/docs/reference/sql/functions/collate.md b/docs/reference/sql/functions/collate.md index 4aeb2aa4a..60a140318 100644 --- a/docs/reference/sql/functions/collate.md +++ b/docs/reference/sql/functions/collate.md @@ -1,3 +1,7 @@ +--- +description: "Marks a given expression with the specified collation." +--- + # `collate` diff --git a/docs/reference/sql/functions/collation.md b/docs/reference/sql/functions/collation.md index 378a46ae5..7d335161e 100644 --- a/docs/reference/sql/functions/collation.md +++ b/docs/reference/sql/functions/collation.md @@ -1,3 +1,7 @@ +--- +description: "Returns the collation name of a given expression." +--- + # `collation` diff --git a/docs/reference/sql/functions/collations.md b/docs/reference/sql/functions/collations.md index 3b55b4240..197788f8f 100644 --- a/docs/reference/sql/functions/collations.md +++ b/docs/reference/sql/functions/collations.md @@ -1,3 +1,7 @@ +--- +description: "Get all of the Spark SQL string collations" +--- + # `collations` diff --git a/docs/reference/sql/functions/collect_list.md b/docs/reference/sql/functions/collect_list.md index 5a0a64be4..07eea5a0a 100644 --- a/docs/reference/sql/functions/collect_list.md +++ b/docs/reference/sql/functions/collect_list.md @@ -1,3 +1,7 @@ +--- +description: "Collects and returns a list of non-unique elements." +--- + # `collect_list` diff --git a/docs/reference/sql/functions/collect_set.md b/docs/reference/sql/functions/collect_set.md index b9e2a56ac..6a16095e4 100644 --- a/docs/reference/sql/functions/collect_set.md +++ b/docs/reference/sql/functions/collect_set.md @@ -1,3 +1,7 @@ +--- +description: "Collects and returns a set of unique elements." +--- + # `collect_set` diff --git a/docs/reference/sql/functions/concat.md b/docs/reference/sql/functions/concat.md index 1440cd8a7..d67c082bd 100644 --- a/docs/reference/sql/functions/concat.md +++ b/docs/reference/sql/functions/concat.md @@ -1,3 +1,7 @@ +--- +description: "Returns the concatenation of col1, col2, ..., colN." +--- + # `concat` diff --git a/docs/reference/sql/functions/concat_ws.md b/docs/reference/sql/functions/concat_ws.md index b0aa118f2..e9d06fffc 100644 --- a/docs/reference/sql/functions/concat_ws.md +++ b/docs/reference/sql/functions/concat_ws.md @@ -1,3 +1,7 @@ +--- +description: "Returns the concatenation of the strings separated by `sep`, skipping null values." +--- + # `concat_ws` diff --git a/docs/reference/sql/functions/contains.md b/docs/reference/sql/functions/contains.md index 732ddc03c..acda3ed5b 100644 --- a/docs/reference/sql/functions/contains.md +++ b/docs/reference/sql/functions/contains.md @@ -1,3 +1,7 @@ +--- +description: "Returns a boolean." +--- + # `contains` diff --git a/docs/reference/sql/functions/conv.md b/docs/reference/sql/functions/conv.md index 0afede91e..7b10e8057 100644 --- a/docs/reference/sql/functions/conv.md +++ b/docs/reference/sql/functions/conv.md @@ -1,3 +1,7 @@ +--- +description: "Convert `num` from `from_base` to `to_base`." +--- + # `conv` diff --git a/docs/reference/sql/functions/convert_timezone.md b/docs/reference/sql/functions/convert_timezone.md index 050db647a..b9c02c154 100644 --- a/docs/reference/sql/functions/convert_timezone.md +++ b/docs/reference/sql/functions/convert_timezone.md @@ -1,3 +1,7 @@ +--- +description: "Converts the timestamp without time zone `sourceTs` from the `sourceTz` time zone to `targetTz`." +--- + # `convert_timezone` diff --git a/docs/reference/sql/functions/corr.md b/docs/reference/sql/functions/corr.md index 4534e32f6..5a426dc1f 100644 --- a/docs/reference/sql/functions/corr.md +++ b/docs/reference/sql/functions/corr.md @@ -1,3 +1,7 @@ +--- +description: "Returns Pearson coefficient of correlation between a set of number pairs." +--- + # `corr` diff --git a/docs/reference/sql/functions/cos.md b/docs/reference/sql/functions/cos.md index d820f7d10..3b58c975c 100644 --- a/docs/reference/sql/functions/cos.md +++ b/docs/reference/sql/functions/cos.md @@ -1,3 +1,7 @@ +--- +description: "Returns the cosine of `expr`, as if computed by `java.lang.Math.cos`." +--- + # `cos` diff --git a/docs/reference/sql/functions/cosh.md b/docs/reference/sql/functions/cosh.md index e9cbc20db..c5752b4f6 100644 --- a/docs/reference/sql/functions/cosh.md +++ b/docs/reference/sql/functions/cosh.md @@ -1,3 +1,7 @@ +--- +description: "Returns the hyperbolic cosine of `expr`, as if computed by `java.lang.Math.cosh`." +--- + # `cosh` diff --git a/docs/reference/sql/functions/cot.md b/docs/reference/sql/functions/cot.md index 0cc3f3aeb..bd19edc48 100644 --- a/docs/reference/sql/functions/cot.md +++ b/docs/reference/sql/functions/cot.md @@ -1,3 +1,7 @@ +--- +description: "Returns the cotangent of `expr`, as if computed by `1/java.lang.Math.tan`." +--- + # `cot` diff --git a/docs/reference/sql/functions/count.md b/docs/reference/sql/functions/count.md index b3ee9f8ce..59f4b61e4 100644 --- a/docs/reference/sql/functions/count.md +++ b/docs/reference/sql/functions/count.md @@ -1,3 +1,7 @@ +--- +description: "Returns the total number of retrieved rows, including rows containing null." +--- + # `count` diff --git a/docs/reference/sql/functions/count_if.md b/docs/reference/sql/functions/count_if.md index 80f9e0fe9..a6f24ce5e 100644 --- a/docs/reference/sql/functions/count_if.md +++ b/docs/reference/sql/functions/count_if.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of `TRUE` values for the expression." +--- + # `count_if` diff --git a/docs/reference/sql/functions/count_min_sketch.md b/docs/reference/sql/functions/count_min_sketch.md index 1475990e7..caf1897a3 100644 --- a/docs/reference/sql/functions/count_min_sketch.md +++ b/docs/reference/sql/functions/count_min_sketch.md @@ -1,3 +1,7 @@ +--- +description: "Returns a count-min sketch of a column with the given esp, confidence and seed." +--- + # `count_min_sketch` diff --git a/docs/reference/sql/functions/covar_pop.md b/docs/reference/sql/functions/covar_pop.md index 74ab02eac..10d73b171 100644 --- a/docs/reference/sql/functions/covar_pop.md +++ b/docs/reference/sql/functions/covar_pop.md @@ -1,3 +1,7 @@ +--- +description: "Returns the population covariance of a set of number pairs." +--- + # `covar_pop` diff --git a/docs/reference/sql/functions/covar_samp.md b/docs/reference/sql/functions/covar_samp.md index 2843ac877..1cd1f096e 100644 --- a/docs/reference/sql/functions/covar_samp.md +++ b/docs/reference/sql/functions/covar_samp.md @@ -1,3 +1,7 @@ +--- +description: "Returns the sample covariance of a set of number pairs." +--- + # `covar_samp` diff --git a/docs/reference/sql/functions/crc32.md b/docs/reference/sql/functions/crc32.md index 95165d0eb..3cebe63f3 100644 --- a/docs/reference/sql/functions/crc32.md +++ b/docs/reference/sql/functions/crc32.md @@ -1,3 +1,7 @@ +--- +description: "Returns a cyclic redundancy check value of the `expr` as a bigint." +--- + # `crc32` diff --git a/docs/reference/sql/functions/csc.md b/docs/reference/sql/functions/csc.md index 56d7c868b..efc2c29bd 100644 --- a/docs/reference/sql/functions/csc.md +++ b/docs/reference/sql/functions/csc.md @@ -1,3 +1,7 @@ +--- +description: "Returns the cosecant of `expr`, as if computed by `1/java.lang.Math.sin`." +--- + # `csc` diff --git a/docs/reference/sql/functions/cume_dist.md b/docs/reference/sql/functions/cume_dist.md index 8d1a44f90..650c7f8c9 100644 --- a/docs/reference/sql/functions/cume_dist.md +++ b/docs/reference/sql/functions/cume_dist.md @@ -1,3 +1,7 @@ +--- +description: "Computes the position of a value relative to all values in the partition." +--- + # `cume_dist` diff --git a/docs/reference/sql/functions/curdate.md b/docs/reference/sql/functions/curdate.md index b5af56ac8..e43d7c2c4 100644 --- a/docs/reference/sql/functions/curdate.md +++ b/docs/reference/sql/functions/curdate.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current date at the start of query evaluation." +--- + # `curdate` diff --git a/docs/reference/sql/functions/current_catalog.md b/docs/reference/sql/functions/current_catalog.md index 1b679fe09..79a76bc06 100644 --- a/docs/reference/sql/functions/current_catalog.md +++ b/docs/reference/sql/functions/current_catalog.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current catalog." +--- + # `current_catalog` diff --git a/docs/reference/sql/functions/current_database.md b/docs/reference/sql/functions/current_database.md index 1550bc5a4..5c52f848b 100644 --- a/docs/reference/sql/functions/current_database.md +++ b/docs/reference/sql/functions/current_database.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current database." +--- + # `current_database` diff --git a/docs/reference/sql/functions/current_date.md b/docs/reference/sql/functions/current_date.md index 3acdec4c2..43f152166 100644 --- a/docs/reference/sql/functions/current_date.md +++ b/docs/reference/sql/functions/current_date.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current date at the start of query evaluation." +--- + # `current_date` diff --git a/docs/reference/sql/functions/current_path.md b/docs/reference/sql/functions/current_path.md index e030b0c3e..8fa431ca1 100644 --- a/docs/reference/sql/functions/current_path.md +++ b/docs/reference/sql/functions/current_path.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current SQL path (qualified schema names)." +--- + # `current_path` diff --git a/docs/reference/sql/functions/current_schema.md b/docs/reference/sql/functions/current_schema.md index 36c618ae8..65ff74e7b 100644 --- a/docs/reference/sql/functions/current_schema.md +++ b/docs/reference/sql/functions/current_schema.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current database." +--- + # `current_schema` diff --git a/docs/reference/sql/functions/current_time.md b/docs/reference/sql/functions/current_time.md index 3b2b6f4b0..ce4a62a73 100644 --- a/docs/reference/sql/functions/current_time.md +++ b/docs/reference/sql/functions/current_time.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current time at the start of query evaluation." +--- + # `current_time` diff --git a/docs/reference/sql/functions/current_timestamp.md b/docs/reference/sql/functions/current_timestamp.md index afc256e40..d65d251cf 100644 --- a/docs/reference/sql/functions/current_timestamp.md +++ b/docs/reference/sql/functions/current_timestamp.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current timestamp at the start of query evaluation." +--- + # `current_timestamp` diff --git a/docs/reference/sql/functions/current_timezone.md b/docs/reference/sql/functions/current_timezone.md index 5dfc3ced5..783c14deb 100644 --- a/docs/reference/sql/functions/current_timezone.md +++ b/docs/reference/sql/functions/current_timezone.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current session local timezone." +--- + # `current_timezone` diff --git a/docs/reference/sql/functions/current_user.md b/docs/reference/sql/functions/current_user.md index 0827c4bad..35a0628ef 100644 --- a/docs/reference/sql/functions/current_user.md +++ b/docs/reference/sql/functions/current_user.md @@ -1,3 +1,7 @@ +--- +description: "user name of current execution context." +--- + # `current_user` diff --git a/docs/reference/sql/functions/date.md b/docs/reference/sql/functions/date.md index 2db15feb0..6905926dc 100644 --- a/docs/reference/sql/functions/date.md +++ b/docs/reference/sql/functions/date.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `date`." +--- + # `date` diff --git a/docs/reference/sql/functions/date_add.md b/docs/reference/sql/functions/date_add.md index d75675f60..238725120 100644 --- a/docs/reference/sql/functions/date_add.md +++ b/docs/reference/sql/functions/date_add.md @@ -1,3 +1,7 @@ +--- +description: "Returns the date that is `num_days` after `start_date`." +--- + # `date_add` diff --git a/docs/reference/sql/functions/date_diff.md b/docs/reference/sql/functions/date_diff.md index 2218c8235..5a954ba99 100644 --- a/docs/reference/sql/functions/date_diff.md +++ b/docs/reference/sql/functions/date_diff.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of days from `startDate` to `endDate`." +--- + # `date_diff` diff --git a/docs/reference/sql/functions/date_format.md b/docs/reference/sql/functions/date_format.md index 8d878ea7d..81772ac78 100644 --- a/docs/reference/sql/functions/date_format.md +++ b/docs/reference/sql/functions/date_format.md @@ -1,3 +1,7 @@ +--- +description: "Converts `timestamp` to a value of string in the format specified by the date format `fmt`." +--- + # `date_format` diff --git a/docs/reference/sql/functions/date_from_unix_date.md b/docs/reference/sql/functions/date_from_unix_date.md index cbbc93823..22cc44aa7 100644 --- a/docs/reference/sql/functions/date_from_unix_date.md +++ b/docs/reference/sql/functions/date_from_unix_date.md @@ -1,3 +1,7 @@ +--- +description: "Create date from the number of days since 1970-01-01." +--- + # `date_from_unix_date` diff --git a/docs/reference/sql/functions/date_part.md b/docs/reference/sql/functions/date_part.md index 2d0a42c9d..923c70a4b 100644 --- a/docs/reference/sql/functions/date_part.md +++ b/docs/reference/sql/functions/date_part.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a part of the date/timestamp or interval source." +--- + # `date_part` diff --git a/docs/reference/sql/functions/date_sub.md b/docs/reference/sql/functions/date_sub.md index 75cc1ec61..88de0d353 100644 --- a/docs/reference/sql/functions/date_sub.md +++ b/docs/reference/sql/functions/date_sub.md @@ -1,3 +1,7 @@ +--- +description: "Returns the date that is `num_days` before `start_date`." +--- + # `date_sub` diff --git a/docs/reference/sql/functions/date_trunc.md b/docs/reference/sql/functions/date_trunc.md index 9ce371744..961903afd 100644 --- a/docs/reference/sql/functions/date_trunc.md +++ b/docs/reference/sql/functions/date_trunc.md @@ -1,3 +1,7 @@ +--- +description: "Returns timestamp `ts` truncated to the unit specified by the format model `fmt`." +--- + # `date_trunc` diff --git a/docs/reference/sql/functions/dateadd.md b/docs/reference/sql/functions/dateadd.md index ebf66a59f..c8c82438d 100644 --- a/docs/reference/sql/functions/dateadd.md +++ b/docs/reference/sql/functions/dateadd.md @@ -1,3 +1,7 @@ +--- +description: "Returns the date that is `num_days` after `start_date`." +--- + # `dateadd` diff --git a/docs/reference/sql/functions/datediff.md b/docs/reference/sql/functions/datediff.md index 691714a48..63f288b18 100644 --- a/docs/reference/sql/functions/datediff.md +++ b/docs/reference/sql/functions/datediff.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of days from `startDate` to `endDate`." +--- + # `datediff` diff --git a/docs/reference/sql/functions/datepart.md b/docs/reference/sql/functions/datepart.md index bfb023b10..480477190 100644 --- a/docs/reference/sql/functions/datepart.md +++ b/docs/reference/sql/functions/datepart.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a part of the date/timestamp or interval source." +--- + # `datepart` diff --git a/docs/reference/sql/functions/day.md b/docs/reference/sql/functions/day.md index 92dc30b66..fa88dfdae 100644 --- a/docs/reference/sql/functions/day.md +++ b/docs/reference/sql/functions/day.md @@ -1,3 +1,7 @@ +--- +description: "Returns the day of month of the date/timestamp." +--- + # `day` diff --git a/docs/reference/sql/functions/dayname.md b/docs/reference/sql/functions/dayname.md index 8558b1a11..c2c95d871 100644 --- a/docs/reference/sql/functions/dayname.md +++ b/docs/reference/sql/functions/dayname.md @@ -1,3 +1,7 @@ +--- +description: "Returns the three-letter abbreviated day name from the given date." +--- + # `dayname` diff --git a/docs/reference/sql/functions/dayofmonth.md b/docs/reference/sql/functions/dayofmonth.md index c062cb2fb..2e1914eee 100644 --- a/docs/reference/sql/functions/dayofmonth.md +++ b/docs/reference/sql/functions/dayofmonth.md @@ -1,3 +1,7 @@ +--- +description: "Returns the day of month of the date/timestamp." +--- + # `dayofmonth` diff --git a/docs/reference/sql/functions/dayofweek.md b/docs/reference/sql/functions/dayofweek.md index d2b2ae8a0..7a00a5f82 100644 --- a/docs/reference/sql/functions/dayofweek.md +++ b/docs/reference/sql/functions/dayofweek.md @@ -1,3 +1,7 @@ +--- +description: "Returns the day of the week for date/timestamp (1 = Sunday, 2 = Monday, ..., 7 = Saturday)." +--- + # `dayofweek` diff --git a/docs/reference/sql/functions/dayofyear.md b/docs/reference/sql/functions/dayofyear.md index 88848a1f6..057d4b526 100644 --- a/docs/reference/sql/functions/dayofyear.md +++ b/docs/reference/sql/functions/dayofyear.md @@ -1,3 +1,7 @@ +--- +description: "Returns the day of year of the date/timestamp." +--- + # `dayofyear` diff --git a/docs/reference/sql/functions/decimal.md b/docs/reference/sql/functions/decimal.md index c66e11b68..2578f8bb5 100644 --- a/docs/reference/sql/functions/decimal.md +++ b/docs/reference/sql/functions/decimal.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `decimal`." +--- + # `decimal` diff --git a/docs/reference/sql/functions/decode.md b/docs/reference/sql/functions/decode.md index c5a4185ce..14d0535e3 100644 --- a/docs/reference/sql/functions/decode.md +++ b/docs/reference/sql/functions/decode.md @@ -1,3 +1,7 @@ +--- +description: "Decodes the first argument using the second argument character set." +--- + # `decode` diff --git a/docs/reference/sql/functions/degrees.md b/docs/reference/sql/functions/degrees.md index 93fce38d0..4fff63493 100644 --- a/docs/reference/sql/functions/degrees.md +++ b/docs/reference/sql/functions/degrees.md @@ -1,3 +1,7 @@ +--- +description: "Converts radians to degrees." +--- + # `degrees` diff --git a/docs/reference/sql/functions/dense_rank.md b/docs/reference/sql/functions/dense_rank.md index 59619f3cd..60b55ac7f 100644 --- a/docs/reference/sql/functions/dense_rank.md +++ b/docs/reference/sql/functions/dense_rank.md @@ -1,3 +1,7 @@ +--- +description: "Computes the rank of a value in a group of values." +--- + # `dense_rank` diff --git a/docs/reference/sql/functions/div.md b/docs/reference/sql/functions/div.md index bc8112dba..cefe236dc 100644 --- a/docs/reference/sql/functions/div.md +++ b/docs/reference/sql/functions/div.md @@ -1,3 +1,7 @@ +--- +description: "Divide `expr1` by `expr2`." +--- + # `div` diff --git a/docs/reference/sql/functions/double.md b/docs/reference/sql/functions/double.md index 81b90c77e..62c9b2457 100644 --- a/docs/reference/sql/functions/double.md +++ b/docs/reference/sql/functions/double.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `double`." +--- + # `double` diff --git a/docs/reference/sql/functions/e.md b/docs/reference/sql/functions/e.md index 606797bd6..870e1e4b2 100644 --- a/docs/reference/sql/functions/e.md +++ b/docs/reference/sql/functions/e.md @@ -1,3 +1,7 @@ +--- +description: "Returns Euler's number, e." +--- + # `e` diff --git a/docs/reference/sql/functions/element_at.md b/docs/reference/sql/functions/element_at.md index bc487850d..bfc4ed5f7 100644 --- a/docs/reference/sql/functions/element_at.md +++ b/docs/reference/sql/functions/element_at.md @@ -1,3 +1,7 @@ +--- +description: "Returns element of array at given (1-based) index." +--- + # `element_at` diff --git a/docs/reference/sql/functions/elt.md b/docs/reference/sql/functions/elt.md index 41289c8fa..2e210c8d4 100644 --- a/docs/reference/sql/functions/elt.md +++ b/docs/reference/sql/functions/elt.md @@ -1,3 +1,7 @@ +--- +description: "Returns the `n`-th input, e.g., returns `input2` when `n` is 2." +--- + # `elt` diff --git a/docs/reference/sql/functions/encode.md b/docs/reference/sql/functions/encode.md index 6eafb317e..47f9dfa34 100644 --- a/docs/reference/sql/functions/encode.md +++ b/docs/reference/sql/functions/encode.md @@ -1,3 +1,7 @@ +--- +description: "Encodes the first argument using the second argument character set." +--- + # `encode` diff --git a/docs/reference/sql/functions/endswith.md b/docs/reference/sql/functions/endswith.md index 4a5125ad5..672dd0901 100644 --- a/docs/reference/sql/functions/endswith.md +++ b/docs/reference/sql/functions/endswith.md @@ -1,3 +1,7 @@ +--- +description: "Returns a boolean." +--- + # `endswith` diff --git a/docs/reference/sql/functions/equal_null.md b/docs/reference/sql/functions/equal_null.md index 87b0abd92..dc6f1dc0d 100644 --- a/docs/reference/sql/functions/equal_null.md +++ b/docs/reference/sql/functions/equal_null.md @@ -1,3 +1,7 @@ +--- +description: "Returns same result as the EQUAL(=) operator for non-null operands, but returns true if both are null, false if one of the them is null." +--- + # `equal_null` diff --git a/docs/reference/sql/functions/every.md b/docs/reference/sql/functions/every.md index 5c8363985..875c97ca3 100644 --- a/docs/reference/sql/functions/every.md +++ b/docs/reference/sql/functions/every.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if all values of `expr` are true." +--- + # `every` diff --git a/docs/reference/sql/functions/exists.md b/docs/reference/sql/functions/exists.md index 3d1133857..d1623515a 100644 --- a/docs/reference/sql/functions/exists.md +++ b/docs/reference/sql/functions/exists.md @@ -1,3 +1,7 @@ +--- +description: "Tests whether a predicate holds for one or more elements in the array." +--- + # `exists` diff --git a/docs/reference/sql/functions/exp.md b/docs/reference/sql/functions/exp.md index d0ad30dba..52a5c28b1 100644 --- a/docs/reference/sql/functions/exp.md +++ b/docs/reference/sql/functions/exp.md @@ -1,3 +1,7 @@ +--- +description: "Returns e to the power of `expr`." +--- + # `exp` diff --git a/docs/reference/sql/functions/explode.md b/docs/reference/sql/functions/explode.md index 5249c24e6..1a3583685 100644 --- a/docs/reference/sql/functions/explode.md +++ b/docs/reference/sql/functions/explode.md @@ -1,3 +1,7 @@ +--- +description: "Separates the elements of array `expr` into multiple rows, or the elements of map `expr` into multiple rows and columns." +--- + # `explode` diff --git a/docs/reference/sql/functions/explode_outer.md b/docs/reference/sql/functions/explode_outer.md index faee09fc3..b80d3d869 100644 --- a/docs/reference/sql/functions/explode_outer.md +++ b/docs/reference/sql/functions/explode_outer.md @@ -1,3 +1,7 @@ +--- +description: "Separates the elements of array `expr` into multiple rows, or the elements of map `expr` into multiple rows and columns." +--- + # `explode_outer` diff --git a/docs/reference/sql/functions/expm1.md b/docs/reference/sql/functions/expm1.md index 0ffc33d01..d07f63374 100644 --- a/docs/reference/sql/functions/expm1.md +++ b/docs/reference/sql/functions/expm1.md @@ -1,3 +1,7 @@ +--- +description: "Returns exp(`expr`) - 1." +--- + # `expm1` diff --git a/docs/reference/sql/functions/extract.md b/docs/reference/sql/functions/extract.md index 6609411a1..9c01261d0 100644 --- a/docs/reference/sql/functions/extract.md +++ b/docs/reference/sql/functions/extract.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a part of the date or timestamp or time or interval source." +--- + # `extract` diff --git a/docs/reference/sql/functions/factorial.md b/docs/reference/sql/functions/factorial.md index 4b430335f..c9178fd7c 100644 --- a/docs/reference/sql/functions/factorial.md +++ b/docs/reference/sql/functions/factorial.md @@ -1,3 +1,7 @@ +--- +description: "Returns the factorial of `expr`." +--- + # `factorial` diff --git a/docs/reference/sql/functions/filter.md b/docs/reference/sql/functions/filter.md index 9f4a75b08..83f6d82b4 100644 --- a/docs/reference/sql/functions/filter.md +++ b/docs/reference/sql/functions/filter.md @@ -1,3 +1,7 @@ +--- +description: "Filters the input array using the given predicate." +--- + # `filter` diff --git a/docs/reference/sql/functions/find_in_set.md b/docs/reference/sql/functions/find_in_set.md index b36415623..4e26e4445 100644 --- a/docs/reference/sql/functions/find_in_set.md +++ b/docs/reference/sql/functions/find_in_set.md @@ -1,3 +1,7 @@ +--- +description: "Returns the index (1-based) of the given string (`str`) in the comma-delimited list (`str_array`)." +--- + # `find_in_set` diff --git a/docs/reference/sql/functions/first.md b/docs/reference/sql/functions/first.md index 87e6c94ea..f2ab6ef94 100644 --- a/docs/reference/sql/functions/first.md +++ b/docs/reference/sql/functions/first.md @@ -1,3 +1,7 @@ +--- +description: "Returns the first value of `expr` for a group of rows." +--- + # `first` diff --git a/docs/reference/sql/functions/first_value.md b/docs/reference/sql/functions/first_value.md index bfcb86a25..502b5c51f 100644 --- a/docs/reference/sql/functions/first_value.md +++ b/docs/reference/sql/functions/first_value.md @@ -1,3 +1,7 @@ +--- +description: "Returns the first value of `expr` for a group of rows." +--- + # `first_value` diff --git a/docs/reference/sql/functions/flatten.md b/docs/reference/sql/functions/flatten.md index 4325b053a..ba4d0c51c 100644 --- a/docs/reference/sql/functions/flatten.md +++ b/docs/reference/sql/functions/flatten.md @@ -1,3 +1,7 @@ +--- +description: "Transforms an array of arrays into a single array." +--- + # `flatten` diff --git a/docs/reference/sql/functions/float.md b/docs/reference/sql/functions/float.md index 7b9b69d5c..49d2e7972 100644 --- a/docs/reference/sql/functions/float.md +++ b/docs/reference/sql/functions/float.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `float`." +--- + # `float` diff --git a/docs/reference/sql/functions/floor.md b/docs/reference/sql/functions/floor.md index 772ed1451..742a48488 100644 --- a/docs/reference/sql/functions/floor.md +++ b/docs/reference/sql/functions/floor.md @@ -1,3 +1,7 @@ +--- +description: "Returns the largest number after rounding down that is not greater than `expr`." +--- + # `floor` diff --git a/docs/reference/sql/functions/forall.md b/docs/reference/sql/functions/forall.md index 491d1c5c8..373b3506f 100644 --- a/docs/reference/sql/functions/forall.md +++ b/docs/reference/sql/functions/forall.md @@ -1,3 +1,7 @@ +--- +description: "Tests whether a predicate holds for all elements in the array." +--- + # `forall` diff --git a/docs/reference/sql/functions/format_number.md b/docs/reference/sql/functions/format_number.md index 5d1fc4ee8..af0196fc0 100644 --- a/docs/reference/sql/functions/format_number.md +++ b/docs/reference/sql/functions/format_number.md @@ -1,3 +1,7 @@ +--- +description: "Formats the number `expr1` like '#,###,###.##', rounded to `expr2` decimal places." +--- + # `format_number` diff --git a/docs/reference/sql/functions/format_string.md b/docs/reference/sql/functions/format_string.md index 8e94a3d38..bdb82a053 100644 --- a/docs/reference/sql/functions/format_string.md +++ b/docs/reference/sql/functions/format_string.md @@ -1,3 +1,7 @@ +--- +description: "Returns a formatted string from printf-style format strings." +--- + # `format_string` diff --git a/docs/reference/sql/functions/from_avro.md b/docs/reference/sql/functions/from_avro.md index 8df813fb9..8776bd40d 100644 --- a/docs/reference/sql/functions/from_avro.md +++ b/docs/reference/sql/functions/from_avro.md @@ -1,3 +1,7 @@ +--- +description: "Converts a binary Avro value into a Catalyst value." +--- + # `from_avro` diff --git a/docs/reference/sql/functions/from_csv.md b/docs/reference/sql/functions/from_csv.md index 40e438651..3a9a88927 100644 --- a/docs/reference/sql/functions/from_csv.md +++ b/docs/reference/sql/functions/from_csv.md @@ -1,3 +1,7 @@ +--- +description: "Returns a struct value with the given `csvStr` and `schema`." +--- + # `from_csv` diff --git a/docs/reference/sql/functions/from_json.md b/docs/reference/sql/functions/from_json.md index a86ffb922..1d5c00600 100644 --- a/docs/reference/sql/functions/from_json.md +++ b/docs/reference/sql/functions/from_json.md @@ -1,3 +1,7 @@ +--- +description: "Returns a struct value with the given `jsonStr` and `schema`." +--- + # `from_json` diff --git a/docs/reference/sql/functions/from_protobuf.md b/docs/reference/sql/functions/from_protobuf.md index 3b386266d..062c6e703 100644 --- a/docs/reference/sql/functions/from_protobuf.md +++ b/docs/reference/sql/functions/from_protobuf.md @@ -1,3 +1,7 @@ +--- +description: "Converts a binary Protobuf value into a Catalyst value." +--- + # `from_protobuf` diff --git a/docs/reference/sql/functions/from_unixtime.md b/docs/reference/sql/functions/from_unixtime.md index c566a0d59..8eafef9ef 100644 --- a/docs/reference/sql/functions/from_unixtime.md +++ b/docs/reference/sql/functions/from_unixtime.md @@ -1,3 +1,7 @@ +--- +description: "Returns `unix_time` in the specified `fmt`." +--- + # `from_unixtime` diff --git a/docs/reference/sql/functions/from_utc_timestamp.md b/docs/reference/sql/functions/from_utc_timestamp.md index f35bd6ac6..361f5936f 100644 --- a/docs/reference/sql/functions/from_utc_timestamp.md +++ b/docs/reference/sql/functions/from_utc_timestamp.md @@ -1,3 +1,7 @@ +--- +description: "Given a timestamp like '2017-07-14 02:40:00.0', interprets it as a time in UTC, and renders that time as a timestamp in the given time zone." +--- + # `from_utc_timestamp` diff --git a/docs/reference/sql/functions/from_xml.md b/docs/reference/sql/functions/from_xml.md index 5e6786a8f..1d68e7d3d 100644 --- a/docs/reference/sql/functions/from_xml.md +++ b/docs/reference/sql/functions/from_xml.md @@ -1,3 +1,7 @@ +--- +description: "Returns a struct value with the given `xmlStr` and `schema`." +--- + # `from_xml` diff --git a/docs/reference/sql/functions/get.md b/docs/reference/sql/functions/get.md index 2056e397c..6821eff17 100644 --- a/docs/reference/sql/functions/get.md +++ b/docs/reference/sql/functions/get.md @@ -1,3 +1,7 @@ +--- +description: "Returns element of array at given (0-based) index." +--- + # `get` diff --git a/docs/reference/sql/functions/get_json_object.md b/docs/reference/sql/functions/get_json_object.md index bc31ea3fa..df0251ba6 100644 --- a/docs/reference/sql/functions/get_json_object.md +++ b/docs/reference/sql/functions/get_json_object.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a json object from `path`." +--- + # `get_json_object` diff --git a/docs/reference/sql/functions/getbit.md b/docs/reference/sql/functions/getbit.md index 2d1658901..8a08948b4 100644 --- a/docs/reference/sql/functions/getbit.md +++ b/docs/reference/sql/functions/getbit.md @@ -1,3 +1,7 @@ +--- +description: "Returns the value of the bit (0 or 1) at the specified position." +--- + # `getbit` diff --git a/docs/reference/sql/functions/greatest.md b/docs/reference/sql/functions/greatest.md index ee3ea6d4e..786e3f29c 100644 --- a/docs/reference/sql/functions/greatest.md +++ b/docs/reference/sql/functions/greatest.md @@ -1,3 +1,7 @@ +--- +description: "Returns the greatest value of all parameters, skipping null values." +--- + # `greatest` diff --git a/docs/reference/sql/functions/grouping.md b/docs/reference/sql/functions/grouping.md index 31d41b586..81f0f14f5 100644 --- a/docs/reference/sql/functions/grouping.md +++ b/docs/reference/sql/functions/grouping.md @@ -1,3 +1,7 @@ +--- +description: "indicates whether a specified column in a GROUP BY is aggregated or not, returns 1 for aggregated or 0 for not aggregated in the result set." +--- + # `grouping` diff --git a/docs/reference/sql/functions/grouping_id.md b/docs/reference/sql/functions/grouping_id.md index df32be90e..813092498 100644 --- a/docs/reference/sql/functions/grouping_id.md +++ b/docs/reference/sql/functions/grouping_id.md @@ -1,3 +1,7 @@ +--- +description: "returns the level of grouping, equals to `(grouping(c1) << (n-1)) + (grouping(c2) << (n-2)) + ..." +--- + # `grouping_id` diff --git a/docs/reference/sql/functions/hash.md b/docs/reference/sql/functions/hash.md index 7e8ef3e14..72f6eeb4f 100644 --- a/docs/reference/sql/functions/hash.md +++ b/docs/reference/sql/functions/hash.md @@ -1,3 +1,7 @@ +--- +description: "Returns a hash value of the arguments." +--- + # `hash` diff --git a/docs/reference/sql/functions/hex.md b/docs/reference/sql/functions/hex.md index b0288ecaa..0be02de16 100644 --- a/docs/reference/sql/functions/hex.md +++ b/docs/reference/sql/functions/hex.md @@ -1,3 +1,7 @@ +--- +description: "Converts `expr` to hexadecimal." +--- + # `hex` diff --git a/docs/reference/sql/functions/histogram_numeric.md b/docs/reference/sql/functions/histogram_numeric.md index 1ba39a6e3..8cffcad35 100644 --- a/docs/reference/sql/functions/histogram_numeric.md +++ b/docs/reference/sql/functions/histogram_numeric.md @@ -1,3 +1,7 @@ +--- +description: "Computes a histogram on numeric 'expr' using nb bins." +--- + # `histogram_numeric` diff --git a/docs/reference/sql/functions/hll_sketch_agg.md b/docs/reference/sql/functions/hll_sketch_agg.md index f4c578a52..9ce11190d 100644 --- a/docs/reference/sql/functions/hll_sketch_agg.md +++ b/docs/reference/sql/functions/hll_sketch_agg.md @@ -1,3 +1,7 @@ +--- +description: "Returns the HllSketch's updatable binary representation." +--- + # `hll_sketch_agg` diff --git a/docs/reference/sql/functions/hll_sketch_estimate.md b/docs/reference/sql/functions/hll_sketch_estimate.md index dd7d0b037..cd6feefd1 100644 --- a/docs/reference/sql/functions/hll_sketch_estimate.md +++ b/docs/reference/sql/functions/hll_sketch_estimate.md @@ -1,3 +1,7 @@ +--- +description: "Returns the estimated number of unique values given the binary representation of a Datasketches HllSketch." +--- + # `hll_sketch_estimate` diff --git a/docs/reference/sql/functions/hll_union.md b/docs/reference/sql/functions/hll_union.md index 719b534bd..9fbc2e07c 100644 --- a/docs/reference/sql/functions/hll_union.md +++ b/docs/reference/sql/functions/hll_union.md @@ -1,3 +1,7 @@ +--- +description: "Merges two binary representations of Datasketches HllSketch objects, using a Datasketches Union object." +--- + # `hll_union` diff --git a/docs/reference/sql/functions/hll_union_agg.md b/docs/reference/sql/functions/hll_union_agg.md index 1d89ba750..6ae3f8914 100644 --- a/docs/reference/sql/functions/hll_union_agg.md +++ b/docs/reference/sql/functions/hll_union_agg.md @@ -1,3 +1,7 @@ +--- +description: "Returns the estimated number of unique values." +--- + # `hll_union_agg` diff --git a/docs/reference/sql/functions/hour.md b/docs/reference/sql/functions/hour.md index 298fab014..779d4deca 100644 --- a/docs/reference/sql/functions/hour.md +++ b/docs/reference/sql/functions/hour.md @@ -1,3 +1,7 @@ +--- +description: "Returns the hour component of the given expression." +--- + # `hour` diff --git a/docs/reference/sql/functions/hypot.md b/docs/reference/sql/functions/hypot.md index b0ec0a269..a9e77865c 100644 --- a/docs/reference/sql/functions/hypot.md +++ b/docs/reference/sql/functions/hypot.md @@ -1,3 +1,7 @@ +--- +description: "Returns sqrt(`expr1`² + `expr2`²)." +--- + # `hypot` diff --git a/docs/reference/sql/functions/if.md b/docs/reference/sql/functions/if.md index 053ef80f2..7b76a597a 100644 --- a/docs/reference/sql/functions/if.md +++ b/docs/reference/sql/functions/if.md @@ -1,3 +1,7 @@ +--- +description: "If `expr1` evaluates to true, then returns `expr2`; otherwise returns `expr3`." +--- + # `if` diff --git a/docs/reference/sql/functions/ifnull.md b/docs/reference/sql/functions/ifnull.md index d8690df5c..e27ad3369 100644 --- a/docs/reference/sql/functions/ifnull.md +++ b/docs/reference/sql/functions/ifnull.md @@ -1,3 +1,7 @@ +--- +description: "Returns `expr2` if `expr1` is null, or `expr1` otherwise." +--- + # `ifnull` diff --git a/docs/reference/sql/functions/ilike.md b/docs/reference/sql/functions/ilike.md index 56c69cddc..37a58c302 100644 --- a/docs/reference/sql/functions/ilike.md +++ b/docs/reference/sql/functions/ilike.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if str matches `pattern` with `escape` case-insensitively, null if any arguments are null, false otherwise." +--- + # `ilike` diff --git a/docs/reference/sql/functions/in.md b/docs/reference/sql/functions/in.md index ca0ed768e..3acacabd1 100644 --- a/docs/reference/sql/functions/in.md +++ b/docs/reference/sql/functions/in.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr` equals to any valN." +--- + # `in` diff --git a/docs/reference/sql/functions/index.md b/docs/reference/sql/functions/index.md index 9820624b5..3202037de 100644 --- a/docs/reference/sql/functions/index.md +++ b/docs/reference/sql/functions/index.md @@ -1,3 +1,7 @@ +--- +description: "Every Spark built-in function and operator, with Spark's description and examples and Krishiv's status." +--- + # SQL function reference diff --git a/docs/reference/sql/functions/initcap.md b/docs/reference/sql/functions/initcap.md index 6280103aa..32eb9ee28 100644 --- a/docs/reference/sql/functions/initcap.md +++ b/docs/reference/sql/functions/initcap.md @@ -1,3 +1,7 @@ +--- +description: "Returns `str` with the first letter of each word in uppercase." +--- + # `initcap` diff --git a/docs/reference/sql/functions/inline.md b/docs/reference/sql/functions/inline.md index db937664b..e2cba5ea2 100644 --- a/docs/reference/sql/functions/inline.md +++ b/docs/reference/sql/functions/inline.md @@ -1,3 +1,7 @@ +--- +description: "Explodes an array of structs into a table." +--- + # `inline` diff --git a/docs/reference/sql/functions/inline_outer.md b/docs/reference/sql/functions/inline_outer.md index b814508d6..b2868c01c 100644 --- a/docs/reference/sql/functions/inline_outer.md +++ b/docs/reference/sql/functions/inline_outer.md @@ -1,3 +1,7 @@ +--- +description: "Explodes an array of structs into a table." +--- + # `inline_outer` diff --git a/docs/reference/sql/functions/input_file_block_length.md b/docs/reference/sql/functions/input_file_block_length.md index a0c3244f2..376d70b01 100644 --- a/docs/reference/sql/functions/input_file_block_length.md +++ b/docs/reference/sql/functions/input_file_block_length.md @@ -1,3 +1,7 @@ +--- +description: "Returns the length of the block being read, or -1 if not available." +--- + # `input_file_block_length` diff --git a/docs/reference/sql/functions/input_file_block_start.md b/docs/reference/sql/functions/input_file_block_start.md index e76e437f1..577230f8e 100644 --- a/docs/reference/sql/functions/input_file_block_start.md +++ b/docs/reference/sql/functions/input_file_block_start.md @@ -1,3 +1,7 @@ +--- +description: "Returns the start offset of the block being read, or -1 if not available." +--- + # `input_file_block_start` diff --git a/docs/reference/sql/functions/input_file_name.md b/docs/reference/sql/functions/input_file_name.md index 9cdf7c174..9ea174873 100644 --- a/docs/reference/sql/functions/input_file_name.md +++ b/docs/reference/sql/functions/input_file_name.md @@ -1,3 +1,7 @@ +--- +description: "Returns the name of the file being read, or empty string if not available." +--- + # `input_file_name` diff --git a/docs/reference/sql/functions/instr.md b/docs/reference/sql/functions/instr.md index 38a4ab899..ad655f398 100644 --- a/docs/reference/sql/functions/instr.md +++ b/docs/reference/sql/functions/instr.md @@ -1,3 +1,7 @@ +--- +description: "Returns the (1-based) index of the first occurrence of `substr` in `str`." +--- + # `instr` diff --git a/docs/reference/sql/functions/int.md b/docs/reference/sql/functions/int.md index 738f0b930..c9e7263f1 100644 --- a/docs/reference/sql/functions/int.md +++ b/docs/reference/sql/functions/int.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `int`." +--- + # `int` diff --git a/docs/reference/sql/functions/is_valid_utf8.md b/docs/reference/sql/functions/is_valid_utf8.md index 90f260879..5836ca3bb 100644 --- a/docs/reference/sql/functions/is_valid_utf8.md +++ b/docs/reference/sql/functions/is_valid_utf8.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `str` is a valid UTF-8 string, otherwise returns false." +--- + # `is_valid_utf8` diff --git a/docs/reference/sql/functions/is_valid_variant.md b/docs/reference/sql/functions/is_valid_variant.md index 5e0146986..aac94755b 100644 --- a/docs/reference/sql/functions/is_valid_variant.md +++ b/docs/reference/sql/functions/is_valid_variant.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if the variant is valid, false if it is malformed, NULL if `v` is NULL." +--- + # `is_valid_variant` diff --git a/docs/reference/sql/functions/is_variant_null.md b/docs/reference/sql/functions/is_variant_null.md index 4e908caec..0e2e87415 100644 --- a/docs/reference/sql/functions/is_variant_null.md +++ b/docs/reference/sql/functions/is_variant_null.md @@ -1,3 +1,7 @@ +--- +description: "Check if a variant value is a variant null." +--- + # `is_variant_null` diff --git a/docs/reference/sql/functions/isnan.md b/docs/reference/sql/functions/isnan.md index 617e80a05..40f16f2c2 100644 --- a/docs/reference/sql/functions/isnan.md +++ b/docs/reference/sql/functions/isnan.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr` is NaN, or false otherwise." +--- + # `isnan` diff --git a/docs/reference/sql/functions/isnotnull.md b/docs/reference/sql/functions/isnotnull.md index 7a242b160..277a5125a 100644 --- a/docs/reference/sql/functions/isnotnull.md +++ b/docs/reference/sql/functions/isnotnull.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr` is not null, or false otherwise." +--- + # `isnotnull` diff --git a/docs/reference/sql/functions/isnull.md b/docs/reference/sql/functions/isnull.md index 2cc13a88d..f93630395 100644 --- a/docs/reference/sql/functions/isnull.md +++ b/docs/reference/sql/functions/isnull.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr` is null, or false otherwise." +--- + # `isnull` diff --git a/docs/reference/sql/functions/java_method.md b/docs/reference/sql/functions/java_method.md index b14476276..8a484bd0a 100644 --- a/docs/reference/sql/functions/java_method.md +++ b/docs/reference/sql/functions/java_method.md @@ -1,3 +1,7 @@ +--- +description: "Calls a method with reflection." +--- + # `java_method` diff --git a/docs/reference/sql/functions/json_array_length.md b/docs/reference/sql/functions/json_array_length.md index 74e082889..12cf0add3 100644 --- a/docs/reference/sql/functions/json_array_length.md +++ b/docs/reference/sql/functions/json_array_length.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of elements in the outermost JSON array." +--- + # `json_array_length` diff --git a/docs/reference/sql/functions/json_object_keys.md b/docs/reference/sql/functions/json_object_keys.md index a3c03a2cf..89781205b 100644 --- a/docs/reference/sql/functions/json_object_keys.md +++ b/docs/reference/sql/functions/json_object_keys.md @@ -1,3 +1,7 @@ +--- +description: "Returns all the keys of the outermost JSON object as an array." +--- + # `json_object_keys` diff --git a/docs/reference/sql/functions/json_tuple.md b/docs/reference/sql/functions/json_tuple.md index 5e14a1165..56b803c25 100644 --- a/docs/reference/sql/functions/json_tuple.md +++ b/docs/reference/sql/functions/json_tuple.md @@ -1,3 +1,7 @@ +--- +description: "Returns a tuple like the function get_json_object, but it takes multiple names." +--- + # `json_tuple` diff --git a/docs/reference/sql/functions/kll_merge_agg_bigint.md b/docs/reference/sql/functions/kll_merge_agg_bigint.md index 1941611b5..8b85cbd65 100644 --- a/docs/reference/sql/functions/kll_merge_agg_bigint.md +++ b/docs/reference/sql/functions/kll_merge_agg_bigint.md @@ -1,3 +1,7 @@ +--- +description: "Merges binary KllLongsSketch representations and returns the merged sketch." +--- + # `kll_merge_agg_bigint` diff --git a/docs/reference/sql/functions/kll_merge_agg_double.md b/docs/reference/sql/functions/kll_merge_agg_double.md index b1a85de50..767081bd7 100644 --- a/docs/reference/sql/functions/kll_merge_agg_double.md +++ b/docs/reference/sql/functions/kll_merge_agg_double.md @@ -1,3 +1,7 @@ +--- +description: "Merges binary KllDoublesSketch representations and returns the merged sketch." +--- + # `kll_merge_agg_double` diff --git a/docs/reference/sql/functions/kll_merge_agg_float.md b/docs/reference/sql/functions/kll_merge_agg_float.md index b5bfaea89..ae59bb4de 100644 --- a/docs/reference/sql/functions/kll_merge_agg_float.md +++ b/docs/reference/sql/functions/kll_merge_agg_float.md @@ -1,3 +1,7 @@ +--- +description: "Merges binary KllFloatsSketch representations and returns the merged sketch." +--- + # `kll_merge_agg_float` diff --git a/docs/reference/sql/functions/kll_sketch_agg_bigint.md b/docs/reference/sql/functions/kll_sketch_agg_bigint.md index b6277be92..18c3d1e6b 100644 --- a/docs/reference/sql/functions/kll_sketch_agg_bigint.md +++ b/docs/reference/sql/functions/kll_sketch_agg_bigint.md @@ -1,3 +1,7 @@ +--- +description: "Returns the KllLongsSketch compact binary representation." +--- + # `kll_sketch_agg_bigint` diff --git a/docs/reference/sql/functions/kll_sketch_agg_double.md b/docs/reference/sql/functions/kll_sketch_agg_double.md index 03a39e73f..6c78854b1 100644 --- a/docs/reference/sql/functions/kll_sketch_agg_double.md +++ b/docs/reference/sql/functions/kll_sketch_agg_double.md @@ -1,3 +1,7 @@ +--- +description: "Returns the KllDoublesSketch compact binary representation." +--- + # `kll_sketch_agg_double` diff --git a/docs/reference/sql/functions/kll_sketch_agg_float.md b/docs/reference/sql/functions/kll_sketch_agg_float.md index 3c004eade..23aafb08a 100644 --- a/docs/reference/sql/functions/kll_sketch_agg_float.md +++ b/docs/reference/sql/functions/kll_sketch_agg_float.md @@ -1,3 +1,7 @@ +--- +description: "Returns the KllFloatsSketch compact binary representation." +--- + # `kll_sketch_agg_float` diff --git a/docs/reference/sql/functions/kll_sketch_get_n_bigint.md b/docs/reference/sql/functions/kll_sketch_get_n_bigint.md index a20f422d5..c62e4b120 100644 --- a/docs/reference/sql/functions/kll_sketch_get_n_bigint.md +++ b/docs/reference/sql/functions/kll_sketch_get_n_bigint.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of items collected in the sketch." +--- + # `kll_sketch_get_n_bigint` diff --git a/docs/reference/sql/functions/kll_sketch_get_n_double.md b/docs/reference/sql/functions/kll_sketch_get_n_double.md index 8b74cb7b3..7aaf6dce7 100644 --- a/docs/reference/sql/functions/kll_sketch_get_n_double.md +++ b/docs/reference/sql/functions/kll_sketch_get_n_double.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of items collected in the sketch." +--- + # `kll_sketch_get_n_double` diff --git a/docs/reference/sql/functions/kll_sketch_get_n_float.md b/docs/reference/sql/functions/kll_sketch_get_n_float.md index b53c77a5a..d493c273e 100644 --- a/docs/reference/sql/functions/kll_sketch_get_n_float.md +++ b/docs/reference/sql/functions/kll_sketch_get_n_float.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of items collected in the sketch." +--- + # `kll_sketch_get_n_float` diff --git a/docs/reference/sql/functions/kll_sketch_get_quantile_bigint.md b/docs/reference/sql/functions/kll_sketch_get_quantile_bigint.md index 31b86fc7f..b1325dd6e 100644 --- a/docs/reference/sql/functions/kll_sketch_get_quantile_bigint.md +++ b/docs/reference/sql/functions/kll_sketch_get_quantile_bigint.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a single value from the quantiles sketch representing the desired quantile given the input rank." +--- + # `kll_sketch_get_quantile_bigint` diff --git a/docs/reference/sql/functions/kll_sketch_get_quantile_double.md b/docs/reference/sql/functions/kll_sketch_get_quantile_double.md index c2a35d825..d8f6b7517 100644 --- a/docs/reference/sql/functions/kll_sketch_get_quantile_double.md +++ b/docs/reference/sql/functions/kll_sketch_get_quantile_double.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a single value from the quantiles sketch representing the desired quantile given the input rank." +--- + # `kll_sketch_get_quantile_double` diff --git a/docs/reference/sql/functions/kll_sketch_get_quantile_float.md b/docs/reference/sql/functions/kll_sketch_get_quantile_float.md index f0fd787c5..76876dbb9 100644 --- a/docs/reference/sql/functions/kll_sketch_get_quantile_float.md +++ b/docs/reference/sql/functions/kll_sketch_get_quantile_float.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a single value from the quantiles sketch representing the desired quantile given the input rank." +--- + # `kll_sketch_get_quantile_float` diff --git a/docs/reference/sql/functions/kll_sketch_get_rank_bigint.md b/docs/reference/sql/functions/kll_sketch_get_rank_bigint.md index 8e7d0a630..2c0df415e 100644 --- a/docs/reference/sql/functions/kll_sketch_get_rank_bigint.md +++ b/docs/reference/sql/functions/kll_sketch_get_rank_bigint.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a single value from the quantiles sketch representing the desired rank given the input quantile." +--- + # `kll_sketch_get_rank_bigint` diff --git a/docs/reference/sql/functions/kll_sketch_get_rank_double.md b/docs/reference/sql/functions/kll_sketch_get_rank_double.md index e414c7b7f..59613620c 100644 --- a/docs/reference/sql/functions/kll_sketch_get_rank_double.md +++ b/docs/reference/sql/functions/kll_sketch_get_rank_double.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a single value from the quantiles sketch representing the desired rank given the input quantile." +--- + # `kll_sketch_get_rank_double` diff --git a/docs/reference/sql/functions/kll_sketch_get_rank_float.md b/docs/reference/sql/functions/kll_sketch_get_rank_float.md index cdf2738d1..f470aabef 100644 --- a/docs/reference/sql/functions/kll_sketch_get_rank_float.md +++ b/docs/reference/sql/functions/kll_sketch_get_rank_float.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a single value from the quantiles sketch representing the desired rank given the input quantile." +--- + # `kll_sketch_get_rank_float` diff --git a/docs/reference/sql/functions/kll_sketch_merge_bigint.md b/docs/reference/sql/functions/kll_sketch_merge_bigint.md index 2321a0103..5c6f9cb8e 100644 --- a/docs/reference/sql/functions/kll_sketch_merge_bigint.md +++ b/docs/reference/sql/functions/kll_sketch_merge_bigint.md @@ -1,3 +1,7 @@ +--- +description: "Merges two sketch buffers together into one." +--- + # `kll_sketch_merge_bigint` diff --git a/docs/reference/sql/functions/kll_sketch_merge_double.md b/docs/reference/sql/functions/kll_sketch_merge_double.md index 03f2537d4..0421dbc35 100644 --- a/docs/reference/sql/functions/kll_sketch_merge_double.md +++ b/docs/reference/sql/functions/kll_sketch_merge_double.md @@ -1,3 +1,7 @@ +--- +description: "Merges two sketch buffers together into one." +--- + # `kll_sketch_merge_double` diff --git a/docs/reference/sql/functions/kll_sketch_merge_float.md b/docs/reference/sql/functions/kll_sketch_merge_float.md index 0ef492e28..3e2ebca67 100644 --- a/docs/reference/sql/functions/kll_sketch_merge_float.md +++ b/docs/reference/sql/functions/kll_sketch_merge_float.md @@ -1,3 +1,7 @@ +--- +description: "Merges two sketch buffers together into one." +--- + # `kll_sketch_merge_float` diff --git a/docs/reference/sql/functions/kll_sketch_to_string_bigint.md b/docs/reference/sql/functions/kll_sketch_to_string_bigint.md index 0756e8a5e..b1d59a00d 100644 --- a/docs/reference/sql/functions/kll_sketch_to_string_bigint.md +++ b/docs/reference/sql/functions/kll_sketch_to_string_bigint.md @@ -1,3 +1,7 @@ +--- +description: "Returns human readable summary information about this sketch." +--- + # `kll_sketch_to_string_bigint` diff --git a/docs/reference/sql/functions/kll_sketch_to_string_double.md b/docs/reference/sql/functions/kll_sketch_to_string_double.md index 122ab3721..642a675ac 100644 --- a/docs/reference/sql/functions/kll_sketch_to_string_double.md +++ b/docs/reference/sql/functions/kll_sketch_to_string_double.md @@ -1,3 +1,7 @@ +--- +description: "Returns human readable summary information about this sketch." +--- + # `kll_sketch_to_string_double` diff --git a/docs/reference/sql/functions/kll_sketch_to_string_float.md b/docs/reference/sql/functions/kll_sketch_to_string_float.md index 453496eb7..cc25fc203 100644 --- a/docs/reference/sql/functions/kll_sketch_to_string_float.md +++ b/docs/reference/sql/functions/kll_sketch_to_string_float.md @@ -1,3 +1,7 @@ +--- +description: "Returns human readable summary information about this sketch." +--- + # `kll_sketch_to_string_float` diff --git a/docs/reference/sql/functions/kurtosis.md b/docs/reference/sql/functions/kurtosis.md index 03bc693fd..e193bfcb5 100644 --- a/docs/reference/sql/functions/kurtosis.md +++ b/docs/reference/sql/functions/kurtosis.md @@ -1,3 +1,7 @@ +--- +description: "Returns the kurtosis value calculated from values of a group." +--- + # `kurtosis` diff --git a/docs/reference/sql/functions/lag.md b/docs/reference/sql/functions/lag.md index a8bd022ca..478ebe8e7 100644 --- a/docs/reference/sql/functions/lag.md +++ b/docs/reference/sql/functions/lag.md @@ -1,3 +1,7 @@ +--- +description: "Returns the value of `input` at the `offset`th row before the current row in the window." +--- + # `lag` diff --git a/docs/reference/sql/functions/last.md b/docs/reference/sql/functions/last.md index 95907364b..2e37c2771 100644 --- a/docs/reference/sql/functions/last.md +++ b/docs/reference/sql/functions/last.md @@ -1,3 +1,7 @@ +--- +description: "Returns the last value of `expr` for a group of rows." +--- + # `last` diff --git a/docs/reference/sql/functions/last_day.md b/docs/reference/sql/functions/last_day.md index a3b0c4056..299f974d2 100644 --- a/docs/reference/sql/functions/last_day.md +++ b/docs/reference/sql/functions/last_day.md @@ -1,3 +1,7 @@ +--- +description: "Returns the last day of the month which the date belongs to." +--- + # `last_day` diff --git a/docs/reference/sql/functions/last_value.md b/docs/reference/sql/functions/last_value.md index 648d664f3..bee1b642c 100644 --- a/docs/reference/sql/functions/last_value.md +++ b/docs/reference/sql/functions/last_value.md @@ -1,3 +1,7 @@ +--- +description: "Returns the last value of `expr` for a group of rows." +--- + # `last_value` diff --git a/docs/reference/sql/functions/lcase.md b/docs/reference/sql/functions/lcase.md index 3c30db5fe..2c990c379 100644 --- a/docs/reference/sql/functions/lcase.md +++ b/docs/reference/sql/functions/lcase.md @@ -1,3 +1,7 @@ +--- +description: "Returns `str` with all characters changed to lowercase." +--- + # `lcase` diff --git a/docs/reference/sql/functions/lead.md b/docs/reference/sql/functions/lead.md index 169cd2895..1a4ea7bcd 100644 --- a/docs/reference/sql/functions/lead.md +++ b/docs/reference/sql/functions/lead.md @@ -1,3 +1,7 @@ +--- +description: "Returns the value of `input` at the `offset`th row after the current row in the window." +--- + # `lead` diff --git a/docs/reference/sql/functions/least.md b/docs/reference/sql/functions/least.md index 5c0fd6635..42ebdb3f8 100644 --- a/docs/reference/sql/functions/least.md +++ b/docs/reference/sql/functions/least.md @@ -1,3 +1,7 @@ +--- +description: "Returns the least value of all parameters, skipping null values." +--- + # `least` diff --git a/docs/reference/sql/functions/left.md b/docs/reference/sql/functions/left.md index ac0ee2910..fd73c0f95 100644 --- a/docs/reference/sql/functions/left.md +++ b/docs/reference/sql/functions/left.md @@ -1,3 +1,7 @@ +--- +description: "Returns the leftmost `len`(`len` can be string type) characters from the string `str`,if `len` is less or equal than 0 the result is an empty string." +--- + # `left` diff --git a/docs/reference/sql/functions/len.md b/docs/reference/sql/functions/len.md index 5faba6356..ee5a60c67 100644 --- a/docs/reference/sql/functions/len.md +++ b/docs/reference/sql/functions/len.md @@ -1,3 +1,7 @@ +--- +description: "Returns the character length of string data or number of bytes of binary data." +--- + # `len` diff --git a/docs/reference/sql/functions/length.md b/docs/reference/sql/functions/length.md index 3afad90e7..a60567e48 100644 --- a/docs/reference/sql/functions/length.md +++ b/docs/reference/sql/functions/length.md @@ -1,3 +1,7 @@ +--- +description: "Returns the character length of string data or number of bytes of binary data." +--- + # `length` diff --git a/docs/reference/sql/functions/levenshtein.md b/docs/reference/sql/functions/levenshtein.md index f2c7cc4d1..d2ab3b5ce 100644 --- a/docs/reference/sql/functions/levenshtein.md +++ b/docs/reference/sql/functions/levenshtein.md @@ -1,3 +1,7 @@ +--- +description: "Returns the Levenshtein distance between the two given strings." +--- + # `levenshtein` diff --git a/docs/reference/sql/functions/like.md b/docs/reference/sql/functions/like.md index 9a36c2f01..852d463dd 100644 --- a/docs/reference/sql/functions/like.md +++ b/docs/reference/sql/functions/like.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if str matches `pattern` with `escape`, null if any arguments are null, false otherwise." +--- + # `like` diff --git a/docs/reference/sql/functions/listagg.md b/docs/reference/sql/functions/listagg.md index dbeed8310..6292aa2c8 100644 --- a/docs/reference/sql/functions/listagg.md +++ b/docs/reference/sql/functions/listagg.md @@ -1,3 +1,7 @@ +--- +description: "Returns the concatenation of non-NULL input values, separated by the delimiter ordered by key." +--- + # `listagg` diff --git a/docs/reference/sql/functions/ln.md b/docs/reference/sql/functions/ln.md index 36967e410..a559eb487 100644 --- a/docs/reference/sql/functions/ln.md +++ b/docs/reference/sql/functions/ln.md @@ -1,3 +1,7 @@ +--- +description: "Returns the natural logarithm (base e) of `expr`." +--- + # `ln` diff --git a/docs/reference/sql/functions/localtimestamp.md b/docs/reference/sql/functions/localtimestamp.md index 37be2b68e..7c7e1affc 100644 --- a/docs/reference/sql/functions/localtimestamp.md +++ b/docs/reference/sql/functions/localtimestamp.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current timestamp without time zone at the start of query evaluation." +--- + # `localtimestamp` diff --git a/docs/reference/sql/functions/locate.md b/docs/reference/sql/functions/locate.md index 5036ff6ab..fc4e11ce3 100644 --- a/docs/reference/sql/functions/locate.md +++ b/docs/reference/sql/functions/locate.md @@ -1,3 +1,7 @@ +--- +description: "Returns the position of the first occurrence of `substr` in `str` after position `pos`." +--- + # `locate` diff --git a/docs/reference/sql/functions/log.md b/docs/reference/sql/functions/log.md index 9093e53c9..6aee0e59d 100644 --- a/docs/reference/sql/functions/log.md +++ b/docs/reference/sql/functions/log.md @@ -1,3 +1,7 @@ +--- +description: "Returns the logarithm of `expr` with `base`." +--- + # `log` diff --git a/docs/reference/sql/functions/log10.md b/docs/reference/sql/functions/log10.md index f9eb968e8..d52887276 100644 --- a/docs/reference/sql/functions/log10.md +++ b/docs/reference/sql/functions/log10.md @@ -1,3 +1,7 @@ +--- +description: "Returns the logarithm of `expr` with base 10." +--- + # `log10` diff --git a/docs/reference/sql/functions/log1p.md b/docs/reference/sql/functions/log1p.md index 6156d66d1..a39763486 100644 --- a/docs/reference/sql/functions/log1p.md +++ b/docs/reference/sql/functions/log1p.md @@ -1,3 +1,7 @@ +--- +description: "Returns log(1 + `expr`)." +--- + # `log1p` diff --git a/docs/reference/sql/functions/log2.md b/docs/reference/sql/functions/log2.md index 0bba3164f..2e6fc7a3e 100644 --- a/docs/reference/sql/functions/log2.md +++ b/docs/reference/sql/functions/log2.md @@ -1,3 +1,7 @@ +--- +description: "Returns the logarithm of `expr` with base 2." +--- + # `log2` diff --git a/docs/reference/sql/functions/lower.md b/docs/reference/sql/functions/lower.md index d2a935b1e..7aac3a174 100644 --- a/docs/reference/sql/functions/lower.md +++ b/docs/reference/sql/functions/lower.md @@ -1,3 +1,7 @@ +--- +description: "Returns `str` with all characters changed to lowercase." +--- + # `lower` diff --git a/docs/reference/sql/functions/lpad.md b/docs/reference/sql/functions/lpad.md index 3fa6d6179..f119b1999 100644 --- a/docs/reference/sql/functions/lpad.md +++ b/docs/reference/sql/functions/lpad.md @@ -1,3 +1,7 @@ +--- +description: "Returns `str`, left-padded with `pad` to a length of `len`." +--- + # `lpad` diff --git a/docs/reference/sql/functions/ltrim.md b/docs/reference/sql/functions/ltrim.md index da197250c..c51dbbbf8 100644 --- a/docs/reference/sql/functions/ltrim.md +++ b/docs/reference/sql/functions/ltrim.md @@ -1,3 +1,7 @@ +--- +description: "Removes the leading space characters from `str`." +--- + # `ltrim` diff --git a/docs/reference/sql/functions/luhn_check.md b/docs/reference/sql/functions/luhn_check.md index 6678ffe0c..aa463d979 100644 --- a/docs/reference/sql/functions/luhn_check.md +++ b/docs/reference/sql/functions/luhn_check.md @@ -1,3 +1,7 @@ +--- +description: "Checks that a string of digits is valid according to the Luhn algorithm." +--- + # `luhn_check` diff --git a/docs/reference/sql/functions/make_date.md b/docs/reference/sql/functions/make_date.md index 0b8f1358c..91ef43a2f 100644 --- a/docs/reference/sql/functions/make_date.md +++ b/docs/reference/sql/functions/make_date.md @@ -1,3 +1,7 @@ +--- +description: "Create date from year, month and day fields." +--- + # `make_date` diff --git a/docs/reference/sql/functions/make_dt_interval.md b/docs/reference/sql/functions/make_dt_interval.md index 360a0f94c..14ece0af3 100644 --- a/docs/reference/sql/functions/make_dt_interval.md +++ b/docs/reference/sql/functions/make_dt_interval.md @@ -1,3 +1,7 @@ +--- +description: "Make DayTimeIntervalType duration from days, hours, mins and secs." +--- + # `make_dt_interval` diff --git a/docs/reference/sql/functions/make_interval.md b/docs/reference/sql/functions/make_interval.md index 13a85e2b6..98916f1e6 100644 --- a/docs/reference/sql/functions/make_interval.md +++ b/docs/reference/sql/functions/make_interval.md @@ -1,3 +1,7 @@ +--- +description: "Make interval from years, months, weeks, days, hours, mins and secs." +--- + # `make_interval` diff --git a/docs/reference/sql/functions/make_time.md b/docs/reference/sql/functions/make_time.md index a49820184..db78cded4 100644 --- a/docs/reference/sql/functions/make_time.md +++ b/docs/reference/sql/functions/make_time.md @@ -1,3 +1,7 @@ +--- +description: "Create time from hour, minute and second fields." +--- + # `make_time` diff --git a/docs/reference/sql/functions/make_timestamp.md b/docs/reference/sql/functions/make_timestamp.md index 3732d0eab..85725553a 100644 --- a/docs/reference/sql/functions/make_timestamp.md +++ b/docs/reference/sql/functions/make_timestamp.md @@ -1,3 +1,7 @@ +--- +description: "Create the current timestamp with local time zone from year, month, day, hour, min, sec and timezone fields." +--- + # `make_timestamp` diff --git a/docs/reference/sql/functions/make_timestamp_ltz.md b/docs/reference/sql/functions/make_timestamp_ltz.md index 63f56e589..bd0bc4430 100644 --- a/docs/reference/sql/functions/make_timestamp_ltz.md +++ b/docs/reference/sql/functions/make_timestamp_ltz.md @@ -1,3 +1,7 @@ +--- +description: "Create the current timestamp with local time zone from year, month, day, hour, min, sec and (optional) timezone fields." +--- + # `make_timestamp_ltz` diff --git a/docs/reference/sql/functions/make_timestamp_ntz.md b/docs/reference/sql/functions/make_timestamp_ntz.md index 8d3c72647..c79c72926 100644 --- a/docs/reference/sql/functions/make_timestamp_ntz.md +++ b/docs/reference/sql/functions/make_timestamp_ntz.md @@ -1,3 +1,7 @@ +--- +description: "Create local date-time from year, month, day, hour, min, sec fields." +--- + # `make_timestamp_ntz` diff --git a/docs/reference/sql/functions/make_valid_utf8.md b/docs/reference/sql/functions/make_valid_utf8.md index 63fdc09a1..2bc42ff44 100644 --- a/docs/reference/sql/functions/make_valid_utf8.md +++ b/docs/reference/sql/functions/make_valid_utf8.md @@ -1,3 +1,7 @@ +--- +description: "Returns the original string if `str` is a valid UTF-8 string, otherwise returns a new string whose invalid UTF8 byte sequences are replaced using the UNICODE replacement character U+FFFD." +--- + # `make_valid_utf8` diff --git a/docs/reference/sql/functions/make_ym_interval.md b/docs/reference/sql/functions/make_ym_interval.md index 3f8f244a7..2115edb92 100644 --- a/docs/reference/sql/functions/make_ym_interval.md +++ b/docs/reference/sql/functions/make_ym_interval.md @@ -1,3 +1,7 @@ +--- +description: "Make year-month interval from years, months." +--- + # `make_ym_interval` diff --git a/docs/reference/sql/functions/map.md b/docs/reference/sql/functions/map.md index 2da87ef19..72935b7e7 100644 --- a/docs/reference/sql/functions/map.md +++ b/docs/reference/sql/functions/map.md @@ -1,3 +1,7 @@ +--- +description: "Creates a map with the given key/value pairs." +--- + # `map` diff --git a/docs/reference/sql/functions/map_concat.md b/docs/reference/sql/functions/map_concat.md index 88b71901d..27312e22b 100644 --- a/docs/reference/sql/functions/map_concat.md +++ b/docs/reference/sql/functions/map_concat.md @@ -1,3 +1,7 @@ +--- +description: "Returns the union of all the given maps" +--- + # `map_concat` diff --git a/docs/reference/sql/functions/map_contains_key.md b/docs/reference/sql/functions/map_contains_key.md index 74ff964b8..93ab0337b 100644 --- a/docs/reference/sql/functions/map_contains_key.md +++ b/docs/reference/sql/functions/map_contains_key.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if the map contains the key." +--- + # `map_contains_key` diff --git a/docs/reference/sql/functions/map_entries.md b/docs/reference/sql/functions/map_entries.md index 9ab45b90b..c48cfed12 100644 --- a/docs/reference/sql/functions/map_entries.md +++ b/docs/reference/sql/functions/map_entries.md @@ -1,3 +1,7 @@ +--- +description: "Returns an unordered array of all entries in the given map." +--- + # `map_entries` diff --git a/docs/reference/sql/functions/map_filter.md b/docs/reference/sql/functions/map_filter.md index 0109dd152..0a353c4f2 100644 --- a/docs/reference/sql/functions/map_filter.md +++ b/docs/reference/sql/functions/map_filter.md @@ -1,3 +1,7 @@ +--- +description: "Filters entries in a map using the function." +--- + # `map_filter` diff --git a/docs/reference/sql/functions/map_from_arrays.md b/docs/reference/sql/functions/map_from_arrays.md index e49f67894..1b696801f 100644 --- a/docs/reference/sql/functions/map_from_arrays.md +++ b/docs/reference/sql/functions/map_from_arrays.md @@ -1,3 +1,7 @@ +--- +description: "Creates a map with a pair of the given key/value arrays." +--- + # `map_from_arrays` diff --git a/docs/reference/sql/functions/map_from_entries.md b/docs/reference/sql/functions/map_from_entries.md index d09def31f..7aa75d52a 100644 --- a/docs/reference/sql/functions/map_from_entries.md +++ b/docs/reference/sql/functions/map_from_entries.md @@ -1,3 +1,7 @@ +--- +description: "Returns a map created from the given array of entries." +--- + # `map_from_entries` diff --git a/docs/reference/sql/functions/map_keys.md b/docs/reference/sql/functions/map_keys.md index ab2fd4a9f..edc7f94e6 100644 --- a/docs/reference/sql/functions/map_keys.md +++ b/docs/reference/sql/functions/map_keys.md @@ -1,3 +1,7 @@ +--- +description: "Returns an unordered array containing the keys of the map." +--- + # `map_keys` diff --git a/docs/reference/sql/functions/map_values.md b/docs/reference/sql/functions/map_values.md index 0cbdfda67..fdd31b931 100644 --- a/docs/reference/sql/functions/map_values.md +++ b/docs/reference/sql/functions/map_values.md @@ -1,3 +1,7 @@ +--- +description: "Returns an unordered array containing the values of the map." +--- + # `map_values` diff --git a/docs/reference/sql/functions/map_zip_with.md b/docs/reference/sql/functions/map_zip_with.md index c7ebe07ef..327b0bac8 100644 --- a/docs/reference/sql/functions/map_zip_with.md +++ b/docs/reference/sql/functions/map_zip_with.md @@ -1,3 +1,7 @@ +--- +description: "Merges two given maps into a single map by applying function to the pair of values with the same key." +--- + # `map_zip_with` diff --git a/docs/reference/sql/functions/mask.md b/docs/reference/sql/functions/mask.md index 2e4f2248b..5ac49537c 100644 --- a/docs/reference/sql/functions/mask.md +++ b/docs/reference/sql/functions/mask.md @@ -1,3 +1,7 @@ +--- +description: "masks the given string value." +--- + # `mask` diff --git a/docs/reference/sql/functions/max.md b/docs/reference/sql/functions/max.md index a1374d9d6..ac0217c76 100644 --- a/docs/reference/sql/functions/max.md +++ b/docs/reference/sql/functions/max.md @@ -1,3 +1,7 @@ +--- +description: "Returns the maximum value of `expr`." +--- + # `max` diff --git a/docs/reference/sql/functions/max_by.md b/docs/reference/sql/functions/max_by.md index 07084860d..6336e5974 100644 --- a/docs/reference/sql/functions/max_by.md +++ b/docs/reference/sql/functions/max_by.md @@ -1,3 +1,7 @@ +--- +description: "Returns the value of `x` associated with the maximum value of `y`." +--- + # `max_by` diff --git a/docs/reference/sql/functions/md5.md b/docs/reference/sql/functions/md5.md index ce5f7c670..a7c99126e 100644 --- a/docs/reference/sql/functions/md5.md +++ b/docs/reference/sql/functions/md5.md @@ -1,3 +1,7 @@ +--- +description: "Returns an MD5 128-bit checksum as a hex string of `expr`." +--- + # `md5` diff --git a/docs/reference/sql/functions/mean.md b/docs/reference/sql/functions/mean.md index c2b826b0d..e3911e67a 100644 --- a/docs/reference/sql/functions/mean.md +++ b/docs/reference/sql/functions/mean.md @@ -1,3 +1,7 @@ +--- +description: "Returns the mean calculated from values of a group." +--- + # `mean` diff --git a/docs/reference/sql/functions/measure.md b/docs/reference/sql/functions/measure.md index b72674269..79ffd4b04 100644 --- a/docs/reference/sql/functions/measure.md +++ b/docs/reference/sql/functions/measure.md @@ -1,3 +1,7 @@ +--- +description: "this function is used and can only be used to calculate a measure defined in a metric view." +--- + # `measure` diff --git a/docs/reference/sql/functions/median.md b/docs/reference/sql/functions/median.md index c27aa77dc..b9fd02253 100644 --- a/docs/reference/sql/functions/median.md +++ b/docs/reference/sql/functions/median.md @@ -1,3 +1,7 @@ +--- +description: "Returns the median of numeric or ANSI interval column `col`." +--- + # `median` diff --git a/docs/reference/sql/functions/min.md b/docs/reference/sql/functions/min.md index fe5550175..c13c4c80a 100644 --- a/docs/reference/sql/functions/min.md +++ b/docs/reference/sql/functions/min.md @@ -1,3 +1,7 @@ +--- +description: "Returns the minimum value of `expr`." +--- + # `min` diff --git a/docs/reference/sql/functions/min_by.md b/docs/reference/sql/functions/min_by.md index 6f6343026..e90977375 100644 --- a/docs/reference/sql/functions/min_by.md +++ b/docs/reference/sql/functions/min_by.md @@ -1,3 +1,7 @@ +--- +description: "Returns the value of `x` associated with the minimum value of `y`." +--- + # `min_by` diff --git a/docs/reference/sql/functions/minute.md b/docs/reference/sql/functions/minute.md index 4bfde85bf..1727fe869 100644 --- a/docs/reference/sql/functions/minute.md +++ b/docs/reference/sql/functions/minute.md @@ -1,3 +1,7 @@ +--- +description: "Returns the minute component of the given expression." +--- + # `minute` diff --git a/docs/reference/sql/functions/mod.md b/docs/reference/sql/functions/mod.md index 91b5e8fb3..b4a337f7b 100644 --- a/docs/reference/sql/functions/mod.md +++ b/docs/reference/sql/functions/mod.md @@ -1,3 +1,7 @@ +--- +description: "Returns the remainder after `expr1`/`expr2`." +--- + # `mod` diff --git a/docs/reference/sql/functions/mode.md b/docs/reference/sql/functions/mode.md index 75b6713ec..74334d245 100644 --- a/docs/reference/sql/functions/mode.md +++ b/docs/reference/sql/functions/mode.md @@ -1,3 +1,7 @@ +--- +description: "Returns the most frequent value for the values within `col`." +--- + # `mode` diff --git a/docs/reference/sql/functions/monotonically_increasing_id.md b/docs/reference/sql/functions/monotonically_increasing_id.md index 8c42aa19b..22b11c614 100644 --- a/docs/reference/sql/functions/monotonically_increasing_id.md +++ b/docs/reference/sql/functions/monotonically_increasing_id.md @@ -1,3 +1,7 @@ +--- +description: "Returns monotonically increasing 64-bit integers." +--- + # `monotonically_increasing_id` diff --git a/docs/reference/sql/functions/month.md b/docs/reference/sql/functions/month.md index f9c202c84..cf77d1778 100644 --- a/docs/reference/sql/functions/month.md +++ b/docs/reference/sql/functions/month.md @@ -1,3 +1,7 @@ +--- +description: "Returns the month component of the date/timestamp." +--- + # `month` diff --git a/docs/reference/sql/functions/monthname.md b/docs/reference/sql/functions/monthname.md index fdf21ed5b..4545d0495 100644 --- a/docs/reference/sql/functions/monthname.md +++ b/docs/reference/sql/functions/monthname.md @@ -1,3 +1,7 @@ +--- +description: "Returns the three-letter abbreviated month name from the given date." +--- + # `monthname` diff --git a/docs/reference/sql/functions/months_between.md b/docs/reference/sql/functions/months_between.md index 439bf8b9e..258e0d6db 100644 --- a/docs/reference/sql/functions/months_between.md +++ b/docs/reference/sql/functions/months_between.md @@ -1,3 +1,7 @@ +--- +description: "If `timestamp1` is later than `timestamp2`, then the result is positive." +--- + # `months_between` diff --git a/docs/reference/sql/functions/named_struct.md b/docs/reference/sql/functions/named_struct.md index 21f32d35a..92563c515 100644 --- a/docs/reference/sql/functions/named_struct.md +++ b/docs/reference/sql/functions/named_struct.md @@ -1,3 +1,7 @@ +--- +description: "Creates a struct with the given field names and values." +--- + # `named_struct` diff --git a/docs/reference/sql/functions/nanvl.md b/docs/reference/sql/functions/nanvl.md index acd97b0b3..0e6a63917 100644 --- a/docs/reference/sql/functions/nanvl.md +++ b/docs/reference/sql/functions/nanvl.md @@ -1,3 +1,7 @@ +--- +description: "Returns `expr1` if it's not NaN, or `expr2` otherwise." +--- + # `nanvl` diff --git a/docs/reference/sql/functions/negative.md b/docs/reference/sql/functions/negative.md index 070a71ccf..8b793c70a 100644 --- a/docs/reference/sql/functions/negative.md +++ b/docs/reference/sql/functions/negative.md @@ -1,3 +1,7 @@ +--- +description: "Returns the negated value of `expr`." +--- + # `negative` diff --git a/docs/reference/sql/functions/next_day.md b/docs/reference/sql/functions/next_day.md index 79bf65cbd..0dc2c82c3 100644 --- a/docs/reference/sql/functions/next_day.md +++ b/docs/reference/sql/functions/next_day.md @@ -1,3 +1,7 @@ +--- +description: "Returns the first date which is later than `start_date` and named as indicated." +--- + # `next_day` diff --git a/docs/reference/sql/functions/not.md b/docs/reference/sql/functions/not.md index 07a0ef79f..9cb9f52e0 100644 --- a/docs/reference/sql/functions/not.md +++ b/docs/reference/sql/functions/not.md @@ -1,3 +1,7 @@ +--- +description: "Logical not." +--- + # `not` diff --git a/docs/reference/sql/functions/now.md b/docs/reference/sql/functions/now.md index 5d6f31187..b0d825a47 100644 --- a/docs/reference/sql/functions/now.md +++ b/docs/reference/sql/functions/now.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current timestamp at the start of query evaluation." +--- + # `now` diff --git a/docs/reference/sql/functions/nth_value.md b/docs/reference/sql/functions/nth_value.md index 5a206f86b..9720c350c 100644 --- a/docs/reference/sql/functions/nth_value.md +++ b/docs/reference/sql/functions/nth_value.md @@ -1,3 +1,7 @@ +--- +description: "Returns the value of `input` at the row that is the `offset`th row from beginning of the window frame." +--- + # `nth_value` diff --git a/docs/reference/sql/functions/ntile.md b/docs/reference/sql/functions/ntile.md index 0718bc5dc..203b2ced6 100644 --- a/docs/reference/sql/functions/ntile.md +++ b/docs/reference/sql/functions/ntile.md @@ -1,3 +1,7 @@ +--- +description: "Divides the rows for each window partition into `n` buckets ranging from 1 to at most `n`." +--- + # `ntile` diff --git a/docs/reference/sql/functions/nullif.md b/docs/reference/sql/functions/nullif.md index 079721ddc..2467122f6 100644 --- a/docs/reference/sql/functions/nullif.md +++ b/docs/reference/sql/functions/nullif.md @@ -1,3 +1,7 @@ +--- +description: "Returns null if `expr1` equals to `expr2`, or `expr1` otherwise." +--- + # `nullif` diff --git a/docs/reference/sql/functions/nullifzero.md b/docs/reference/sql/functions/nullifzero.md index 2c5c212c0..1ce8410d0 100644 --- a/docs/reference/sql/functions/nullifzero.md +++ b/docs/reference/sql/functions/nullifzero.md @@ -1,3 +1,7 @@ +--- +description: "Returns null if `expr` is equal to zero, or `expr` otherwise." +--- + # `nullifzero` diff --git a/docs/reference/sql/functions/nvl.md b/docs/reference/sql/functions/nvl.md index 4b8797cd5..188b2e52f 100644 --- a/docs/reference/sql/functions/nvl.md +++ b/docs/reference/sql/functions/nvl.md @@ -1,3 +1,7 @@ +--- +description: "Returns `expr2` if `expr1` is null, or `expr1` otherwise." +--- + # `nvl` diff --git a/docs/reference/sql/functions/nvl2.md b/docs/reference/sql/functions/nvl2.md index cc7ae2b92..9e1765cf9 100644 --- a/docs/reference/sql/functions/nvl2.md +++ b/docs/reference/sql/functions/nvl2.md @@ -1,3 +1,7 @@ +--- +description: "Returns `expr2` if `expr1` is not null, or `expr3` otherwise." +--- + # `nvl2` diff --git a/docs/reference/sql/functions/octet_length.md b/docs/reference/sql/functions/octet_length.md index 5ce70afbd..94c5a4a78 100644 --- a/docs/reference/sql/functions/octet_length.md +++ b/docs/reference/sql/functions/octet_length.md @@ -1,3 +1,7 @@ +--- +description: "Returns the byte length of string data or number of bytes of binary data." +--- + # `octet_length` diff --git a/docs/reference/sql/functions/op-amp.md b/docs/reference/sql/functions/op-amp.md index 63229792f..1cfe3f72a 100644 --- a/docs/reference/sql/functions/op-amp.md +++ b/docs/reference/sql/functions/op-amp.md @@ -1,3 +1,7 @@ +--- +description: "Returns the result of bitwise AND of `expr1` and `expr2`." +--- + # `&` diff --git a/docs/reference/sql/functions/op-bang-eq.md b/docs/reference/sql/functions/op-bang-eq.md index 5bfdf907d..894eee4c8 100644 --- a/docs/reference/sql/functions/op-bang-eq.md +++ b/docs/reference/sql/functions/op-bang-eq.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr1` is not equal to `expr2`." +--- + # `!=` diff --git a/docs/reference/sql/functions/op-bang.md b/docs/reference/sql/functions/op-bang.md index 02d7b451b..bae21ba29 100644 --- a/docs/reference/sql/functions/op-bang.md +++ b/docs/reference/sql/functions/op-bang.md @@ -1,3 +1,7 @@ +--- +description: "Logical not." +--- + # `!` diff --git a/docs/reference/sql/functions/op-caret.md b/docs/reference/sql/functions/op-caret.md index f87d3a40a..932da42bd 100644 --- a/docs/reference/sql/functions/op-caret.md +++ b/docs/reference/sql/functions/op-caret.md @@ -1,3 +1,7 @@ +--- +description: "Returns the result of bitwise exclusive OR of `expr1` and `expr2`." +--- + # `^` diff --git a/docs/reference/sql/functions/op-eq-eq.md b/docs/reference/sql/functions/op-eq-eq.md index c0e081994..48f9ce3f8 100644 --- a/docs/reference/sql/functions/op-eq-eq.md +++ b/docs/reference/sql/functions/op-eq-eq.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr1` equals `expr2`, or false otherwise." +--- + # `==` diff --git a/docs/reference/sql/functions/op-eq.md b/docs/reference/sql/functions/op-eq.md index e7042b553..b61a1879c 100644 --- a/docs/reference/sql/functions/op-eq.md +++ b/docs/reference/sql/functions/op-eq.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr1` equals `expr2`, or false otherwise." +--- + # `=` diff --git a/docs/reference/sql/functions/op-gt-eq.md b/docs/reference/sql/functions/op-gt-eq.md index 0d9f56427..367ca0a62 100644 --- a/docs/reference/sql/functions/op-gt-eq.md +++ b/docs/reference/sql/functions/op-gt-eq.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr1` is greater than or equal to `expr2`." +--- + # `>=` diff --git a/docs/reference/sql/functions/op-gt-gt-gt.md b/docs/reference/sql/functions/op-gt-gt-gt.md index b43316e8b..d1f07bad0 100644 --- a/docs/reference/sql/functions/op-gt-gt-gt.md +++ b/docs/reference/sql/functions/op-gt-gt-gt.md @@ -1,3 +1,7 @@ +--- +description: "Bitwise unsigned right shift." +--- + # `>>>` diff --git a/docs/reference/sql/functions/op-gt-gt.md b/docs/reference/sql/functions/op-gt-gt.md index 29c6c0c80..899e2455f 100644 --- a/docs/reference/sql/functions/op-gt-gt.md +++ b/docs/reference/sql/functions/op-gt-gt.md @@ -1,3 +1,7 @@ +--- +description: "Bitwise (signed) right shift." +--- + # `>>` diff --git a/docs/reference/sql/functions/op-gt.md b/docs/reference/sql/functions/op-gt.md index 564e04594..f09cdc43e 100644 --- a/docs/reference/sql/functions/op-gt.md +++ b/docs/reference/sql/functions/op-gt.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr1` is greater than `expr2`." +--- + # `>` diff --git a/docs/reference/sql/functions/op-lt-eq-gt.md b/docs/reference/sql/functions/op-lt-eq-gt.md index a634f67b0..a5894d576 100644 --- a/docs/reference/sql/functions/op-lt-eq-gt.md +++ b/docs/reference/sql/functions/op-lt-eq-gt.md @@ -1,3 +1,7 @@ +--- +description: "Returns same result as the EQUAL(=) operator for non-null operands, but returns true if both are null, false if one of the them is null." +--- + # `<=>` diff --git a/docs/reference/sql/functions/op-lt-eq.md b/docs/reference/sql/functions/op-lt-eq.md index 661ef5b1e..007135c70 100644 --- a/docs/reference/sql/functions/op-lt-eq.md +++ b/docs/reference/sql/functions/op-lt-eq.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr1` is less than or equal to `expr2`." +--- + # `<=` diff --git a/docs/reference/sql/functions/op-lt-gt.md b/docs/reference/sql/functions/op-lt-gt.md index 49c4b6e0a..d8723cc46 100644 --- a/docs/reference/sql/functions/op-lt-gt.md +++ b/docs/reference/sql/functions/op-lt-gt.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr1` is not equal to `expr2`." +--- + # `<>` diff --git a/docs/reference/sql/functions/op-lt-lt.md b/docs/reference/sql/functions/op-lt-lt.md index 4f3faca4c..51404d21b 100644 --- a/docs/reference/sql/functions/op-lt-lt.md +++ b/docs/reference/sql/functions/op-lt-lt.md @@ -1,3 +1,7 @@ +--- +description: "Bitwise left shift." +--- + # `<<` diff --git a/docs/reference/sql/functions/op-lt.md b/docs/reference/sql/functions/op-lt.md index 11a678480..89dad70e6 100644 --- a/docs/reference/sql/functions/op-lt.md +++ b/docs/reference/sql/functions/op-lt.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `expr1` is less than `expr2`." +--- + # `<` diff --git a/docs/reference/sql/functions/op-minus.md b/docs/reference/sql/functions/op-minus.md index 8e3180243..83e37b616 100644 --- a/docs/reference/sql/functions/op-minus.md +++ b/docs/reference/sql/functions/op-minus.md @@ -1,3 +1,7 @@ +--- +description: "expr2 - Returns `expr1`-`expr2`." +--- + # `-` diff --git a/docs/reference/sql/functions/op-percent.md b/docs/reference/sql/functions/op-percent.md index 601c477a5..b25c3f674 100644 --- a/docs/reference/sql/functions/op-percent.md +++ b/docs/reference/sql/functions/op-percent.md @@ -1,3 +1,7 @@ +--- +description: "Returns the remainder after `expr1`/`expr2`." +--- + # `%` diff --git a/docs/reference/sql/functions/op-pipe-pipe.md b/docs/reference/sql/functions/op-pipe-pipe.md index a68f57287..22c6c11ac 100644 --- a/docs/reference/sql/functions/op-pipe-pipe.md +++ b/docs/reference/sql/functions/op-pipe-pipe.md @@ -1,3 +1,7 @@ +--- +description: "Returns the concatenation of `expr1` and `expr2`." +--- + # `||` diff --git a/docs/reference/sql/functions/op-pipe.md b/docs/reference/sql/functions/op-pipe.md index 9d6b8dbfc..b31b73a97 100644 --- a/docs/reference/sql/functions/op-pipe.md +++ b/docs/reference/sql/functions/op-pipe.md @@ -1,3 +1,7 @@ +--- +description: "Returns the result of bitwise OR of `expr1` and `expr2`." +--- + # `|` diff --git a/docs/reference/sql/functions/op-plus.md b/docs/reference/sql/functions/op-plus.md index 261d90ee9..3a42cffcd 100644 --- a/docs/reference/sql/functions/op-plus.md +++ b/docs/reference/sql/functions/op-plus.md @@ -1,3 +1,7 @@ +--- +description: "Returns `expr1`+`expr2`." +--- + # `+` diff --git a/docs/reference/sql/functions/op-slash.md b/docs/reference/sql/functions/op-slash.md index dbfbf5f3a..a1f7053d6 100644 --- a/docs/reference/sql/functions/op-slash.md +++ b/docs/reference/sql/functions/op-slash.md @@ -1,3 +1,7 @@ +--- +description: "Returns `expr1`/`expr2`." +--- + # `/` diff --git a/docs/reference/sql/functions/op-star.md b/docs/reference/sql/functions/op-star.md index a679f5b19..6b55c5508 100644 --- a/docs/reference/sql/functions/op-star.md +++ b/docs/reference/sql/functions/op-star.md @@ -1,3 +1,7 @@ +--- +description: "Returns `expr1`*`expr2`." +--- + # `*` diff --git a/docs/reference/sql/functions/op-tilde.md b/docs/reference/sql/functions/op-tilde.md index cbba77e09..c84bbe687 100644 --- a/docs/reference/sql/functions/op-tilde.md +++ b/docs/reference/sql/functions/op-tilde.md @@ -1,3 +1,7 @@ +--- +description: "Returns the result of bitwise NOT of `expr`." +--- + # `~` diff --git a/docs/reference/sql/functions/or.md b/docs/reference/sql/functions/or.md index e66464b58..d63e0604e 100644 --- a/docs/reference/sql/functions/or.md +++ b/docs/reference/sql/functions/or.md @@ -1,3 +1,7 @@ +--- +description: "Logical OR." +--- + # `or` diff --git a/docs/reference/sql/functions/overlay.md b/docs/reference/sql/functions/overlay.md index 8e4ed54f9..2a25bbc97 100644 --- a/docs/reference/sql/functions/overlay.md +++ b/docs/reference/sql/functions/overlay.md @@ -1,3 +1,7 @@ +--- +description: "Replace `input` with `replace` that starts at `pos` and is of length `len`." +--- + # `overlay` diff --git a/docs/reference/sql/functions/parse_json.md b/docs/reference/sql/functions/parse_json.md index ec05a1692..1a718d1f4 100644 --- a/docs/reference/sql/functions/parse_json.md +++ b/docs/reference/sql/functions/parse_json.md @@ -1,3 +1,7 @@ +--- +description: "Parse a JSON string as a Variant value." +--- + # `parse_json` diff --git a/docs/reference/sql/functions/parse_url.md b/docs/reference/sql/functions/parse_url.md index 19a21ee5f..c951ddf71 100644 --- a/docs/reference/sql/functions/parse_url.md +++ b/docs/reference/sql/functions/parse_url.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a part from a URL." +--- + # `parse_url` diff --git a/docs/reference/sql/functions/percent_rank.md b/docs/reference/sql/functions/percent_rank.md index 875901674..73ca6a4f1 100644 --- a/docs/reference/sql/functions/percent_rank.md +++ b/docs/reference/sql/functions/percent_rank.md @@ -1,3 +1,7 @@ +--- +description: "Computes the percentage ranking of a value in a group of values." +--- + # `percent_rank` diff --git a/docs/reference/sql/functions/percentile.md b/docs/reference/sql/functions/percentile.md index 66729b8f2..679a4dc54 100644 --- a/docs/reference/sql/functions/percentile.md +++ b/docs/reference/sql/functions/percentile.md @@ -1,3 +1,7 @@ +--- +description: "Returns the exact percentile value of numeric or ANSI interval column `col` at the given percentage." +--- + # `percentile` diff --git a/docs/reference/sql/functions/percentile_approx.md b/docs/reference/sql/functions/percentile_approx.md index 5883b9d67..0b4c545e4 100644 --- a/docs/reference/sql/functions/percentile_approx.md +++ b/docs/reference/sql/functions/percentile_approx.md @@ -1,3 +1,7 @@ +--- +description: "Returns the approximate `percentile` of the numeric or ansi interval column `col` which is the smallest value in the ordered `col` values (sorted from least to greatest) such that no more than `percentage` of `col` values is less than the value or equal to that value." +--- + # `percentile_approx` diff --git a/docs/reference/sql/functions/percentile_cont.md b/docs/reference/sql/functions/percentile_cont.md index 6cf460000..0828a3c19 100644 --- a/docs/reference/sql/functions/percentile_cont.md +++ b/docs/reference/sql/functions/percentile_cont.md @@ -1,3 +1,7 @@ +--- +description: "Return a percentile value based on a continuous distribution of numeric or ANSI interval column `col` at the given `percentage` (specified in ORDER BY clause)." +--- + # `percentile_cont` diff --git a/docs/reference/sql/functions/percentile_disc.md b/docs/reference/sql/functions/percentile_disc.md index 1cbd2159d..9044c1db8 100644 --- a/docs/reference/sql/functions/percentile_disc.md +++ b/docs/reference/sql/functions/percentile_disc.md @@ -1,3 +1,7 @@ +--- +description: "Return a percentile value based on a discrete distribution of numeric or ANSI interval column `col` at the given `percentage` (specified in ORDER BY clause)." +--- + # `percentile_disc` diff --git a/docs/reference/sql/functions/pi.md b/docs/reference/sql/functions/pi.md index ed8bec0c0..0513634a9 100644 --- a/docs/reference/sql/functions/pi.md +++ b/docs/reference/sql/functions/pi.md @@ -1,3 +1,7 @@ +--- +description: "Returns pi." +--- + # `pi` diff --git a/docs/reference/sql/functions/pmod.md b/docs/reference/sql/functions/pmod.md index 8795ac33e..64dc5d9ad 100644 --- a/docs/reference/sql/functions/pmod.md +++ b/docs/reference/sql/functions/pmod.md @@ -1,3 +1,7 @@ +--- +description: "Returns the positive value of `expr1` mod `expr2`." +--- + # `pmod` diff --git a/docs/reference/sql/functions/posexplode.md b/docs/reference/sql/functions/posexplode.md index 0e71ea555..8ad679db7 100644 --- a/docs/reference/sql/functions/posexplode.md +++ b/docs/reference/sql/functions/posexplode.md @@ -1,3 +1,7 @@ +--- +description: "Separates the elements of array `expr` into multiple rows with positions, or the elements of map `expr` into multiple rows and columns with positions." +--- + # `posexplode` diff --git a/docs/reference/sql/functions/posexplode_outer.md b/docs/reference/sql/functions/posexplode_outer.md index 387663851..45e4c6552 100644 --- a/docs/reference/sql/functions/posexplode_outer.md +++ b/docs/reference/sql/functions/posexplode_outer.md @@ -1,3 +1,7 @@ +--- +description: "Separates the elements of array `expr` into multiple rows with positions, or the elements of map `expr` into multiple rows and columns with positions." +--- + # `posexplode_outer` diff --git a/docs/reference/sql/functions/position.md b/docs/reference/sql/functions/position.md index 09b8ab1fa..b4dd0a216 100644 --- a/docs/reference/sql/functions/position.md +++ b/docs/reference/sql/functions/position.md @@ -1,3 +1,7 @@ +--- +description: "Returns the position of the first occurrence of `substr` in `str` after position `pos`." +--- + # `position` diff --git a/docs/reference/sql/functions/positive.md b/docs/reference/sql/functions/positive.md index 3a10f2c83..5e3e1ad3d 100644 --- a/docs/reference/sql/functions/positive.md +++ b/docs/reference/sql/functions/positive.md @@ -1,3 +1,7 @@ +--- +description: "Returns the value of `expr`." +--- + # `positive` diff --git a/docs/reference/sql/functions/pow.md b/docs/reference/sql/functions/pow.md index 7a7f06afe..edac677ca 100644 --- a/docs/reference/sql/functions/pow.md +++ b/docs/reference/sql/functions/pow.md @@ -1,3 +1,7 @@ +--- +description: "Raises `expr1` to the power of `expr2`." +--- + # `pow` diff --git a/docs/reference/sql/functions/power.md b/docs/reference/sql/functions/power.md index bdf048687..f26ab1b08 100644 --- a/docs/reference/sql/functions/power.md +++ b/docs/reference/sql/functions/power.md @@ -1,3 +1,7 @@ +--- +description: "Raises `expr1` to the power of `expr2`." +--- + # `power` diff --git a/docs/reference/sql/functions/printf.md b/docs/reference/sql/functions/printf.md index 41141c569..9dfae5433 100644 --- a/docs/reference/sql/functions/printf.md +++ b/docs/reference/sql/functions/printf.md @@ -1,3 +1,7 @@ +--- +description: "Returns a formatted string from printf-style format strings." +--- + # `printf` diff --git a/docs/reference/sql/functions/python_worker_logs.md b/docs/reference/sql/functions/python_worker_logs.md index f74b52cca..05c391a28 100644 --- a/docs/reference/sql/functions/python_worker_logs.md +++ b/docs/reference/sql/functions/python_worker_logs.md @@ -1,3 +1,7 @@ +--- +description: "Returns a table of logs collected from Python workers." +--- + # `python_worker_logs` diff --git a/docs/reference/sql/functions/quarter.md b/docs/reference/sql/functions/quarter.md index 2db94d2cd..0172c50bf 100644 --- a/docs/reference/sql/functions/quarter.md +++ b/docs/reference/sql/functions/quarter.md @@ -1,3 +1,7 @@ +--- +description: "Returns the quarter of the year for date, in the range 1 to 4." +--- + # `quarter` diff --git a/docs/reference/sql/functions/quote.md b/docs/reference/sql/functions/quote.md index 87087d6fa..d2e8060d9 100644 --- a/docs/reference/sql/functions/quote.md +++ b/docs/reference/sql/functions/quote.md @@ -1,3 +1,7 @@ +--- +description: "Returns `str` enclosed by single quotes and each instance of single quote in it is preceded by a backslash." +--- + # `quote` diff --git a/docs/reference/sql/functions/radians.md b/docs/reference/sql/functions/radians.md index 2032cc1ac..c84c64ba8 100644 --- a/docs/reference/sql/functions/radians.md +++ b/docs/reference/sql/functions/radians.md @@ -1,3 +1,7 @@ +--- +description: "Converts degrees to radians." +--- + # `radians` diff --git a/docs/reference/sql/functions/raise_error.md b/docs/reference/sql/functions/raise_error.md index cc7167f24..f9d379f65 100644 --- a/docs/reference/sql/functions/raise_error.md +++ b/docs/reference/sql/functions/raise_error.md @@ -1,3 +1,7 @@ +--- +description: "Throws a USER_RAISED_EXCEPTION with `expr` as message." +--- + # `raise_error` diff --git a/docs/reference/sql/functions/rand.md b/docs/reference/sql/functions/rand.md index 1b26c48cd..e33b9dc1e 100644 --- a/docs/reference/sql/functions/rand.md +++ b/docs/reference/sql/functions/rand.md @@ -1,3 +1,7 @@ +--- +description: "Returns a random value with independent and identically distributed (i.i.d.) uniformly distributed values in [0, 1)." +--- + # `rand` diff --git a/docs/reference/sql/functions/randn.md b/docs/reference/sql/functions/randn.md index 14109e6f8..567c8d08b 100644 --- a/docs/reference/sql/functions/randn.md +++ b/docs/reference/sql/functions/randn.md @@ -1,3 +1,7 @@ +--- +description: "Returns a random value with independent and identically distributed (i.i.d.) values drawn from the standard normal distribution." +--- + # `randn` diff --git a/docs/reference/sql/functions/random.md b/docs/reference/sql/functions/random.md index 31a814a7d..24ae770e4 100644 --- a/docs/reference/sql/functions/random.md +++ b/docs/reference/sql/functions/random.md @@ -1,3 +1,7 @@ +--- +description: "Returns a random value with independent and identically distributed (i.i.d.) uniformly distributed values in [0, 1)." +--- + # `random` diff --git a/docs/reference/sql/functions/randstr.md b/docs/reference/sql/functions/randstr.md index b5efaf17b..5127e9395 100644 --- a/docs/reference/sql/functions/randstr.md +++ b/docs/reference/sql/functions/randstr.md @@ -1,3 +1,7 @@ +--- +description: "Returns a string of the specified length whose characters are chosen uniformly at random from the following pool of characters: 0-9, a-z, A-Z." +--- + # `randstr` diff --git a/docs/reference/sql/functions/range.md b/docs/reference/sql/functions/range.md index 5aef57a90..174b40961 100644 --- a/docs/reference/sql/functions/range.md +++ b/docs/reference/sql/functions/range.md @@ -1,3 +1,7 @@ +--- +description: "Returns a table of values within a specified range." +--- + # `range` diff --git a/docs/reference/sql/functions/rank.md b/docs/reference/sql/functions/rank.md index 271f84a96..9a5f4ad89 100644 --- a/docs/reference/sql/functions/rank.md +++ b/docs/reference/sql/functions/rank.md @@ -1,3 +1,7 @@ +--- +description: "Computes the rank of a value in a group of values." +--- + # `rank` diff --git a/docs/reference/sql/functions/reduce.md b/docs/reference/sql/functions/reduce.md index 24934fde5..6e61a9381 100644 --- a/docs/reference/sql/functions/reduce.md +++ b/docs/reference/sql/functions/reduce.md @@ -1,3 +1,7 @@ +--- +description: "Applies a binary operator to an initial state and all elements in the array, and reduces this to a single state." +--- + # `reduce` diff --git a/docs/reference/sql/functions/reflect.md b/docs/reference/sql/functions/reflect.md index ab16467cd..be3b5cb4a 100644 --- a/docs/reference/sql/functions/reflect.md +++ b/docs/reference/sql/functions/reflect.md @@ -1,3 +1,7 @@ +--- +description: "Calls a method with reflection." +--- + # `reflect` diff --git a/docs/reference/sql/functions/regexp.md b/docs/reference/sql/functions/regexp.md index 445a15cbd..558ea320e 100644 --- a/docs/reference/sql/functions/regexp.md +++ b/docs/reference/sql/functions/regexp.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `str` matches `regexp`, or false otherwise." +--- + # `regexp` diff --git a/docs/reference/sql/functions/regexp_count.md b/docs/reference/sql/functions/regexp_count.md index 2d94ed8d0..d7dde9551 100644 --- a/docs/reference/sql/functions/regexp_count.md +++ b/docs/reference/sql/functions/regexp_count.md @@ -1,3 +1,7 @@ +--- +description: "Returns a count of the number of times that the regular expression pattern `regexp` is matched in the string `str`." +--- + # `regexp_count` diff --git a/docs/reference/sql/functions/regexp_extract.md b/docs/reference/sql/functions/regexp_extract.md index 3b8ae89a9..d431b8a2b 100644 --- a/docs/reference/sql/functions/regexp_extract.md +++ b/docs/reference/sql/functions/regexp_extract.md @@ -1,3 +1,7 @@ +--- +description: "Extract the first string in the `str` that match the `regexp` expression and corresponding to the regex group index." +--- + # `regexp_extract` diff --git a/docs/reference/sql/functions/regexp_extract_all.md b/docs/reference/sql/functions/regexp_extract_all.md index e49cdee55..77acf3b53 100644 --- a/docs/reference/sql/functions/regexp_extract_all.md +++ b/docs/reference/sql/functions/regexp_extract_all.md @@ -1,3 +1,7 @@ +--- +description: "Extract all strings in the `str` that match the `regexp` expression and corresponding to the regex group index." +--- + # `regexp_extract_all` diff --git a/docs/reference/sql/functions/regexp_instr.md b/docs/reference/sql/functions/regexp_instr.md index 23be7a827..a89901472 100644 --- a/docs/reference/sql/functions/regexp_instr.md +++ b/docs/reference/sql/functions/regexp_instr.md @@ -1,3 +1,7 @@ +--- +description: "Searches a string for a regular expression and returns an integer that indicates the beginning position of the matched substring." +--- + # `regexp_instr` diff --git a/docs/reference/sql/functions/regexp_like.md b/docs/reference/sql/functions/regexp_like.md index ad9cb2b87..7087ce63e 100644 --- a/docs/reference/sql/functions/regexp_like.md +++ b/docs/reference/sql/functions/regexp_like.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `str` matches `regexp`, or false otherwise." +--- + # `regexp_like` diff --git a/docs/reference/sql/functions/regexp_replace.md b/docs/reference/sql/functions/regexp_replace.md index 64da344fd..e5b73e5b8 100644 --- a/docs/reference/sql/functions/regexp_replace.md +++ b/docs/reference/sql/functions/regexp_replace.md @@ -1,3 +1,7 @@ +--- +description: "Replaces all substrings of `str` that match `regexp` with `rep`." +--- + # `regexp_replace` diff --git a/docs/reference/sql/functions/regexp_substr.md b/docs/reference/sql/functions/regexp_substr.md index e8d217a32..d19683261 100644 --- a/docs/reference/sql/functions/regexp_substr.md +++ b/docs/reference/sql/functions/regexp_substr.md @@ -1,3 +1,7 @@ +--- +description: "Returns the substring that matches the regular expression `regexp` within the string `str`." +--- + # `regexp_substr` diff --git a/docs/reference/sql/functions/regr_avgx.md b/docs/reference/sql/functions/regr_avgx.md index c05a74c66..961aa620d 100644 --- a/docs/reference/sql/functions/regr_avgx.md +++ b/docs/reference/sql/functions/regr_avgx.md @@ -1,3 +1,7 @@ +--- +description: "Returns the average of the independent variable for non-null pairs in a group, where `y` is the dependent variable and `x` is the independent variable." +--- + # `regr_avgx` diff --git a/docs/reference/sql/functions/regr_avgy.md b/docs/reference/sql/functions/regr_avgy.md index 8e12b7c1b..63ff9430c 100644 --- a/docs/reference/sql/functions/regr_avgy.md +++ b/docs/reference/sql/functions/regr_avgy.md @@ -1,3 +1,7 @@ +--- +description: "Returns the average of the dependent variable for non-null pairs in a group, where `y` is the dependent variable and `x` is the independent variable." +--- + # `regr_avgy` diff --git a/docs/reference/sql/functions/regr_count.md b/docs/reference/sql/functions/regr_count.md index 69f7793f5..1a959f5d0 100644 --- a/docs/reference/sql/functions/regr_count.md +++ b/docs/reference/sql/functions/regr_count.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of non-null number pairs in a group, where `y` is the dependent variable and `x` is the independent variable." +--- + # `regr_count` diff --git a/docs/reference/sql/functions/regr_intercept.md b/docs/reference/sql/functions/regr_intercept.md index 73ef99be6..ac56a2a7d 100644 --- a/docs/reference/sql/functions/regr_intercept.md +++ b/docs/reference/sql/functions/regr_intercept.md @@ -1,3 +1,7 @@ +--- +description: "Returns the intercept of the univariate linear regression line for non-null pairs in a group, where `y` is the dependent variable and `x` is the independent variable." +--- + # `regr_intercept` diff --git a/docs/reference/sql/functions/regr_r2.md b/docs/reference/sql/functions/regr_r2.md index 274f91e13..c95dc9355 100644 --- a/docs/reference/sql/functions/regr_r2.md +++ b/docs/reference/sql/functions/regr_r2.md @@ -1,3 +1,7 @@ +--- +description: "Returns the coefficient of determination for non-null pairs in a group, where `y` is the dependent variable and `x` is the independent variable." +--- + # `regr_r2` diff --git a/docs/reference/sql/functions/regr_slope.md b/docs/reference/sql/functions/regr_slope.md index aab1ce34c..522dcda3f 100644 --- a/docs/reference/sql/functions/regr_slope.md +++ b/docs/reference/sql/functions/regr_slope.md @@ -1,3 +1,7 @@ +--- +description: "Returns the slope of the linear regression line for non-null pairs in a group, where `y` is the dependent variable and `x` is the independent variable." +--- + # `regr_slope` diff --git a/docs/reference/sql/functions/regr_sxx.md b/docs/reference/sql/functions/regr_sxx.md index 444708aef..c27d7d499 100644 --- a/docs/reference/sql/functions/regr_sxx.md +++ b/docs/reference/sql/functions/regr_sxx.md @@ -1,3 +1,7 @@ +--- +description: "Returns REGR_COUNT(y, x) * VAR_POP(x) for non-null pairs in a group, where `y` is the dependent variable and `x` is the independent variable." +--- + # `regr_sxx` diff --git a/docs/reference/sql/functions/regr_sxy.md b/docs/reference/sql/functions/regr_sxy.md index b15fb2291..5aae2ca9f 100644 --- a/docs/reference/sql/functions/regr_sxy.md +++ b/docs/reference/sql/functions/regr_sxy.md @@ -1,3 +1,7 @@ +--- +description: "Returns REGR_COUNT(y, x) * COVAR_POP(y, x) for non-null pairs in a group, where `y` is the dependent variable and `x` is the independent variable." +--- + # `regr_sxy` diff --git a/docs/reference/sql/functions/regr_syy.md b/docs/reference/sql/functions/regr_syy.md index cc8efe46c..e4760bf58 100644 --- a/docs/reference/sql/functions/regr_syy.md +++ b/docs/reference/sql/functions/regr_syy.md @@ -1,3 +1,7 @@ +--- +description: "Returns REGR_COUNT(y, x) * VAR_POP(y) for non-null pairs in a group, where `y` is the dependent variable and `x` is the independent variable." +--- + # `regr_syy` diff --git a/docs/reference/sql/functions/repeat.md b/docs/reference/sql/functions/repeat.md index 39079194b..f757b780c 100644 --- a/docs/reference/sql/functions/repeat.md +++ b/docs/reference/sql/functions/repeat.md @@ -1,3 +1,7 @@ +--- +description: "Returns the string which repeats the given string value n times." +--- + # `repeat` diff --git a/docs/reference/sql/functions/replace.md b/docs/reference/sql/functions/replace.md index 45a172401..57cd20c8c 100644 --- a/docs/reference/sql/functions/replace.md +++ b/docs/reference/sql/functions/replace.md @@ -1,3 +1,7 @@ +--- +description: "Replaces all occurrences of `search` with `replace`." +--- + # `replace` diff --git a/docs/reference/sql/functions/reverse.md b/docs/reference/sql/functions/reverse.md index 14a3be547..7825f5816 100644 --- a/docs/reference/sql/functions/reverse.md +++ b/docs/reference/sql/functions/reverse.md @@ -1,3 +1,7 @@ +--- +description: "Returns a reversed string, a binary value with bytes in reverse order, or an array with reverse order of elements." +--- + # `reverse` diff --git a/docs/reference/sql/functions/right.md b/docs/reference/sql/functions/right.md index 89bbcfcbe..335bb36c0 100644 --- a/docs/reference/sql/functions/right.md +++ b/docs/reference/sql/functions/right.md @@ -1,3 +1,7 @@ +--- +description: "Returns the rightmost `len`(`len` can be string type) characters from the string `str`,if `len` is less or equal than 0 the result is an empty string." +--- + # `right` diff --git a/docs/reference/sql/functions/rint.md b/docs/reference/sql/functions/rint.md index 29deeea53..e89c1df5a 100644 --- a/docs/reference/sql/functions/rint.md +++ b/docs/reference/sql/functions/rint.md @@ -1,3 +1,7 @@ +--- +description: "Returns the double value that is closest in value to the argument and is equal to a mathematical integer." +--- + # `rint` diff --git a/docs/reference/sql/functions/rlike.md b/docs/reference/sql/functions/rlike.md index 1f8754098..d53fa9754 100644 --- a/docs/reference/sql/functions/rlike.md +++ b/docs/reference/sql/functions/rlike.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if `str` matches `regexp`, or false otherwise." +--- + # `rlike` diff --git a/docs/reference/sql/functions/round.md b/docs/reference/sql/functions/round.md index fcc1125f2..5c61e239a 100644 --- a/docs/reference/sql/functions/round.md +++ b/docs/reference/sql/functions/round.md @@ -1,3 +1,7 @@ +--- +description: "Returns `expr` rounded to `d` decimal places using HALF_UP rounding mode." +--- + # `round` diff --git a/docs/reference/sql/functions/row_number.md b/docs/reference/sql/functions/row_number.md index 9cea1b723..c6af9eb1c 100644 --- a/docs/reference/sql/functions/row_number.md +++ b/docs/reference/sql/functions/row_number.md @@ -1,3 +1,7 @@ +--- +description: "Assigns a unique, sequential number to each row, starting with one, according to the ordering of rows within the window partition." +--- + # `row_number` diff --git a/docs/reference/sql/functions/rpad.md b/docs/reference/sql/functions/rpad.md index 9d478eb1e..dddcf987a 100644 --- a/docs/reference/sql/functions/rpad.md +++ b/docs/reference/sql/functions/rpad.md @@ -1,3 +1,7 @@ +--- +description: "Returns `str`, right-padded with `pad` to a length of `len`." +--- + # `rpad` diff --git a/docs/reference/sql/functions/rtrim.md b/docs/reference/sql/functions/rtrim.md index d2d0d3064..f87e323b6 100644 --- a/docs/reference/sql/functions/rtrim.md +++ b/docs/reference/sql/functions/rtrim.md @@ -1,3 +1,7 @@ +--- +description: "Removes the trailing space characters from `str`." +--- + # `rtrim` diff --git a/docs/reference/sql/functions/schema_of_avro.md b/docs/reference/sql/functions/schema_of_avro.md index 2a1590471..bca2221f4 100644 --- a/docs/reference/sql/functions/schema_of_avro.md +++ b/docs/reference/sql/functions/schema_of_avro.md @@ -1,3 +1,7 @@ +--- +description: "Returns schema in the DDL format of the avro schema in JSON string format." +--- + # `schema_of_avro` diff --git a/docs/reference/sql/functions/schema_of_csv.md b/docs/reference/sql/functions/schema_of_csv.md index 188db67a2..07bf2ea5a 100644 --- a/docs/reference/sql/functions/schema_of_csv.md +++ b/docs/reference/sql/functions/schema_of_csv.md @@ -1,3 +1,7 @@ +--- +description: "Returns schema in the DDL format of CSV string." +--- + # `schema_of_csv` diff --git a/docs/reference/sql/functions/schema_of_json.md b/docs/reference/sql/functions/schema_of_json.md index fc9888956..491845bfa 100644 --- a/docs/reference/sql/functions/schema_of_json.md +++ b/docs/reference/sql/functions/schema_of_json.md @@ -1,3 +1,7 @@ +--- +description: "Returns schema in the DDL format of JSON string." +--- + # `schema_of_json` diff --git a/docs/reference/sql/functions/schema_of_variant.md b/docs/reference/sql/functions/schema_of_variant.md index 12d26617d..4a530a6a1 100644 --- a/docs/reference/sql/functions/schema_of_variant.md +++ b/docs/reference/sql/functions/schema_of_variant.md @@ -1,3 +1,7 @@ +--- +description: "Returns schema in the SQL format of a variant." +--- + # `schema_of_variant` diff --git a/docs/reference/sql/functions/schema_of_variant_agg.md b/docs/reference/sql/functions/schema_of_variant_agg.md index 3d20405fe..c49b85d38 100644 --- a/docs/reference/sql/functions/schema_of_variant_agg.md +++ b/docs/reference/sql/functions/schema_of_variant_agg.md @@ -1,3 +1,7 @@ +--- +description: "Returns the merged schema in the SQL format of a variant column." +--- + # `schema_of_variant_agg` diff --git a/docs/reference/sql/functions/schema_of_xml.md b/docs/reference/sql/functions/schema_of_xml.md index 91472c97a..e0244f6b1 100644 --- a/docs/reference/sql/functions/schema_of_xml.md +++ b/docs/reference/sql/functions/schema_of_xml.md @@ -1,3 +1,7 @@ +--- +description: "Returns schema in the DDL format of XML string." +--- + # `schema_of_xml` diff --git a/docs/reference/sql/functions/sec.md b/docs/reference/sql/functions/sec.md index 0dc5ca931..fb1bbb536 100644 --- a/docs/reference/sql/functions/sec.md +++ b/docs/reference/sql/functions/sec.md @@ -1,3 +1,7 @@ +--- +description: "Returns the secant of `expr`, as if computed by `1/java.lang.Math.cos`." +--- + # `sec` diff --git a/docs/reference/sql/functions/second.md b/docs/reference/sql/functions/second.md index 43c3629c1..48d8aea0d 100644 --- a/docs/reference/sql/functions/second.md +++ b/docs/reference/sql/functions/second.md @@ -1,3 +1,7 @@ +--- +description: "Returns the second component of the given expression." +--- + # `second` diff --git a/docs/reference/sql/functions/sentences.md b/docs/reference/sql/functions/sentences.md index 67598d8d3..b5e8ae8c7 100644 --- a/docs/reference/sql/functions/sentences.md +++ b/docs/reference/sql/functions/sentences.md @@ -1,3 +1,7 @@ +--- +description: "Splits `str` into an array of array of words." +--- + # `sentences` diff --git a/docs/reference/sql/functions/sequence.md b/docs/reference/sql/functions/sequence.md index 3b44c6a22..6c6a01f80 100644 --- a/docs/reference/sql/functions/sequence.md +++ b/docs/reference/sql/functions/sequence.md @@ -1,3 +1,7 @@ +--- +description: "Generates an array of elements from start to stop (inclusive), incrementing by step." +--- + # `sequence` diff --git a/docs/reference/sql/functions/session_user.md b/docs/reference/sql/functions/session_user.md index 30d4b3f61..43ec8a592 100644 --- a/docs/reference/sql/functions/session_user.md +++ b/docs/reference/sql/functions/session_user.md @@ -1,3 +1,7 @@ +--- +description: "user name of current execution context." +--- + # `session_user` diff --git a/docs/reference/sql/functions/session_window.md b/docs/reference/sql/functions/session_window.md index 948a43c3a..68252b94e 100644 --- a/docs/reference/sql/functions/session_window.md +++ b/docs/reference/sql/functions/session_window.md @@ -1,3 +1,7 @@ +--- +description: "Generates session window given a timestamp specifying column and gap duration." +--- + # `session_window` diff --git a/docs/reference/sql/functions/sha.md b/docs/reference/sql/functions/sha.md index 0dba3bf8e..f9860bbe1 100644 --- a/docs/reference/sql/functions/sha.md +++ b/docs/reference/sql/functions/sha.md @@ -1,3 +1,7 @@ +--- +description: "Returns a sha1 hash value as a hex string of the `expr`." +--- + # `sha` diff --git a/docs/reference/sql/functions/sha1.md b/docs/reference/sql/functions/sha1.md index 0d5a41ff7..9dbd48320 100644 --- a/docs/reference/sql/functions/sha1.md +++ b/docs/reference/sql/functions/sha1.md @@ -1,3 +1,7 @@ +--- +description: "Returns a sha1 hash value as a hex string of the `expr`." +--- + # `sha1` diff --git a/docs/reference/sql/functions/sha2.md b/docs/reference/sql/functions/sha2.md index df9e7d844..787507869 100644 --- a/docs/reference/sql/functions/sha2.md +++ b/docs/reference/sql/functions/sha2.md @@ -1,3 +1,7 @@ +--- +description: "Returns a checksum of SHA-2 family as a hex string of `expr`." +--- + # `sha2` diff --git a/docs/reference/sql/functions/shiftleft.md b/docs/reference/sql/functions/shiftleft.md index 13a8d3111..c93ad1736 100644 --- a/docs/reference/sql/functions/shiftleft.md +++ b/docs/reference/sql/functions/shiftleft.md @@ -1,3 +1,7 @@ +--- +description: "Bitwise left shift." +--- + # `shiftleft` diff --git a/docs/reference/sql/functions/shiftright.md b/docs/reference/sql/functions/shiftright.md index fe2d6cde3..84af65bcb 100644 --- a/docs/reference/sql/functions/shiftright.md +++ b/docs/reference/sql/functions/shiftright.md @@ -1,3 +1,7 @@ +--- +description: "Bitwise (signed) right shift." +--- + # `shiftright` diff --git a/docs/reference/sql/functions/shiftrightunsigned.md b/docs/reference/sql/functions/shiftrightunsigned.md index 8d85a9ce5..90c65cf57 100644 --- a/docs/reference/sql/functions/shiftrightunsigned.md +++ b/docs/reference/sql/functions/shiftrightunsigned.md @@ -1,3 +1,7 @@ +--- +description: "Bitwise unsigned right shift." +--- + # `shiftrightunsigned` diff --git a/docs/reference/sql/functions/shuffle.md b/docs/reference/sql/functions/shuffle.md index 739afafde..fb96fefa4 100644 --- a/docs/reference/sql/functions/shuffle.md +++ b/docs/reference/sql/functions/shuffle.md @@ -1,3 +1,7 @@ +--- +description: "Returns a random permutation of the given array." +--- + # `shuffle` diff --git a/docs/reference/sql/functions/sign.md b/docs/reference/sql/functions/sign.md index 793c8554e..2ba4fa7f8 100644 --- a/docs/reference/sql/functions/sign.md +++ b/docs/reference/sql/functions/sign.md @@ -1,3 +1,7 @@ +--- +description: "Returns -1.0, 0.0 or 1.0 as `expr` is negative, 0 or positive." +--- + # `sign` diff --git a/docs/reference/sql/functions/signum.md b/docs/reference/sql/functions/signum.md index 563a9432b..b91f15977 100644 --- a/docs/reference/sql/functions/signum.md +++ b/docs/reference/sql/functions/signum.md @@ -1,3 +1,7 @@ +--- +description: "Returns -1.0, 0.0 or 1.0 as `expr` is negative, 0 or positive." +--- + # `signum` diff --git a/docs/reference/sql/functions/sin.md b/docs/reference/sql/functions/sin.md index 309c2fabb..8dde590f8 100644 --- a/docs/reference/sql/functions/sin.md +++ b/docs/reference/sql/functions/sin.md @@ -1,3 +1,7 @@ +--- +description: "Returns the sine of `expr`, as if computed by `java.lang.Math.sin`." +--- + # `sin` diff --git a/docs/reference/sql/functions/sinh.md b/docs/reference/sql/functions/sinh.md index 094f2dd2c..cb417df9d 100644 --- a/docs/reference/sql/functions/sinh.md +++ b/docs/reference/sql/functions/sinh.md @@ -1,3 +1,7 @@ +--- +description: "Returns hyperbolic sine of `expr`, as if computed by `java.lang.Math.sinh`." +--- + # `sinh` diff --git a/docs/reference/sql/functions/size.md b/docs/reference/sql/functions/size.md index 94b806a5e..2a72b223c 100644 --- a/docs/reference/sql/functions/size.md +++ b/docs/reference/sql/functions/size.md @@ -1,3 +1,7 @@ +--- +description: "Returns the size of an array or a map." +--- + # `size` diff --git a/docs/reference/sql/functions/skewness.md b/docs/reference/sql/functions/skewness.md index 9e51d1f37..56aa5d557 100644 --- a/docs/reference/sql/functions/skewness.md +++ b/docs/reference/sql/functions/skewness.md @@ -1,3 +1,7 @@ +--- +description: "Returns the skewness value calculated from values of a group." +--- + # `skewness` diff --git a/docs/reference/sql/functions/slice.md b/docs/reference/sql/functions/slice.md index e534ad554..0d21a6ef2 100644 --- a/docs/reference/sql/functions/slice.md +++ b/docs/reference/sql/functions/slice.md @@ -1,3 +1,7 @@ +--- +description: "Subsets array x starting from index start (array indices start at 1, or starting from the end if start is negative) with the specified length." +--- + # `slice` diff --git a/docs/reference/sql/functions/smallint.md b/docs/reference/sql/functions/smallint.md index c5420c046..0d6c2c83b 100644 --- a/docs/reference/sql/functions/smallint.md +++ b/docs/reference/sql/functions/smallint.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `smallint`." +--- + # `smallint` diff --git a/docs/reference/sql/functions/some.md b/docs/reference/sql/functions/some.md index 8f68a31e8..ae7e8ca10 100644 --- a/docs/reference/sql/functions/some.md +++ b/docs/reference/sql/functions/some.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if at least one value of `expr` is true." +--- + # `some` diff --git a/docs/reference/sql/functions/sort_array.md b/docs/reference/sql/functions/sort_array.md index 59e583fd7..12ca75319 100644 --- a/docs/reference/sql/functions/sort_array.md +++ b/docs/reference/sql/functions/sort_array.md @@ -1,3 +1,7 @@ +--- +description: "Sorts the input array in ascending or descending order according to the natural ordering of the array elements." +--- + # `sort_array` diff --git a/docs/reference/sql/functions/soundex.md b/docs/reference/sql/functions/soundex.md index b2d00d2c2..f86a11169 100644 --- a/docs/reference/sql/functions/soundex.md +++ b/docs/reference/sql/functions/soundex.md @@ -1,3 +1,7 @@ +--- +description: "Returns Soundex code of the string." +--- + # `soundex` diff --git a/docs/reference/sql/functions/space.md b/docs/reference/sql/functions/space.md index bd948cd3f..ed9e53bcf 100644 --- a/docs/reference/sql/functions/space.md +++ b/docs/reference/sql/functions/space.md @@ -1,3 +1,7 @@ +--- +description: "Returns a string consisting of `n` spaces." +--- + # `space` diff --git a/docs/reference/sql/functions/spark_partition_id.md b/docs/reference/sql/functions/spark_partition_id.md index a863a13bc..a46eb4acf 100644 --- a/docs/reference/sql/functions/spark_partition_id.md +++ b/docs/reference/sql/functions/spark_partition_id.md @@ -1,3 +1,7 @@ +--- +description: "Returns the current partition id." +--- + # `spark_partition_id` diff --git a/docs/reference/sql/functions/split.md b/docs/reference/sql/functions/split.md index 6c86f3114..074546fe0 100644 --- a/docs/reference/sql/functions/split.md +++ b/docs/reference/sql/functions/split.md @@ -1,3 +1,7 @@ +--- +description: "Splits `str` around occurrences that match `regex` and returns an array with a length of at most `limit`" +--- + # `split` diff --git a/docs/reference/sql/functions/split_part.md b/docs/reference/sql/functions/split_part.md index 85397861c..95d99daaa 100644 --- a/docs/reference/sql/functions/split_part.md +++ b/docs/reference/sql/functions/split_part.md @@ -1,3 +1,7 @@ +--- +description: "Splits `str` by delimiter and return requested part of the split (1-based)." +--- + # `split_part` diff --git a/docs/reference/sql/functions/sql_keywords.md b/docs/reference/sql/functions/sql_keywords.md index bedee11bc..69851c546 100644 --- a/docs/reference/sql/functions/sql_keywords.md +++ b/docs/reference/sql/functions/sql_keywords.md @@ -1,3 +1,7 @@ +--- +description: "Get Spark SQL keywords" +--- + # `sql_keywords` diff --git a/docs/reference/sql/functions/sqrt.md b/docs/reference/sql/functions/sqrt.md index 5f15ae318..db341d4af 100644 --- a/docs/reference/sql/functions/sqrt.md +++ b/docs/reference/sql/functions/sqrt.md @@ -1,3 +1,7 @@ +--- +description: "Returns the square root of `expr`." +--- + # `sqrt` diff --git a/docs/reference/sql/functions/st_asbinary.md b/docs/reference/sql/functions/st_asbinary.md index f9593b5d6..fa414a035 100644 --- a/docs/reference/sql/functions/st_asbinary.md +++ b/docs/reference/sql/functions/st_asbinary.md @@ -1,3 +1,7 @@ +--- +description: "Returns the geospatial value (value of type GEOGRAPHY or GEOMETRY) in WKB format using the specified endianness ('NDR' for little-endian, 'XDR' for big-endian), if provided." +--- + # `st_asbinary` diff --git a/docs/reference/sql/functions/st_geogfromwkb.md b/docs/reference/sql/functions/st_geogfromwkb.md index ac92acf78..1150c9226 100644 --- a/docs/reference/sql/functions/st_geogfromwkb.md +++ b/docs/reference/sql/functions/st_geogfromwkb.md @@ -1,3 +1,7 @@ +--- +description: "Parses the WKB description of a geography and returns the corresponding GEOGRAPHY value." +--- + # `st_geogfromwkb` diff --git a/docs/reference/sql/functions/st_geomfromwkb.md b/docs/reference/sql/functions/st_geomfromwkb.md index b025cb513..6040a0564 100644 --- a/docs/reference/sql/functions/st_geomfromwkb.md +++ b/docs/reference/sql/functions/st_geomfromwkb.md @@ -1,3 +1,7 @@ +--- +description: "Parses the WKB description of a geometry and returns the corresponding GEOMETRY value." +--- + # `st_geomfromwkb` diff --git a/docs/reference/sql/functions/st_setsrid.md b/docs/reference/sql/functions/st_setsrid.md index b4d33568e..7054d21df 100644 --- a/docs/reference/sql/functions/st_setsrid.md +++ b/docs/reference/sql/functions/st_setsrid.md @@ -1,3 +1,7 @@ +--- +description: "Returns a new GEOGRAPHY or GEOMETRY value whose SRID is the specified SRID value." +--- + # `st_setsrid` diff --git a/docs/reference/sql/functions/st_srid.md b/docs/reference/sql/functions/st_srid.md index 060ff2226..2bf4a7839 100644 --- a/docs/reference/sql/functions/st_srid.md +++ b/docs/reference/sql/functions/st_srid.md @@ -1,3 +1,7 @@ +--- +description: "Returns the SRID of the input GEOGRAPHY or GEOMETRY value." +--- + # `st_srid` diff --git a/docs/reference/sql/functions/stack.md b/docs/reference/sql/functions/stack.md index b850a3fff..5e86cee61 100644 --- a/docs/reference/sql/functions/stack.md +++ b/docs/reference/sql/functions/stack.md @@ -1,3 +1,7 @@ +--- +description: "Separates `expr1`, ..., `exprk` into `n` rows." +--- + # `stack` diff --git a/docs/reference/sql/functions/startswith.md b/docs/reference/sql/functions/startswith.md index 518b9de18..9f45fcf9b 100644 --- a/docs/reference/sql/functions/startswith.md +++ b/docs/reference/sql/functions/startswith.md @@ -1,3 +1,7 @@ +--- +description: "Returns a boolean." +--- + # `startswith` diff --git a/docs/reference/sql/functions/std.md b/docs/reference/sql/functions/std.md index 7d6380bd9..a5864a2bc 100644 --- a/docs/reference/sql/functions/std.md +++ b/docs/reference/sql/functions/std.md @@ -1,3 +1,7 @@ +--- +description: "Returns the sample standard deviation calculated from values of a group." +--- + # `std` diff --git a/docs/reference/sql/functions/stddev.md b/docs/reference/sql/functions/stddev.md index ab2d70028..0fc9c0b27 100644 --- a/docs/reference/sql/functions/stddev.md +++ b/docs/reference/sql/functions/stddev.md @@ -1,3 +1,7 @@ +--- +description: "Returns the sample standard deviation calculated from values of a group." +--- + # `stddev` diff --git a/docs/reference/sql/functions/stddev_pop.md b/docs/reference/sql/functions/stddev_pop.md index 809e9593c..aabaf39c0 100644 --- a/docs/reference/sql/functions/stddev_pop.md +++ b/docs/reference/sql/functions/stddev_pop.md @@ -1,3 +1,7 @@ +--- +description: "Returns the population standard deviation calculated from values of a group." +--- + # `stddev_pop` diff --git a/docs/reference/sql/functions/stddev_samp.md b/docs/reference/sql/functions/stddev_samp.md index 0621439b2..c0b5c963d 100644 --- a/docs/reference/sql/functions/stddev_samp.md +++ b/docs/reference/sql/functions/stddev_samp.md @@ -1,3 +1,7 @@ +--- +description: "Returns the sample standard deviation calculated from values of a group." +--- + # `stddev_samp` diff --git a/docs/reference/sql/functions/str_to_map.md b/docs/reference/sql/functions/str_to_map.md index 2e9fc93b9..0a119c932 100644 --- a/docs/reference/sql/functions/str_to_map.md +++ b/docs/reference/sql/functions/str_to_map.md @@ -1,3 +1,7 @@ +--- +description: "Creates a map after splitting the text into key/value pairs using delimiters." +--- + # `str_to_map` diff --git a/docs/reference/sql/functions/string.md b/docs/reference/sql/functions/string.md index e1b1a96f5..68feaecf6 100644 --- a/docs/reference/sql/functions/string.md +++ b/docs/reference/sql/functions/string.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `string`." +--- + # `string` diff --git a/docs/reference/sql/functions/string_agg.md b/docs/reference/sql/functions/string_agg.md index 6595e6913..3b33da467 100644 --- a/docs/reference/sql/functions/string_agg.md +++ b/docs/reference/sql/functions/string_agg.md @@ -1,3 +1,7 @@ +--- +description: "Returns the concatenation of non-NULL input values, separated by the delimiter ordered by key." +--- + # `string_agg` diff --git a/docs/reference/sql/functions/struct.md b/docs/reference/sql/functions/struct.md index e4e8f5666..d5d69eef1 100644 --- a/docs/reference/sql/functions/struct.md +++ b/docs/reference/sql/functions/struct.md @@ -1,3 +1,7 @@ +--- +description: "Creates a struct with the given field values." +--- + # `struct` diff --git a/docs/reference/sql/functions/substr.md b/docs/reference/sql/functions/substr.md index 2875b9e0d..0145d58c6 100644 --- a/docs/reference/sql/functions/substr.md +++ b/docs/reference/sql/functions/substr.md @@ -1,3 +1,7 @@ +--- +description: "Returns the substring of `str` that starts at `pos` and is of length `len`, or the slice of byte array that starts at `pos` and is of length `len`." +--- + # `substr` diff --git a/docs/reference/sql/functions/substring.md b/docs/reference/sql/functions/substring.md index 6f1580d80..e272b50fa 100644 --- a/docs/reference/sql/functions/substring.md +++ b/docs/reference/sql/functions/substring.md @@ -1,3 +1,7 @@ +--- +description: "Returns the substring of `str` that starts at `pos` and is of length `len`, or the slice of byte array that starts at `pos` and is of length `len`." +--- + # `substring` diff --git a/docs/reference/sql/functions/substring_index.md b/docs/reference/sql/functions/substring_index.md index 46047971c..ed312f388 100644 --- a/docs/reference/sql/functions/substring_index.md +++ b/docs/reference/sql/functions/substring_index.md @@ -1,3 +1,7 @@ +--- +description: "Returns the substring from `str` before `count` occurrences of the delimiter `delim`." +--- + # `substring_index` diff --git a/docs/reference/sql/functions/sum.md b/docs/reference/sql/functions/sum.md index 389d55c90..7e1db7447 100644 --- a/docs/reference/sql/functions/sum.md +++ b/docs/reference/sql/functions/sum.md @@ -1,3 +1,7 @@ +--- +description: "Returns the sum calculated from values of a group." +--- + # `sum` diff --git a/docs/reference/sql/functions/tan.md b/docs/reference/sql/functions/tan.md index 9cec62b56..27706381d 100644 --- a/docs/reference/sql/functions/tan.md +++ b/docs/reference/sql/functions/tan.md @@ -1,3 +1,7 @@ +--- +description: "Returns the tangent of `expr`, as if computed by `java.lang.Math.tan`." +--- + # `tan` diff --git a/docs/reference/sql/functions/tanh.md b/docs/reference/sql/functions/tanh.md index 03e240363..d98512c92 100644 --- a/docs/reference/sql/functions/tanh.md +++ b/docs/reference/sql/functions/tanh.md @@ -1,3 +1,7 @@ +--- +description: "Returns the hyperbolic tangent of `expr`, as if computed by `java.lang.Math.tanh`." +--- + # `tanh` diff --git a/docs/reference/sql/functions/theta_difference.md b/docs/reference/sql/functions/theta_difference.md index e908826b4..bbcb8cbc3 100644 --- a/docs/reference/sql/functions/theta_difference.md +++ b/docs/reference/sql/functions/theta_difference.md @@ -1,3 +1,7 @@ +--- +description: "Subtracts two binary representations of Datasketches ThetaSketch objects from two input columns using a ThetaSketch AnotB object." +--- + # `theta_difference` diff --git a/docs/reference/sql/functions/theta_intersection.md b/docs/reference/sql/functions/theta_intersection.md index cdfe0a0a6..c3d161a3a 100644 --- a/docs/reference/sql/functions/theta_intersection.md +++ b/docs/reference/sql/functions/theta_intersection.md @@ -1,3 +1,7 @@ +--- +description: "Intersects two binary representations of Datasketches ThetaSketch objects from two input columns using a ThetaSketch Intersect object." +--- + # `theta_intersection` diff --git a/docs/reference/sql/functions/theta_intersection_agg.md b/docs/reference/sql/functions/theta_intersection_agg.md index f878fb443..4967c2553 100644 --- a/docs/reference/sql/functions/theta_intersection_agg.md +++ b/docs/reference/sql/functions/theta_intersection_agg.md @@ -1,3 +1,7 @@ +--- +description: "Returns the ThetaSketch's Compact binary representation by intersecting all the Theta sketches in the input column." +--- + # `theta_intersection_agg` diff --git a/docs/reference/sql/functions/theta_sketch_agg.md b/docs/reference/sql/functions/theta_sketch_agg.md index c6ce815af..684e93d23 100644 --- a/docs/reference/sql/functions/theta_sketch_agg.md +++ b/docs/reference/sql/functions/theta_sketch_agg.md @@ -1,3 +1,7 @@ +--- +description: "Returns the ThetaSketch compact binary representation." +--- + # `theta_sketch_agg` diff --git a/docs/reference/sql/functions/theta_sketch_estimate.md b/docs/reference/sql/functions/theta_sketch_estimate.md index c64a2498c..639e10b78 100644 --- a/docs/reference/sql/functions/theta_sketch_estimate.md +++ b/docs/reference/sql/functions/theta_sketch_estimate.md @@ -1,3 +1,7 @@ +--- +description: "Returns the estimated number of unique values given the binary representation of a Datasketches ThetaSketch." +--- + # `theta_sketch_estimate` diff --git a/docs/reference/sql/functions/theta_union.md b/docs/reference/sql/functions/theta_union.md index 974b5338e..5ab353160 100644 --- a/docs/reference/sql/functions/theta_union.md +++ b/docs/reference/sql/functions/theta_union.md @@ -1,3 +1,7 @@ +--- +description: "Merges two binary representations of Datasketches ThetaSketch objects using a ThetaSketch Union object." +--- + # `theta_union` diff --git a/docs/reference/sql/functions/theta_union_agg.md b/docs/reference/sql/functions/theta_union_agg.md index 0abebad48..4324804ba 100644 --- a/docs/reference/sql/functions/theta_union_agg.md +++ b/docs/reference/sql/functions/theta_union_agg.md @@ -1,3 +1,7 @@ +--- +description: "Returns the ThetaSketch's Compact binary representation." +--- + # `theta_union_agg` diff --git a/docs/reference/sql/functions/time.md b/docs/reference/sql/functions/time.md index b68662fa8..72d2aa917 100644 --- a/docs/reference/sql/functions/time.md +++ b/docs/reference/sql/functions/time.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `time`." +--- + # `time` diff --git a/docs/reference/sql/functions/time_bucket.md b/docs/reference/sql/functions/time_bucket.md index a9b5f3459..c7a5c49ba 100644 --- a/docs/reference/sql/functions/time_bucket.md +++ b/docs/reference/sql/functions/time_bucket.md @@ -1,3 +1,7 @@ +--- +description: "Returns the start of the bucket that `ts` falls into, where buckets are defined by the given `bucketSize` interval aligned to optional `origin`." +--- + # `time_bucket` diff --git a/docs/reference/sql/functions/time_diff.md b/docs/reference/sql/functions/time_diff.md index a38693e81..ff2829875 100644 --- a/docs/reference/sql/functions/time_diff.md +++ b/docs/reference/sql/functions/time_diff.md @@ -1,3 +1,7 @@ +--- +description: "Gets the difference between the times in the specified units." +--- + # `time_diff` diff --git a/docs/reference/sql/functions/time_from_micros.md b/docs/reference/sql/functions/time_from_micros.md index 3f9b4b231..12b5d190f 100644 --- a/docs/reference/sql/functions/time_from_micros.md +++ b/docs/reference/sql/functions/time_from_micros.md @@ -1,3 +1,7 @@ +--- +description: "Creates a TIME value from microseconds since midnight." +--- + # `time_from_micros` diff --git a/docs/reference/sql/functions/time_from_millis.md b/docs/reference/sql/functions/time_from_millis.md index ac5bd6d65..de8fd5e27 100644 --- a/docs/reference/sql/functions/time_from_millis.md +++ b/docs/reference/sql/functions/time_from_millis.md @@ -1,3 +1,7 @@ +--- +description: "Creates a TIME value from milliseconds since midnight." +--- + # `time_from_millis` diff --git a/docs/reference/sql/functions/time_from_seconds.md b/docs/reference/sql/functions/time_from_seconds.md index ef661c7b4..b26c11308 100644 --- a/docs/reference/sql/functions/time_from_seconds.md +++ b/docs/reference/sql/functions/time_from_seconds.md @@ -1,3 +1,7 @@ +--- +description: "Creates a TIME value from seconds since midnight." +--- + # `time_from_seconds` diff --git a/docs/reference/sql/functions/time_to_micros.md b/docs/reference/sql/functions/time_to_micros.md index 661061f95..23e3f6102 100644 --- a/docs/reference/sql/functions/time_to_micros.md +++ b/docs/reference/sql/functions/time_to_micros.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of microseconds since midnight for the given TIME value." +--- + # `time_to_micros` diff --git a/docs/reference/sql/functions/time_to_millis.md b/docs/reference/sql/functions/time_to_millis.md index 1ef51ba4e..784676e02 100644 --- a/docs/reference/sql/functions/time_to_millis.md +++ b/docs/reference/sql/functions/time_to_millis.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of milliseconds since midnight for the given TIME value." +--- + # `time_to_millis` diff --git a/docs/reference/sql/functions/time_to_seconds.md b/docs/reference/sql/functions/time_to_seconds.md index 95ccad6ed..f175918c1 100644 --- a/docs/reference/sql/functions/time_to_seconds.md +++ b/docs/reference/sql/functions/time_to_seconds.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of seconds since midnight for the given TIME value." +--- + # `time_to_seconds` diff --git a/docs/reference/sql/functions/time_trunc.md b/docs/reference/sql/functions/time_trunc.md index 955bc437b..3a323a036 100644 --- a/docs/reference/sql/functions/time_trunc.md +++ b/docs/reference/sql/functions/time_trunc.md @@ -1,3 +1,7 @@ +--- +description: "Returns `time` truncated to the `unit`." +--- + # `time_trunc` diff --git a/docs/reference/sql/functions/timestamp.md b/docs/reference/sql/functions/timestamp.md index c968dbd19..c922f7e6b 100644 --- a/docs/reference/sql/functions/timestamp.md +++ b/docs/reference/sql/functions/timestamp.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `timestamp`." +--- + # `timestamp` diff --git a/docs/reference/sql/functions/timestamp_micros.md b/docs/reference/sql/functions/timestamp_micros.md index 232a25593..61f43b085 100644 --- a/docs/reference/sql/functions/timestamp_micros.md +++ b/docs/reference/sql/functions/timestamp_micros.md @@ -1,3 +1,7 @@ +--- +description: "Creates timestamp from the number of microseconds since UTC epoch." +--- + # `timestamp_micros` diff --git a/docs/reference/sql/functions/timestamp_millis.md b/docs/reference/sql/functions/timestamp_millis.md index 6a140c617..5067fa2a7 100644 --- a/docs/reference/sql/functions/timestamp_millis.md +++ b/docs/reference/sql/functions/timestamp_millis.md @@ -1,3 +1,7 @@ +--- +description: "Creates timestamp from the number of milliseconds since UTC epoch." +--- + # `timestamp_millis` diff --git a/docs/reference/sql/functions/timestamp_seconds.md b/docs/reference/sql/functions/timestamp_seconds.md index 0f592e3e0..cc064b476 100644 --- a/docs/reference/sql/functions/timestamp_seconds.md +++ b/docs/reference/sql/functions/timestamp_seconds.md @@ -1,3 +1,7 @@ +--- +description: "Creates timestamp from the number of seconds (can be fractional) since UTC epoch." +--- + # `timestamp_seconds` diff --git a/docs/reference/sql/functions/tinyint.md b/docs/reference/sql/functions/tinyint.md index 2511d5cef..5ca124534 100644 --- a/docs/reference/sql/functions/tinyint.md +++ b/docs/reference/sql/functions/tinyint.md @@ -1,3 +1,7 @@ +--- +description: "Casts the value `expr` to the target data type `tinyint`." +--- + # `tinyint` diff --git a/docs/reference/sql/functions/to_avro.md b/docs/reference/sql/functions/to_avro.md index 717cbd32c..18ba401b9 100644 --- a/docs/reference/sql/functions/to_avro.md +++ b/docs/reference/sql/functions/to_avro.md @@ -1,3 +1,7 @@ +--- +description: "Converts a Catalyst binary input value into its corresponding Avro format result." +--- + # `to_avro` diff --git a/docs/reference/sql/functions/to_binary.md b/docs/reference/sql/functions/to_binary.md index d087f0fa0..e1535aad6 100644 --- a/docs/reference/sql/functions/to_binary.md +++ b/docs/reference/sql/functions/to_binary.md @@ -1,3 +1,7 @@ +--- +description: "Converts the input `str` to a binary value based on the supplied `fmt`." +--- + # `to_binary` diff --git a/docs/reference/sql/functions/to_char.md b/docs/reference/sql/functions/to_char.md index a2d60755c..013ee4eac 100644 --- a/docs/reference/sql/functions/to_char.md +++ b/docs/reference/sql/functions/to_char.md @@ -1,3 +1,7 @@ +--- +description: "Convert `expr` to a string based on the `format`." +--- + # `to_char` diff --git a/docs/reference/sql/functions/to_csv.md b/docs/reference/sql/functions/to_csv.md index 574d3df89..fdf733ae9 100644 --- a/docs/reference/sql/functions/to_csv.md +++ b/docs/reference/sql/functions/to_csv.md @@ -1,3 +1,7 @@ +--- +description: "Returns a CSV string with a given struct value" +--- + # `to_csv` diff --git a/docs/reference/sql/functions/to_date.md b/docs/reference/sql/functions/to_date.md index f8cf5636e..41defe580 100644 --- a/docs/reference/sql/functions/to_date.md +++ b/docs/reference/sql/functions/to_date.md @@ -1,3 +1,7 @@ +--- +description: "Parses the `date_str` expression with the `fmt` expression to a date." +--- + # `to_date` diff --git a/docs/reference/sql/functions/to_json.md b/docs/reference/sql/functions/to_json.md index e67851485..fcc9199a5 100644 --- a/docs/reference/sql/functions/to_json.md +++ b/docs/reference/sql/functions/to_json.md @@ -1,3 +1,7 @@ +--- +description: "Returns a JSON string with a given struct value" +--- + # `to_json` diff --git a/docs/reference/sql/functions/to_number.md b/docs/reference/sql/functions/to_number.md index 649b5b5af..5b1cbdc90 100644 --- a/docs/reference/sql/functions/to_number.md +++ b/docs/reference/sql/functions/to_number.md @@ -1,3 +1,7 @@ +--- +description: "Convert string 'expr' to a number based on the string format 'fmt'." +--- + # `to_number` diff --git a/docs/reference/sql/functions/to_protobuf.md b/docs/reference/sql/functions/to_protobuf.md index d6fe03bd7..769d04d79 100644 --- a/docs/reference/sql/functions/to_protobuf.md +++ b/docs/reference/sql/functions/to_protobuf.md @@ -1,3 +1,7 @@ +--- +description: "Converts a Catalyst binary input value into its corresponding Protobuf format result." +--- + # `to_protobuf` diff --git a/docs/reference/sql/functions/to_time.md b/docs/reference/sql/functions/to_time.md index b9baca378..ebba41ec9 100644 --- a/docs/reference/sql/functions/to_time.md +++ b/docs/reference/sql/functions/to_time.md @@ -1,3 +1,7 @@ +--- +description: "Parses the `str` expression with the `format` expression to a time." +--- + # `to_time` diff --git a/docs/reference/sql/functions/to_timestamp.md b/docs/reference/sql/functions/to_timestamp.md index 3fdaf6c97..834ded366 100644 --- a/docs/reference/sql/functions/to_timestamp.md +++ b/docs/reference/sql/functions/to_timestamp.md @@ -1,3 +1,7 @@ +--- +description: "Parses the `timestamp_str` expression with the `fmt` expression to a timestamp." +--- + # `to_timestamp` diff --git a/docs/reference/sql/functions/to_timestamp_ltz.md b/docs/reference/sql/functions/to_timestamp_ltz.md index d4e0dacbb..2f7d75d83 100644 --- a/docs/reference/sql/functions/to_timestamp_ltz.md +++ b/docs/reference/sql/functions/to_timestamp_ltz.md @@ -1,3 +1,7 @@ +--- +description: "Parses the `timestamp_str` expression with the `fmt` expression to a timestamp with local time zone." +--- + # `to_timestamp_ltz` diff --git a/docs/reference/sql/functions/to_timestamp_ntz.md b/docs/reference/sql/functions/to_timestamp_ntz.md index bf75aeeb8..19098af1c 100644 --- a/docs/reference/sql/functions/to_timestamp_ntz.md +++ b/docs/reference/sql/functions/to_timestamp_ntz.md @@ -1,3 +1,7 @@ +--- +description: "Parses the `timestamp_str` expression with the `fmt` expression to a timestamp without time zone." +--- + # `to_timestamp_ntz` diff --git a/docs/reference/sql/functions/to_unix_timestamp.md b/docs/reference/sql/functions/to_unix_timestamp.md index 816a1639b..1f0e5ebb6 100644 --- a/docs/reference/sql/functions/to_unix_timestamp.md +++ b/docs/reference/sql/functions/to_unix_timestamp.md @@ -1,3 +1,7 @@ +--- +description: "Returns the UNIX timestamp of the given time." +--- + # `to_unix_timestamp` diff --git a/docs/reference/sql/functions/to_utc_timestamp.md b/docs/reference/sql/functions/to_utc_timestamp.md index ba30c11c1..0d3fbacd7 100644 --- a/docs/reference/sql/functions/to_utc_timestamp.md +++ b/docs/reference/sql/functions/to_utc_timestamp.md @@ -1,3 +1,7 @@ +--- +description: "Given a timestamp like '2017-07-14 02:40:00.0', interprets it as a time in the given time zone, and renders that time as a timestamp in UTC." +--- + # `to_utc_timestamp` diff --git a/docs/reference/sql/functions/to_varchar.md b/docs/reference/sql/functions/to_varchar.md index 81b7c4fd1..035c3d7e8 100644 --- a/docs/reference/sql/functions/to_varchar.md +++ b/docs/reference/sql/functions/to_varchar.md @@ -1,3 +1,7 @@ +--- +description: "Convert `expr` to a string based on the `format`." +--- + # `to_varchar` diff --git a/docs/reference/sql/functions/to_variant_object.md b/docs/reference/sql/functions/to_variant_object.md index 881eee75c..532f8c8aa 100644 --- a/docs/reference/sql/functions/to_variant_object.md +++ b/docs/reference/sql/functions/to_variant_object.md @@ -1,3 +1,7 @@ +--- +description: "Convert a nested input (array/map/struct) into a variant where maps and structs are converted to variant objects which are unordered unlike SQL structs." +--- + # `to_variant_object` diff --git a/docs/reference/sql/functions/to_xml.md b/docs/reference/sql/functions/to_xml.md index e9bd57d2b..ca9ad58a5 100644 --- a/docs/reference/sql/functions/to_xml.md +++ b/docs/reference/sql/functions/to_xml.md @@ -1,3 +1,7 @@ +--- +description: "Returns a XML string with a given struct value" +--- + # `to_xml` diff --git a/docs/reference/sql/functions/transform.md b/docs/reference/sql/functions/transform.md index 43704cce5..06d41dcce 100644 --- a/docs/reference/sql/functions/transform.md +++ b/docs/reference/sql/functions/transform.md @@ -1,3 +1,7 @@ +--- +description: "Transforms elements in an array using the function." +--- + # `transform` diff --git a/docs/reference/sql/functions/transform_keys.md b/docs/reference/sql/functions/transform_keys.md index 9f5e32013..84a38303d 100644 --- a/docs/reference/sql/functions/transform_keys.md +++ b/docs/reference/sql/functions/transform_keys.md @@ -1,3 +1,7 @@ +--- +description: "Transforms elements in a map using the function." +--- + # `transform_keys` diff --git a/docs/reference/sql/functions/transform_values.md b/docs/reference/sql/functions/transform_values.md index 203f901ce..a0be93d01 100644 --- a/docs/reference/sql/functions/transform_values.md +++ b/docs/reference/sql/functions/transform_values.md @@ -1,3 +1,7 @@ +--- +description: "Transforms values in the map using the function." +--- + # `transform_values` diff --git a/docs/reference/sql/functions/translate.md b/docs/reference/sql/functions/translate.md index beaba8c1d..651503cb2 100644 --- a/docs/reference/sql/functions/translate.md +++ b/docs/reference/sql/functions/translate.md @@ -1,3 +1,7 @@ +--- +description: "Translates the `input` string by replacing the characters present in the `from` string with the corresponding characters in the `to` string." +--- + # `translate` diff --git a/docs/reference/sql/functions/trim.md b/docs/reference/sql/functions/trim.md index 248d55119..ed62b2bd4 100644 --- a/docs/reference/sql/functions/trim.md +++ b/docs/reference/sql/functions/trim.md @@ -1,3 +1,7 @@ +--- +description: "Removes the leading and trailing space characters from `str`." +--- + # `trim` diff --git a/docs/reference/sql/functions/trunc.md b/docs/reference/sql/functions/trunc.md index 2fe8f496a..7bf979780 100644 --- a/docs/reference/sql/functions/trunc.md +++ b/docs/reference/sql/functions/trunc.md @@ -1,3 +1,7 @@ +--- +description: "Returns `date` with the time portion of the day truncated to the unit specified by the format model `fmt`." +--- + # `trunc` diff --git a/docs/reference/sql/functions/try_add.md b/docs/reference/sql/functions/try_add.md index 74fb93e92..c146033d5 100644 --- a/docs/reference/sql/functions/try_add.md +++ b/docs/reference/sql/functions/try_add.md @@ -1,3 +1,7 @@ +--- +description: "Returns the sum of `expr1`and `expr2` and the result is null on overflow." +--- + # `try_add` diff --git a/docs/reference/sql/functions/try_aes_decrypt.md b/docs/reference/sql/functions/try_aes_decrypt.md index c1137b941..024f21e4b 100644 --- a/docs/reference/sql/functions/try_aes_decrypt.md +++ b/docs/reference/sql/functions/try_aes_decrypt.md @@ -1,3 +1,7 @@ +--- +description: "This is a special version of `aes_decrypt` that performs the same operation, but returns a NULL value instead of raising an error if the decryption cannot be performed." +--- + # `try_aes_decrypt` diff --git a/docs/reference/sql/functions/try_avg.md b/docs/reference/sql/functions/try_avg.md index 1b46ecadc..3378720a0 100644 --- a/docs/reference/sql/functions/try_avg.md +++ b/docs/reference/sql/functions/try_avg.md @@ -1,3 +1,7 @@ +--- +description: "Returns the mean calculated from values of a group and the result is null on overflow." +--- + # `try_avg` diff --git a/docs/reference/sql/functions/try_divide.md b/docs/reference/sql/functions/try_divide.md index 1e3db28ab..b0a2eb9f4 100644 --- a/docs/reference/sql/functions/try_divide.md +++ b/docs/reference/sql/functions/try_divide.md @@ -1,3 +1,7 @@ +--- +description: "Returns `dividend`/`divisor`." +--- + # `try_divide` diff --git a/docs/reference/sql/functions/try_element_at.md b/docs/reference/sql/functions/try_element_at.md index d24fa4822..7e1fb1f8d 100644 --- a/docs/reference/sql/functions/try_element_at.md +++ b/docs/reference/sql/functions/try_element_at.md @@ -1,3 +1,7 @@ +--- +description: "Returns element of array at given (1-based) index." +--- + # `try_element_at` diff --git a/docs/reference/sql/functions/try_make_interval.md b/docs/reference/sql/functions/try_make_interval.md index add190f2a..0f1636813 100644 --- a/docs/reference/sql/functions/try_make_interval.md +++ b/docs/reference/sql/functions/try_make_interval.md @@ -1,3 +1,7 @@ +--- +description: "This is a special version of `make_interval` that performs the same operation, but returns NULL when an overflow occurs." +--- + # `try_make_interval` diff --git a/docs/reference/sql/functions/try_make_timestamp.md b/docs/reference/sql/functions/try_make_timestamp.md index 3362b8d7d..2812073c5 100644 --- a/docs/reference/sql/functions/try_make_timestamp.md +++ b/docs/reference/sql/functions/try_make_timestamp.md @@ -1,3 +1,7 @@ +--- +description: "Try to create a timestamp from year, month, day, hour, min, sec and timezone fields." +--- + # `try_make_timestamp` diff --git a/docs/reference/sql/functions/try_make_timestamp_ltz.md b/docs/reference/sql/functions/try_make_timestamp_ltz.md index 37c9b708c..1eabaf68f 100644 --- a/docs/reference/sql/functions/try_make_timestamp_ltz.md +++ b/docs/reference/sql/functions/try_make_timestamp_ltz.md @@ -1,3 +1,7 @@ +--- +description: "Try to create the current timestamp with local time zone from year, month, day, hour, min, sec and (optional) timezone fields." +--- + # `try_make_timestamp_ltz` diff --git a/docs/reference/sql/functions/try_make_timestamp_ntz.md b/docs/reference/sql/functions/try_make_timestamp_ntz.md index b2a4cd0da..7ff6069d1 100644 --- a/docs/reference/sql/functions/try_make_timestamp_ntz.md +++ b/docs/reference/sql/functions/try_make_timestamp_ntz.md @@ -1,3 +1,7 @@ +--- +description: "Try to create local date-time from year, month, day, hour, min, sec fields." +--- + # `try_make_timestamp_ntz` diff --git a/docs/reference/sql/functions/try_mod.md b/docs/reference/sql/functions/try_mod.md index 102ddc10c..fa31b7966 100644 --- a/docs/reference/sql/functions/try_mod.md +++ b/docs/reference/sql/functions/try_mod.md @@ -1,3 +1,7 @@ +--- +description: "Returns the remainder after `expr1`/`expr2`." +--- + # `try_mod` diff --git a/docs/reference/sql/functions/try_multiply.md b/docs/reference/sql/functions/try_multiply.md index 46c6f4bd5..4b49349d3 100644 --- a/docs/reference/sql/functions/try_multiply.md +++ b/docs/reference/sql/functions/try_multiply.md @@ -1,3 +1,7 @@ +--- +description: "Returns `expr1`*`expr2` and the result is null on overflow." +--- + # `try_multiply` diff --git a/docs/reference/sql/functions/try_parse_json.md b/docs/reference/sql/functions/try_parse_json.md index 0d1b3a063..8a134c12b 100644 --- a/docs/reference/sql/functions/try_parse_json.md +++ b/docs/reference/sql/functions/try_parse_json.md @@ -1,3 +1,7 @@ +--- +description: "Parse a JSON string as a Variant value." +--- + # `try_parse_json` diff --git a/docs/reference/sql/functions/try_parse_url.md b/docs/reference/sql/functions/try_parse_url.md index b794af854..46aea6991 100644 --- a/docs/reference/sql/functions/try_parse_url.md +++ b/docs/reference/sql/functions/try_parse_url.md @@ -1,3 +1,7 @@ +--- +description: "This is a special version of `parse_url` that performs the same operation, but returns a NULL value instead of raising an error if the parsing cannot be performed." +--- + # `try_parse_url` diff --git a/docs/reference/sql/functions/try_reflect.md b/docs/reference/sql/functions/try_reflect.md index d6f05b159..4920daf52 100644 --- a/docs/reference/sql/functions/try_reflect.md +++ b/docs/reference/sql/functions/try_reflect.md @@ -1,3 +1,7 @@ +--- +description: "This is a special version of `reflect` that performs the same operation, but returns a NULL value instead of raising an error if the invoke method thrown exception." +--- + # `try_reflect` diff --git a/docs/reference/sql/functions/try_subtract.md b/docs/reference/sql/functions/try_subtract.md index 129a39166..3295447df 100644 --- a/docs/reference/sql/functions/try_subtract.md +++ b/docs/reference/sql/functions/try_subtract.md @@ -1,3 +1,7 @@ +--- +description: "Returns `expr1`-`expr2` and the result is null on overflow." +--- + # `try_subtract` diff --git a/docs/reference/sql/functions/try_sum.md b/docs/reference/sql/functions/try_sum.md index ab1e72b80..23a36d8bf 100644 --- a/docs/reference/sql/functions/try_sum.md +++ b/docs/reference/sql/functions/try_sum.md @@ -1,3 +1,7 @@ +--- +description: "Returns the sum calculated from values of a group and the result is null on overflow." +--- + # `try_sum` diff --git a/docs/reference/sql/functions/try_to_binary.md b/docs/reference/sql/functions/try_to_binary.md index 72f070f82..c55e0a746 100644 --- a/docs/reference/sql/functions/try_to_binary.md +++ b/docs/reference/sql/functions/try_to_binary.md @@ -1,3 +1,7 @@ +--- +description: "This is a special version of `to_binary` that performs the same operation, but returns a NULL value instead of raising an error if the conversion cannot be performed." +--- + # `try_to_binary` diff --git a/docs/reference/sql/functions/try_to_date.md b/docs/reference/sql/functions/try_to_date.md index f5e4e1ac1..63eb0b2c6 100644 --- a/docs/reference/sql/functions/try_to_date.md +++ b/docs/reference/sql/functions/try_to_date.md @@ -1,3 +1,7 @@ +--- +description: "Parses the `date_str` expression with the `fmt` expression to a date." +--- + # `try_to_date` diff --git a/docs/reference/sql/functions/try_to_number.md b/docs/reference/sql/functions/try_to_number.md index 7eb320718..9d1745fbf 100644 --- a/docs/reference/sql/functions/try_to_number.md +++ b/docs/reference/sql/functions/try_to_number.md @@ -1,3 +1,7 @@ +--- +description: "Convert string 'expr' to a number based on the string format `fmt`." +--- + # `try_to_number` diff --git a/docs/reference/sql/functions/try_to_time.md b/docs/reference/sql/functions/try_to_time.md index 64fd89466..83e487228 100644 --- a/docs/reference/sql/functions/try_to_time.md +++ b/docs/reference/sql/functions/try_to_time.md @@ -1,3 +1,7 @@ +--- +description: "Parses the `str` expression with the `format` expression to a time." +--- + # `try_to_time` diff --git a/docs/reference/sql/functions/try_to_timestamp.md b/docs/reference/sql/functions/try_to_timestamp.md index 8d2645a5e..6f1c401ec 100644 --- a/docs/reference/sql/functions/try_to_timestamp.md +++ b/docs/reference/sql/functions/try_to_timestamp.md @@ -1,3 +1,7 @@ +--- +description: "Parses the `timestamp_str` expression with the `fmt` expression to a timestamp." +--- + # `try_to_timestamp` diff --git a/docs/reference/sql/functions/try_url_decode.md b/docs/reference/sql/functions/try_url_decode.md index ff0b5fa11..64f88952c 100644 --- a/docs/reference/sql/functions/try_url_decode.md +++ b/docs/reference/sql/functions/try_url_decode.md @@ -1,3 +1,7 @@ +--- +description: "This is a special version of `url_decode` that performs the same operation, but returns a NULL value instead of raising an error if the decoding cannot be performed." +--- + # `try_url_decode` diff --git a/docs/reference/sql/functions/try_validate_utf8.md b/docs/reference/sql/functions/try_validate_utf8.md index e13ed4ab3..71000a294 100644 --- a/docs/reference/sql/functions/try_validate_utf8.md +++ b/docs/reference/sql/functions/try_validate_utf8.md @@ -1,3 +1,7 @@ +--- +description: "Returns the original string if `str` is a valid UTF-8 string, otherwise returns NULL." +--- + # `try_validate_utf8` diff --git a/docs/reference/sql/functions/try_variant_get.md b/docs/reference/sql/functions/try_variant_get.md index 80c3cff8f..0986770c0 100644 --- a/docs/reference/sql/functions/try_variant_get.md +++ b/docs/reference/sql/functions/try_variant_get.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a sub-variant from `v` according to `path`, and then cast the sub-variant to `type`." +--- + # `try_variant_get` diff --git a/docs/reference/sql/functions/tuple_difference_double.md b/docs/reference/sql/functions/tuple_difference_double.md index 40535fae7..22cb91d37 100644 --- a/docs/reference/sql/functions/tuple_difference_double.md +++ b/docs/reference/sql/functions/tuple_difference_double.md @@ -1,3 +1,7 @@ +--- +description: "Subtracts two binary representations of Datasketches TupleSketch objects with double summary data type using a TupleSketch AnotB object." +--- + # `tuple_difference_double` diff --git a/docs/reference/sql/functions/tuple_difference_integer.md b/docs/reference/sql/functions/tuple_difference_integer.md index 85ab8d15a..77c4af52b 100644 --- a/docs/reference/sql/functions/tuple_difference_integer.md +++ b/docs/reference/sql/functions/tuple_difference_integer.md @@ -1,3 +1,7 @@ +--- +description: "Subtracts two binary representations of Datasketches TupleSketch objects with integer summary data type using a TupleSketch AnotB object." +--- + # `tuple_difference_integer` diff --git a/docs/reference/sql/functions/tuple_difference_theta_double.md b/docs/reference/sql/functions/tuple_difference_theta_double.md index 834485c85..78eb7ed58 100644 --- a/docs/reference/sql/functions/tuple_difference_theta_double.md +++ b/docs/reference/sql/functions/tuple_difference_theta_double.md @@ -1,3 +1,7 @@ +--- +description: "Subtracts the binary representation of a Datasketches ThetaSketch from a TupleSketch with double summary data type using a TupleSketch AnotB object." +--- + # `tuple_difference_theta_double` diff --git a/docs/reference/sql/functions/tuple_difference_theta_integer.md b/docs/reference/sql/functions/tuple_difference_theta_integer.md index b51d78cd5..77e30e281 100644 --- a/docs/reference/sql/functions/tuple_difference_theta_integer.md +++ b/docs/reference/sql/functions/tuple_difference_theta_integer.md @@ -1,3 +1,7 @@ +--- +description: "Subtracts the binary representation of a Datasketches ThetaSketch from a TupleSketch with integer summary data type using a TupleSketch AnotB object." +--- + # `tuple_difference_theta_integer` diff --git a/docs/reference/sql/functions/tuple_intersection_agg_double.md b/docs/reference/sql/functions/tuple_intersection_agg_double.md index 1fd5fb852..b47677055 100644 --- a/docs/reference/sql/functions/tuple_intersection_agg_double.md +++ b/docs/reference/sql/functions/tuple_intersection_agg_double.md @@ -1,3 +1,7 @@ +--- +description: "Returns the intersected TupleSketch compact binary representation." +--- + # `tuple_intersection_agg_double` diff --git a/docs/reference/sql/functions/tuple_intersection_agg_integer.md b/docs/reference/sql/functions/tuple_intersection_agg_integer.md index aa10115f2..dcdbf1f7e 100644 --- a/docs/reference/sql/functions/tuple_intersection_agg_integer.md +++ b/docs/reference/sql/functions/tuple_intersection_agg_integer.md @@ -1,3 +1,7 @@ +--- +description: "Returns the intersected TupleSketch compact binary representation." +--- + # `tuple_intersection_agg_integer` diff --git a/docs/reference/sql/functions/tuple_intersection_double.md b/docs/reference/sql/functions/tuple_intersection_double.md index 8d418df01..afab60574 100644 --- a/docs/reference/sql/functions/tuple_intersection_double.md +++ b/docs/reference/sql/functions/tuple_intersection_double.md @@ -1,3 +1,7 @@ +--- +description: "Intersects two binary representations of Datasketches TupleSketch objects with double summary data type using a TupleSketch Intersection object." +--- + # `tuple_intersection_double` diff --git a/docs/reference/sql/functions/tuple_intersection_integer.md b/docs/reference/sql/functions/tuple_intersection_integer.md index 2157c744b..d1efc838e 100644 --- a/docs/reference/sql/functions/tuple_intersection_integer.md +++ b/docs/reference/sql/functions/tuple_intersection_integer.md @@ -1,3 +1,7 @@ +--- +description: "Intersects two binary representations of Datasketches TupleSketch objects with integer summary data type using a TupleSketch Intersection object." +--- + # `tuple_intersection_integer` diff --git a/docs/reference/sql/functions/tuple_intersection_theta_double.md b/docs/reference/sql/functions/tuple_intersection_theta_double.md index 0c388c102..ba85285af 100644 --- a/docs/reference/sql/functions/tuple_intersection_theta_double.md +++ b/docs/reference/sql/functions/tuple_intersection_theta_double.md @@ -1,3 +1,7 @@ +--- +description: "Intersects the binary representation of a Datasketches TupleSketch with double summary data type with the binary representation of a Datasketches ThetaSketch using a TupleSketch Intersection object." +--- + # `tuple_intersection_theta_double` diff --git a/docs/reference/sql/functions/tuple_intersection_theta_integer.md b/docs/reference/sql/functions/tuple_intersection_theta_integer.md index 076033de4..6894b08ce 100644 --- a/docs/reference/sql/functions/tuple_intersection_theta_integer.md +++ b/docs/reference/sql/functions/tuple_intersection_theta_integer.md @@ -1,3 +1,7 @@ +--- +description: "Intersects the binary representation of a Datasketches TupleSketch with integer summary data type with the binary representation of a Datasketches ThetaSketch using a TupleSketch Intersection object." +--- + # `tuple_intersection_theta_integer` diff --git a/docs/reference/sql/functions/tuple_sketch_agg_double.md b/docs/reference/sql/functions/tuple_sketch_agg_double.md index 7b3ae1f23..9b939b5fb 100644 --- a/docs/reference/sql/functions/tuple_sketch_agg_double.md +++ b/docs/reference/sql/functions/tuple_sketch_agg_double.md @@ -1,3 +1,7 @@ +--- +description: "Returns the TupleSketch compact binary representation." +--- + # `tuple_sketch_agg_double` diff --git a/docs/reference/sql/functions/tuple_sketch_agg_integer.md b/docs/reference/sql/functions/tuple_sketch_agg_integer.md index 028c63821..69825b2ec 100644 --- a/docs/reference/sql/functions/tuple_sketch_agg_integer.md +++ b/docs/reference/sql/functions/tuple_sketch_agg_integer.md @@ -1,3 +1,7 @@ +--- +description: "Returns the TupleSketch compact binary representation." +--- + # `tuple_sketch_agg_integer` diff --git a/docs/reference/sql/functions/tuple_sketch_estimate_double.md b/docs/reference/sql/functions/tuple_sketch_estimate_double.md index c65ef73e8..39196041a 100644 --- a/docs/reference/sql/functions/tuple_sketch_estimate_double.md +++ b/docs/reference/sql/functions/tuple_sketch_estimate_double.md @@ -1,3 +1,7 @@ +--- +description: "Returns the estimated number of unique values given the binary representation of a Datasketches TupleSketch." +--- + # `tuple_sketch_estimate_double` diff --git a/docs/reference/sql/functions/tuple_sketch_estimate_integer.md b/docs/reference/sql/functions/tuple_sketch_estimate_integer.md index 74ac6756a..7dd89715d 100644 --- a/docs/reference/sql/functions/tuple_sketch_estimate_integer.md +++ b/docs/reference/sql/functions/tuple_sketch_estimate_integer.md @@ -1,3 +1,7 @@ +--- +description: "Returns the estimated number of unique values given the binary representation of a Datasketches TupleSketch." +--- + # `tuple_sketch_estimate_integer` diff --git a/docs/reference/sql/functions/tuple_sketch_summary_double.md b/docs/reference/sql/functions/tuple_sketch_summary_double.md index 47d7ccf66..c136ba435 100644 --- a/docs/reference/sql/functions/tuple_sketch_summary_double.md +++ b/docs/reference/sql/functions/tuple_sketch_summary_double.md @@ -1,3 +1,7 @@ +--- +description: "Aggregates the summary values from a double summary type Datasketches TupleSketch." +--- + # `tuple_sketch_summary_double` diff --git a/docs/reference/sql/functions/tuple_sketch_summary_integer.md b/docs/reference/sql/functions/tuple_sketch_summary_integer.md index 65fc5d19e..81bfceda6 100644 --- a/docs/reference/sql/functions/tuple_sketch_summary_integer.md +++ b/docs/reference/sql/functions/tuple_sketch_summary_integer.md @@ -1,3 +1,7 @@ +--- +description: "Aggregates the summary values from a integer summary type Datasketches TupleSketch." +--- + # `tuple_sketch_summary_integer` diff --git a/docs/reference/sql/functions/tuple_sketch_theta_double.md b/docs/reference/sql/functions/tuple_sketch_theta_double.md index f6b01cbb5..6e7cd9cd4 100644 --- a/docs/reference/sql/functions/tuple_sketch_theta_double.md +++ b/docs/reference/sql/functions/tuple_sketch_theta_double.md @@ -1,3 +1,7 @@ +--- +description: "Returns the theta value (sampling rate) from a Datasketches TupleSketch." +--- + # `tuple_sketch_theta_double` diff --git a/docs/reference/sql/functions/tuple_sketch_theta_integer.md b/docs/reference/sql/functions/tuple_sketch_theta_integer.md index 896dfcc76..8a47d5b53 100644 --- a/docs/reference/sql/functions/tuple_sketch_theta_integer.md +++ b/docs/reference/sql/functions/tuple_sketch_theta_integer.md @@ -1,3 +1,7 @@ +--- +description: "Returns the theta value (sampling rate) from a Datasketches TupleSketch." +--- + # `tuple_sketch_theta_integer` diff --git a/docs/reference/sql/functions/tuple_union_agg_double.md b/docs/reference/sql/functions/tuple_union_agg_double.md index 3601b031a..3ee4e7b60 100644 --- a/docs/reference/sql/functions/tuple_union_agg_double.md +++ b/docs/reference/sql/functions/tuple_union_agg_double.md @@ -1,3 +1,7 @@ +--- +description: "Returns the unioned TupleSketch compact binary representation." +--- + # `tuple_union_agg_double` diff --git a/docs/reference/sql/functions/tuple_union_agg_integer.md b/docs/reference/sql/functions/tuple_union_agg_integer.md index 323c1d24f..f59149619 100644 --- a/docs/reference/sql/functions/tuple_union_agg_integer.md +++ b/docs/reference/sql/functions/tuple_union_agg_integer.md @@ -1,3 +1,7 @@ +--- +description: "Returns the unioned TupleSketch compact binary representation." +--- + # `tuple_union_agg_integer` diff --git a/docs/reference/sql/functions/tuple_union_double.md b/docs/reference/sql/functions/tuple_union_double.md index 02b167b0b..cd854a639 100644 --- a/docs/reference/sql/functions/tuple_union_double.md +++ b/docs/reference/sql/functions/tuple_union_double.md @@ -1,3 +1,7 @@ +--- +description: "Merges two binary representations of Datasketches TupleSketch objects with double summary data type using a TupleSketch Union object." +--- + # `tuple_union_double` diff --git a/docs/reference/sql/functions/tuple_union_integer.md b/docs/reference/sql/functions/tuple_union_integer.md index fb8e2413f..e14aa83c9 100644 --- a/docs/reference/sql/functions/tuple_union_integer.md +++ b/docs/reference/sql/functions/tuple_union_integer.md @@ -1,3 +1,7 @@ +--- +description: "Merges two binary representations of Datasketches TupleSketch objects with integer summary data type using a TupleSketch Union object." +--- + # `tuple_union_integer` diff --git a/docs/reference/sql/functions/tuple_union_theta_double.md b/docs/reference/sql/functions/tuple_union_theta_double.md index 611ae3523..fc0d2a92f 100644 --- a/docs/reference/sql/functions/tuple_union_theta_double.md +++ b/docs/reference/sql/functions/tuple_union_theta_double.md @@ -1,3 +1,7 @@ +--- +description: "Merges the binary representation of a Datasketches TupleSketch with double summary data type with the binary representation of a Datasketches ThetaSketch using a TupleSketch Union object." +--- + # `tuple_union_theta_double` diff --git a/docs/reference/sql/functions/tuple_union_theta_integer.md b/docs/reference/sql/functions/tuple_union_theta_integer.md index 9a6f0561b..08d0db6bc 100644 --- a/docs/reference/sql/functions/tuple_union_theta_integer.md +++ b/docs/reference/sql/functions/tuple_union_theta_integer.md @@ -1,3 +1,7 @@ +--- +description: "Merges the binary representation of a Datasketches TupleSketch with integer summary data type with the binary representation of a Datasketches ThetaSketch using a TupleSketch Union object." +--- + # `tuple_union_theta_integer` diff --git a/docs/reference/sql/functions/typeof.md b/docs/reference/sql/functions/typeof.md index 9c99fabf0..224c38084 100644 --- a/docs/reference/sql/functions/typeof.md +++ b/docs/reference/sql/functions/typeof.md @@ -1,3 +1,7 @@ +--- +description: "Return DDL-formatted type string for the data type of the input." +--- + # `typeof` diff --git a/docs/reference/sql/functions/ucase.md b/docs/reference/sql/functions/ucase.md index 1323a8ed1..19372a314 100644 --- a/docs/reference/sql/functions/ucase.md +++ b/docs/reference/sql/functions/ucase.md @@ -1,3 +1,7 @@ +--- +description: "Returns `str` with all characters changed to uppercase." +--- + # `ucase` diff --git a/docs/reference/sql/functions/unbase64.md b/docs/reference/sql/functions/unbase64.md index b75e72259..3ccc0cbee 100644 --- a/docs/reference/sql/functions/unbase64.md +++ b/docs/reference/sql/functions/unbase64.md @@ -1,3 +1,7 @@ +--- +description: "Converts the argument from a base 64 string `str` to a binary." +--- + # `unbase64` diff --git a/docs/reference/sql/functions/unhex.md b/docs/reference/sql/functions/unhex.md index 037fa9f74..712dc8c1a 100644 --- a/docs/reference/sql/functions/unhex.md +++ b/docs/reference/sql/functions/unhex.md @@ -1,3 +1,7 @@ +--- +description: "Converts hexadecimal `expr` to binary." +--- + # `unhex` diff --git a/docs/reference/sql/functions/uniform.md b/docs/reference/sql/functions/uniform.md index 4b68a3b2c..5ebdfe4e4 100644 --- a/docs/reference/sql/functions/uniform.md +++ b/docs/reference/sql/functions/uniform.md @@ -1,3 +1,7 @@ +--- +description: "Returns a random value with independent and identically distributed (i.i.d.) values with the specified range of numbers." +--- + # `uniform` diff --git a/docs/reference/sql/functions/unix_date.md b/docs/reference/sql/functions/unix_date.md index 83a312444..155d48dbe 100644 --- a/docs/reference/sql/functions/unix_date.md +++ b/docs/reference/sql/functions/unix_date.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of days since 1970-01-01." +--- + # `unix_date` diff --git a/docs/reference/sql/functions/unix_micros.md b/docs/reference/sql/functions/unix_micros.md index 548b39510..b10b4beba 100644 --- a/docs/reference/sql/functions/unix_micros.md +++ b/docs/reference/sql/functions/unix_micros.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of microseconds since 1970-01-01 00:00:00 UTC." +--- + # `unix_micros` diff --git a/docs/reference/sql/functions/unix_millis.md b/docs/reference/sql/functions/unix_millis.md index 7f5780db7..037f00352 100644 --- a/docs/reference/sql/functions/unix_millis.md +++ b/docs/reference/sql/functions/unix_millis.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of milliseconds since 1970-01-01 00:00:00 UTC." +--- + # `unix_millis` diff --git a/docs/reference/sql/functions/unix_seconds.md b/docs/reference/sql/functions/unix_seconds.md index a3fdcd79f..68fd772c8 100644 --- a/docs/reference/sql/functions/unix_seconds.md +++ b/docs/reference/sql/functions/unix_seconds.md @@ -1,3 +1,7 @@ +--- +description: "Returns the number of seconds since 1970-01-01 00:00:00 UTC." +--- + # `unix_seconds` diff --git a/docs/reference/sql/functions/unix_timestamp.md b/docs/reference/sql/functions/unix_timestamp.md index 5435e913f..a97db44de 100644 --- a/docs/reference/sql/functions/unix_timestamp.md +++ b/docs/reference/sql/functions/unix_timestamp.md @@ -1,3 +1,7 @@ +--- +description: "Returns the UNIX timestamp of current or specified time." +--- + # `unix_timestamp` diff --git a/docs/reference/sql/functions/upper.md b/docs/reference/sql/functions/upper.md index 017b92cdb..a6f703d0d 100644 --- a/docs/reference/sql/functions/upper.md +++ b/docs/reference/sql/functions/upper.md @@ -1,3 +1,7 @@ +--- +description: "Returns `str` with all characters changed to uppercase." +--- + # `upper` diff --git a/docs/reference/sql/functions/url_decode.md b/docs/reference/sql/functions/url_decode.md index 45b0c16b0..7ae9b97ce 100644 --- a/docs/reference/sql/functions/url_decode.md +++ b/docs/reference/sql/functions/url_decode.md @@ -1,3 +1,7 @@ +--- +description: "Decodes a `str` in 'application/x-www-form-urlencoded' format using a specific encoding scheme." +--- + # `url_decode` diff --git a/docs/reference/sql/functions/url_encode.md b/docs/reference/sql/functions/url_encode.md index cba9ce2c3..d4410e247 100644 --- a/docs/reference/sql/functions/url_encode.md +++ b/docs/reference/sql/functions/url_encode.md @@ -1,3 +1,7 @@ +--- +description: "Translates a string into 'application/x-www-form-urlencoded' format using a specific encoding scheme." +--- + # `url_encode` diff --git a/docs/reference/sql/functions/user.md b/docs/reference/sql/functions/user.md index c58b34e5a..796492e68 100644 --- a/docs/reference/sql/functions/user.md +++ b/docs/reference/sql/functions/user.md @@ -1,3 +1,7 @@ +--- +description: "user name of current execution context." +--- + # `user` diff --git a/docs/reference/sql/functions/uuid.md b/docs/reference/sql/functions/uuid.md index a155344d6..5ba9b96f8 100644 --- a/docs/reference/sql/functions/uuid.md +++ b/docs/reference/sql/functions/uuid.md @@ -1,3 +1,7 @@ +--- +description: "Returns an universally unique identifier (UUID) string." +--- + # `uuid` diff --git a/docs/reference/sql/functions/validate_utf8.md b/docs/reference/sql/functions/validate_utf8.md index 9f4f7206b..bbf2b1ca3 100644 --- a/docs/reference/sql/functions/validate_utf8.md +++ b/docs/reference/sql/functions/validate_utf8.md @@ -1,3 +1,7 @@ +--- +description: "Returns the original string if `str` is a valid UTF-8 string, otherwise throws an exception." +--- + # `validate_utf8` diff --git a/docs/reference/sql/functions/var_pop.md b/docs/reference/sql/functions/var_pop.md index 42861bcb8..63acbbb26 100644 --- a/docs/reference/sql/functions/var_pop.md +++ b/docs/reference/sql/functions/var_pop.md @@ -1,3 +1,7 @@ +--- +description: "Returns the population variance calculated from values of a group." +--- + # `var_pop` diff --git a/docs/reference/sql/functions/var_samp.md b/docs/reference/sql/functions/var_samp.md index 881ffa81d..6a74e890d 100644 --- a/docs/reference/sql/functions/var_samp.md +++ b/docs/reference/sql/functions/var_samp.md @@ -1,3 +1,7 @@ +--- +description: "Returns the sample variance calculated from values of a group." +--- + # `var_samp` diff --git a/docs/reference/sql/functions/variance.md b/docs/reference/sql/functions/variance.md index bac54287a..69e9d2899 100644 --- a/docs/reference/sql/functions/variance.md +++ b/docs/reference/sql/functions/variance.md @@ -1,3 +1,7 @@ +--- +description: "Returns the sample variance calculated from values of a group." +--- + # `variance` diff --git a/docs/reference/sql/functions/variant_explode.md b/docs/reference/sql/functions/variant_explode.md index bdd9adf82..2fc148fe3 100644 --- a/docs/reference/sql/functions/variant_explode.md +++ b/docs/reference/sql/functions/variant_explode.md @@ -1,3 +1,7 @@ +--- +description: "It separates a variant object/array into multiple rows containing its fields/elements." +--- + # `variant_explode` diff --git a/docs/reference/sql/functions/variant_explode_outer.md b/docs/reference/sql/functions/variant_explode_outer.md index ec552ee9e..9af3e9c48 100644 --- a/docs/reference/sql/functions/variant_explode_outer.md +++ b/docs/reference/sql/functions/variant_explode_outer.md @@ -1,3 +1,7 @@ +--- +description: "It separates a variant object/array into multiple rows containing its fields/elements." +--- + # `variant_explode_outer` diff --git a/docs/reference/sql/functions/variant_get.md b/docs/reference/sql/functions/variant_get.md index 7462739d6..11c8ad9c0 100644 --- a/docs/reference/sql/functions/variant_get.md +++ b/docs/reference/sql/functions/variant_get.md @@ -1,3 +1,7 @@ +--- +description: "Extracts a sub-variant from `v` according to `path`, and then cast the sub-variant to `type`." +--- + # `variant_get` diff --git a/docs/reference/sql/functions/vector_avg.md b/docs/reference/sql/functions/vector_avg.md index ecd1901be..c4989bb3f 100644 --- a/docs/reference/sql/functions/vector_avg.md +++ b/docs/reference/sql/functions/vector_avg.md @@ -1,3 +1,7 @@ +--- +description: "Returns the element-wise mean of float vectors in a group." +--- + # `vector_avg` diff --git a/docs/reference/sql/functions/vector_cosine_similarity.md b/docs/reference/sql/functions/vector_cosine_similarity.md index f1885330e..595befeb6 100644 --- a/docs/reference/sql/functions/vector_cosine_similarity.md +++ b/docs/reference/sql/functions/vector_cosine_similarity.md @@ -1,3 +1,7 @@ +--- +description: "Returns the cosine similarity between two float vectors." +--- + # `vector_cosine_similarity` diff --git a/docs/reference/sql/functions/vector_inner_product.md b/docs/reference/sql/functions/vector_inner_product.md index e32428072..bf2e01693 100644 --- a/docs/reference/sql/functions/vector_inner_product.md +++ b/docs/reference/sql/functions/vector_inner_product.md @@ -1,3 +1,7 @@ +--- +description: "Returns the inner product (dot product) between two float vectors." +--- + # `vector_inner_product` diff --git a/docs/reference/sql/functions/vector_l2_distance.md b/docs/reference/sql/functions/vector_l2_distance.md index bfaf3f150..0cff09043 100644 --- a/docs/reference/sql/functions/vector_l2_distance.md +++ b/docs/reference/sql/functions/vector_l2_distance.md @@ -1,3 +1,7 @@ +--- +description: "Returns the Euclidean (L2) distance between two float vectors." +--- + # `vector_l2_distance` diff --git a/docs/reference/sql/functions/vector_norm.md b/docs/reference/sql/functions/vector_norm.md index ab3067e97..12fd44f0b 100644 --- a/docs/reference/sql/functions/vector_norm.md +++ b/docs/reference/sql/functions/vector_norm.md @@ -1,3 +1,7 @@ +--- +description: "Returns the Lp norm of a float vector using the specified degree." +--- + # `vector_norm` diff --git a/docs/reference/sql/functions/vector_normalize.md b/docs/reference/sql/functions/vector_normalize.md index d12c801ea..fd1ab94dd 100644 --- a/docs/reference/sql/functions/vector_normalize.md +++ b/docs/reference/sql/functions/vector_normalize.md @@ -1,3 +1,7 @@ +--- +description: "Normalizes a float vector to unit length using the specified norm degree." +--- + # `vector_normalize` diff --git a/docs/reference/sql/functions/vector_sum.md b/docs/reference/sql/functions/vector_sum.md index a1f373373..3a57f4623 100644 --- a/docs/reference/sql/functions/vector_sum.md +++ b/docs/reference/sql/functions/vector_sum.md @@ -1,3 +1,7 @@ +--- +description: "Returns the element-wise sum of float vectors in a group." +--- + # `vector_sum` diff --git a/docs/reference/sql/functions/version.md b/docs/reference/sql/functions/version.md index 55a1f5255..f3de14b43 100644 --- a/docs/reference/sql/functions/version.md +++ b/docs/reference/sql/functions/version.md @@ -1,3 +1,7 @@ +--- +description: "Returns the Spark version." +--- + # `version` diff --git a/docs/reference/sql/functions/weekday.md b/docs/reference/sql/functions/weekday.md index b426a9d8e..0dd52df91 100644 --- a/docs/reference/sql/functions/weekday.md +++ b/docs/reference/sql/functions/weekday.md @@ -1,3 +1,7 @@ +--- +description: "Returns the day of the week for date/timestamp (0 = Monday, 1 = Tuesday, ..., 6 = Sunday)." +--- + # `weekday` diff --git a/docs/reference/sql/functions/weekofyear.md b/docs/reference/sql/functions/weekofyear.md index 5f1df2c6e..9bbee7d5c 100644 --- a/docs/reference/sql/functions/weekofyear.md +++ b/docs/reference/sql/functions/weekofyear.md @@ -1,3 +1,7 @@ +--- +description: "Returns the week of the year of the given date." +--- + # `weekofyear` diff --git a/docs/reference/sql/functions/when.md b/docs/reference/sql/functions/when.md index 428436c63..24eb61a70 100644 --- a/docs/reference/sql/functions/when.md +++ b/docs/reference/sql/functions/when.md @@ -1,3 +1,7 @@ +--- +description: "When `expr1` = true, returns `expr2`; else when `expr3` = true, returns `expr4`; else returns `expr5`." +--- + # `when` diff --git a/docs/reference/sql/functions/width_bucket.md b/docs/reference/sql/functions/width_bucket.md index afe96e406..2890f22b1 100644 --- a/docs/reference/sql/functions/width_bucket.md +++ b/docs/reference/sql/functions/width_bucket.md @@ -1,3 +1,7 @@ +--- +description: "Returns the bucket number to which `value` would be assigned in an equiwidth histogram with `num_bucket` buckets, in the range `min_value` to `max_value`." +--- + # `width_bucket` diff --git a/docs/reference/sql/functions/window.md b/docs/reference/sql/functions/window.md index c9f13806b..4ed56a1a2 100644 --- a/docs/reference/sql/functions/window.md +++ b/docs/reference/sql/functions/window.md @@ -1,3 +1,7 @@ +--- +description: "Bucketize rows into one or more time windows given a timestamp specifying column." +--- + # `window` diff --git a/docs/reference/sql/functions/window_time.md b/docs/reference/sql/functions/window_time.md index 1f34e0307..cc01cafd0 100644 --- a/docs/reference/sql/functions/window_time.md +++ b/docs/reference/sql/functions/window_time.md @@ -1,3 +1,7 @@ +--- +description: "Extract the time value from time/session window column which can be used for event time value of window." +--- + # `window_time` diff --git a/docs/reference/sql/functions/xpath.md b/docs/reference/sql/functions/xpath.md index 82391e96a..e01a925a6 100644 --- a/docs/reference/sql/functions/xpath.md +++ b/docs/reference/sql/functions/xpath.md @@ -1,3 +1,7 @@ +--- +description: "Returns a string array of values within the nodes of xml that match the XPath expression." +--- + # `xpath` diff --git a/docs/reference/sql/functions/xpath_boolean.md b/docs/reference/sql/functions/xpath_boolean.md index c9c83e1f9..16d925083 100644 --- a/docs/reference/sql/functions/xpath_boolean.md +++ b/docs/reference/sql/functions/xpath_boolean.md @@ -1,3 +1,7 @@ +--- +description: "Returns true if the XPath expression evaluates to true, or if a matching node is found." +--- + # `xpath_boolean` diff --git a/docs/reference/sql/functions/xpath_double.md b/docs/reference/sql/functions/xpath_double.md index fa2131b7c..549d18324 100644 --- a/docs/reference/sql/functions/xpath_double.md +++ b/docs/reference/sql/functions/xpath_double.md @@ -1,3 +1,7 @@ +--- +description: "Returns a double value, the value zero if no match is found, or NaN if a match is found but the value is non-numeric." +--- + # `xpath_double` diff --git a/docs/reference/sql/functions/xpath_float.md b/docs/reference/sql/functions/xpath_float.md index be7b75ecf..06aaa55f0 100644 --- a/docs/reference/sql/functions/xpath_float.md +++ b/docs/reference/sql/functions/xpath_float.md @@ -1,3 +1,7 @@ +--- +description: "Returns a float value, the value zero if no match is found, or NaN if a match is found but the value is non-numeric." +--- + # `xpath_float` diff --git a/docs/reference/sql/functions/xpath_int.md b/docs/reference/sql/functions/xpath_int.md index 3fdc46289..7a07fa9ba 100644 --- a/docs/reference/sql/functions/xpath_int.md +++ b/docs/reference/sql/functions/xpath_int.md @@ -1,3 +1,7 @@ +--- +description: "Returns an integer value, or the value zero if no match is found, or a match is found but the value is non-numeric." +--- + # `xpath_int` diff --git a/docs/reference/sql/functions/xpath_long.md b/docs/reference/sql/functions/xpath_long.md index 5cbb8ed18..72f2617b0 100644 --- a/docs/reference/sql/functions/xpath_long.md +++ b/docs/reference/sql/functions/xpath_long.md @@ -1,3 +1,7 @@ +--- +description: "Returns a long integer value, or the value zero if no match is found, or a match is found but the value is non-numeric." +--- + # `xpath_long` diff --git a/docs/reference/sql/functions/xpath_number.md b/docs/reference/sql/functions/xpath_number.md index 88e0a92f3..54e08383d 100644 --- a/docs/reference/sql/functions/xpath_number.md +++ b/docs/reference/sql/functions/xpath_number.md @@ -1,3 +1,7 @@ +--- +description: "Returns a double value, the value zero if no match is found, or NaN if a match is found but the value is non-numeric." +--- + # `xpath_number` diff --git a/docs/reference/sql/functions/xpath_short.md b/docs/reference/sql/functions/xpath_short.md index 2557bd055..5e755b2fe 100644 --- a/docs/reference/sql/functions/xpath_short.md +++ b/docs/reference/sql/functions/xpath_short.md @@ -1,3 +1,7 @@ +--- +description: "Returns a short integer value, or the value zero if no match is found, or a match is found but the value is non-numeric." +--- + # `xpath_short` diff --git a/docs/reference/sql/functions/xpath_string.md b/docs/reference/sql/functions/xpath_string.md index b43820740..fb823bb74 100644 --- a/docs/reference/sql/functions/xpath_string.md +++ b/docs/reference/sql/functions/xpath_string.md @@ -1,3 +1,7 @@ +--- +description: "Returns the text contents of the first xml node that matches the XPath expression." +--- + # `xpath_string` diff --git a/docs/reference/sql/functions/xxhash64.md b/docs/reference/sql/functions/xxhash64.md index 93c2c31be..091b98064 100644 --- a/docs/reference/sql/functions/xxhash64.md +++ b/docs/reference/sql/functions/xxhash64.md @@ -1,3 +1,7 @@ +--- +description: "Returns a 64-bit hash value of the arguments." +--- + # `xxhash64` diff --git a/docs/reference/sql/functions/year.md b/docs/reference/sql/functions/year.md index afdbbf6d0..cde5e4534 100644 --- a/docs/reference/sql/functions/year.md +++ b/docs/reference/sql/functions/year.md @@ -1,3 +1,7 @@ +--- +description: "Returns the year component of the date/timestamp." +--- + # `year` diff --git a/docs/reference/sql/functions/zeroifnull.md b/docs/reference/sql/functions/zeroifnull.md index 3b8d238a5..5b354aa8b 100644 --- a/docs/reference/sql/functions/zeroifnull.md +++ b/docs/reference/sql/functions/zeroifnull.md @@ -1,3 +1,7 @@ +--- +description: "Returns zero if `expr` is equal to null, or `expr` otherwise." +--- + # `zeroifnull` diff --git a/docs/reference/sql/functions/zip_with.md b/docs/reference/sql/functions/zip_with.md index ec5aa2097..32c3dc666 100644 --- a/docs/reference/sql/functions/zip_with.md +++ b/docs/reference/sql/functions/zip_with.md @@ -1,3 +1,7 @@ +--- +description: "Merges the two given arrays, element-wise, into a single array using function." +--- + # `zip_with` diff --git a/docs/reference/sql/index.md b/docs/reference/sql/index.md index d7a4e630a..fcf290dfa 100644 --- a/docs/reference/sql/index.md +++ b/docs/reference/sql/index.md @@ -1,10 +1,14 @@ +--- +description: "Krishiv runs Spark SQL: how to run it, what the language covers and where it differs from Spark." +--- + # SQL Krishiv runs Spark SQL. Semantics, results and error classes follow Apache Spark; the differences that remain are listed in [known differences](../../concepts/known-differences.md) and in the [compatibility matrix](../../concepts/compatibility.md). Run SQL from Python with `spark.sql("...")`, or mix it with DataFrames: register a DataFrame with -`createOrReplaceTempView` and query it by name (see the [quickstart](../../get-started/quickstart.md)). +`createOrReplaceTempView` and query it by name (see the [quickstart](../../get-started/index.md)). - Every built-in function and operator has a page in the [SQL function reference](functions/index.md): Spark's description and examples, and whether Krishiv implements it. diff --git a/tests/scripts/docs_examples_run.py b/tests/scripts/docs_examples_run.py index fcdf0b739..8d17d4933 100644 --- a/tests/scripts/docs_examples_run.py +++ b/tests/scripts/docs_examples_run.py @@ -20,7 +20,7 @@ import traceback DOCS = pathlib.Path("docs") -PAGES = [DOCS / "get-started" / "quickstart.md", DOCS / "guides" / "pyspark-migration.md"] +PAGES = [DOCS / "get-started" / "index.md", DOCS / "guides" / "pyspark-migration.md"] BLOCK = re.compile(r"(\n)?```(?:python|py)\b[^\n]*\n(.*?)```", re.S) diff --git a/tests/scripts/gen_python_docs.py b/tests/scripts/gen_python_docs.py index 4d785dd7a..758d51060 100644 --- a/tests/scripts/gen_python_docs.py +++ b/tests/scripts/gen_python_docs.py @@ -38,6 +38,12 @@ def modules() -> list[tuple[str, Path]]: return out +def front_matter(description: str) -> str: + """The page's `description:` front matter (one line, double-quoted).""" + text = description.strip().replace("\\", "\\\\").replace('"', '\\"') + return f'---\ndescription: "{text}"\n---\n' + + def md_doc(doc: str | None) -> str: if not doc: return "" @@ -151,8 +157,9 @@ def render_module(name: str, path: Path) -> str: body += sub.body if exported is not None: exported |= exports(sub) or set() - lines = [f"# `{name}`", "", HEADER, ""] doc = md_doc(ast.get_docstring(tree)) + summary = doc.strip().splitlines()[0] if doc else f"The {name} module of the Krishiv Python API." + lines = [front_matter(summary), f"# `{name}`", "", HEADER, ""] if doc: lines += [doc, ""] classes = sorted( @@ -168,7 +175,15 @@ def render_module(name: str, path: Path) -> str: def render() -> dict[Path, str]: pages: dict[Path, str] = {} - index = ["# Python API reference", "", HEADER, "", "| Module | Summary |", "|---|---|"] + index = [ + front_matter("Every public module of the krishiv Python package: classes, functions and signatures."), + "# Python API reference", + "", + HEADER, + "", + "| Module | Summary |", + "|---|---|", + ] for name, path in modules(): tree = ast.parse(path.read_text(encoding="utf-8")) summary = md_doc(ast.get_docstring(tree)).strip().splitlines()[:1] diff --git a/xtask/src/connect_coverage.rs b/xtask/src/connect_coverage.rs index 0f1523d4b..30e56f433 100644 --- a/xtask/src/connect_coverage.rs +++ b/xtask/src/connect_coverage.rs @@ -79,7 +79,8 @@ fn render(json: &str) -> Result { by_oneof.entry(name).or_default().push(r); } let mut out = String::from( - "\n\ + "---\ndescription: \"Which Spark Connect relations, commands and expressions Krishiv supports, one row per protocol arm.\"\n---\n\n\ + \n\ # Spark Connect coverage\n\n\ Every arm of the `oneof` fields the Connect translator dispatches on, for the vendored protocol \ version (Spark 4.3). A row that is `missing` or `out of scope` answers \ diff --git a/xtask/src/docs_ext.rs b/xtask/src/docs_ext.rs index c380a4be2..ed699bf7a 100644 --- a/xtask/src/docs_ext.rs +++ b/xtask/src/docs_ext.rs @@ -103,6 +103,14 @@ fn tidy(text: &str) -> String { format!("{}\n", out.join("\n").trim()) } +/// The `description:` front matter of a generated page: one double-quoted line, then a blank line. +#[must_use] +pub fn front_matter(description: &str) -> String { + let one_line = description.split_whitespace().collect::>().join(" "); + let escaped = one_line.replace('\\', "\\\\").replace('"', "\\\""); + format!("---\ndescription: \"{escaped}\"\n---\n\n") +} + /// Builds rustdoc JSON for [`RUST_CRATES`] and writes (or with `check` compares) the Markdown pages. /// /// # Errors @@ -143,7 +151,8 @@ pub fn run_rust(root: &Path, check: bool) -> Result<(), String> { fn rust_pages(out_dir: &Path, mds: &[(&str, String)]) -> Vec<(PathBuf, String)> { let mut pages: Vec<(PathBuf, String)> = Vec::new(); let mut index = String::from( - "# Rust API reference\n\n\n\n\ + "---\ndescription: \"The public Rust API of the crates users build against, one page per crate.\"\n---\n\n\ + # Rust API reference\n\n\n\n\ The public API of the crates users build against. Published versions are also on docs.rs.\n\n\ | Crate | Summary |\n|---|---|\n", ); @@ -156,7 +165,8 @@ fn rust_pages(out_dir: &Path, mds: &[(&str, String)]) -> Vec<(PathBuf, String)> .unwrap_or("") .replace('|', "\\|"); index.push_str(&format!("| [`{c}`]({c}.md) | {summary} |\n")); - pages.push((out_dir.join(format!("{c}.md")), md.clone())); + let fm = front_matter(&summary.replace("\\|", "|")); + pages.push((out_dir.join(format!("{c}.md")), format!("{fm}{md}"))); } pages.push((out_dir.join("index.md"), index)); pages.push(( @@ -194,6 +204,14 @@ fn write_or_check(out_dir: &Path, pages: &[(PathBuf, String)], check: bool) -> R mod tests { use super::*; + #[test] + fn front_matter_is_one_quoted_line() { + assert_eq!( + front_matter("Says \"hi\"\n and a \\ too."), + "---\ndescription: \"Says \\\"hi\\\" and a \\\\ too.\"\n---\n\n" + ); + } + #[test] fn run_python_and_rust_report_a_missing_root() { let nowhere = Path::new("/no/such/root"); diff --git a/xtask/src/docs_sql.rs b/xtask/src/docs_sql.rs index 26f6e853e..ee54d61da 100644 --- a/xtask/src/docs_sql.rs +++ b/xtask/src/docs_sql.rs @@ -266,6 +266,17 @@ fn status(name: &str, def: Option<&FunctionDef>) -> &'static str { } } +/// A page's description: the first sentence of Spark's usage text, else a line naming the function. +fn description_of(name: &str, desc: &str) -> String { + let flat = desc.split_whitespace().collect::>().join(" "); + let first = flat.split_inclusive(". ").next().unwrap_or("").trim(); + if first.is_empty() { + format!("The Spark SQL function {name}: syntax, examples and Krishiv's status.") + } else { + first.trim_end_matches(['"', ',']).to_owned() + } +} + fn page( doc: &SparkDoc, reg: &Registry, @@ -278,7 +289,7 @@ fn page( }; let (sig, desc) = split_usage(&doc.usage); let spark = reg.spark_function(&doc.name); - let mut m = String::new(); + let mut m = crate::docs_ext::front_matter(&description_of(&doc.name, &desc)); let _ = write!( m, "# `{}`\n\n\n\n", @@ -400,7 +411,8 @@ pub fn render() -> Result, String> { } let mut out = BTreeMap::new(); let mut index = String::from( - "# SQL function reference\n\n\n\n\ + "---\ndescription: \"Every Spark built-in function and operator, with Spark's description and examples and Krishiv's status.\"\n---\n\n\ + # SQL function reference\n\n\n\n\ Every Spark built-in function and operator, with Spark 4.2.0's description and examples and Krishiv's status.\n\n\ | Function | Kind | Krishiv | Description |\n|---|---|---|---|\n", ); diff --git a/xtask/tests/docs.rs b/xtask/tests/docs.rs index d850d0845..c5d20d6da 100644 --- a/xtask/tests/docs.rs +++ b/xtask/tests/docs.rs @@ -132,7 +132,7 @@ fn the_quickstart_page_runs_the_readme_code() { .parent() .unwrap(); let readme = std::fs::read_to_string(root.join("README.md")).unwrap(); - let page = std::fs::read_to_string(root.join("docs/get-started/quickstart.md")).unwrap(); + let page = std::fs::read_to_string(root.join("docs/get-started/index.md")).unwrap(); let python = |t: &str| { fenced_blocks(t, t == readme) .into_iter() @@ -142,6 +142,6 @@ fn the_quickstart_page_runs_the_readme_code() { assert_eq!( python(&readme), python(&page), - "docs/get-started/quickstart.md drifted from the README" + "docs/get-started/index.md drifted from the README" ); }