elasticsearch/docs/reference/sql/functions/system.asciidoc
James Rodewig f56a0f4b66
[DOCS] Remove testenv annotations from doc snippet tests (#80023)
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible.

Relates to #79309, #31619
2021-11-05 18:38:50 -04:00

47 lines
1.3 KiB
Text

[role="xpack"]
[[sql-functions-system]]
=== System Functions
These functions return metadata type of information about the system being queried.
[[sql-functions-system-database]]
==== `DATABASE`
.Synopsis:
[source, sql]
--------------------------------------------------
DATABASE()
--------------------------------------------------
*Input*: _none_
*Output*: string
*Description*: Returns the name of the database being queried. In the case of Elasticsearch SQL, this
is the name of the Elasticsearch cluster. This function should always return a non-null
value.
[source, sql]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[database]
--------------------------------------------------
[[sql-functions-system-user]]
==== `USER`
.Synopsis:
[source, sql]
--------------------------------------------------
USER()
--------------------------------------------------
*Input*: _none_
*Output*: string
*Description*: Returns the username of the authenticated user executing the query. This function can
return `null` in case <<configuring-stack-security,security>> is disabled.
[source, sql]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[user]
--------------------------------------------------