elasticsearch/docs/reference/sql/functions/system.asciidoc
Costin Leau d0f60b4425
SQL: Spec tests now use classpath discovery (#40388)
To avoid having to specify each spec by hand (which can miss specs to be
added), the test infrastructure now performs classpath discovery so that
each spec added, is automatically considered.

Relates #40358
2019-03-25 15:22:59 +02:00

52 lines
1.4 KiB
Text

[role="xpack"]
[testenv="basic"]
[[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",subs="attributes,callouts,macros"]
--------------------------------------------------
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 {stack-ov}/elasticsearch-security.html[Security] is disabled.
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[user]
--------------------------------------------------