Commit graph

258 commits

Author SHA1 Message Date
Lisa Cawley
d9c6b679da
[8.17] [DOCS] More links to new API site (#119380) (#119419)
* [DOCS] More links to new API site (#119380)

* Fix example test failure
2025-01-01 10:06:07 +11:00
George Wallace
ceb941f48c
Removing server from the version compatibility table (#109168)
* Removing server from the version compatibility table

* fixed typo

---------

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2024-05-29 11:57:46 -06:00
shainaraskas
346fa8b8b5
Remove x-pack references from SQL docs (#107584) 2024-04-18 14:32:44 -04:00
Bogdan Pintea
f1bcb338ec
SQL: Limit how much space some string functions can use (#107333)
This will check and fail if certain functions would generate a result
exceeding a certain fixed byte size.

This prevents an operation/query to fail the entire VM.
2024-04-18 10:20:46 -04:00
Liam Thompson
33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00
Joe Gallo
8be3fb229d
Mute failing snippet tests (#106196) 2024-03-11 13:22:46 -04:00
Joe Gallo
265c3eee67
Revert "[DOCS] Mute snippet tests for #75069 (#75237)" (#106140)
This reverts commit 75c585c0f1.
2024-03-08 15:35:58 -05:00
Alexander Spies
82461dd356
SQL: Prepare integration tests for Serverless testing (#102578)
* Separate tests into those that need frozen indices and those that can do
  without.                                                                                                       
* Make http clients use basic auth if system property
  tests.rest.cluster.multi.user (and ....password) is set.
2023-11-27 16:14:13 +01:00
James Rodewig
255c9a7f95
[DOCS] Move x-pack docs to docs/reference dir (#99209)
**Problem:**
For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. 

**Solution:**
- Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory
- Update doc snippet tests to use security

Rel: https://github.com/elastic/platform-docs-team/issues/208
2023-09-12 14:53:41 -04:00
debadair
777598d602
[DOCS] Remove redirect pages (#88738)
* [DOCS] Remove manual redirects

* [DOCS] Removed refs to modules-discovery-hosts-providers

* [DOCS] Fixed broken internal refs

* Fixing bad cross links in ES book, and adding redirects.asciidoc[] back into docs/reference/index.asciidoc.

* Update docs/reference/search/point-in-time-api.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/setup/restart-cluster.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/sql/endpoints/translate.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/snapshot-restore/restore-snapshot.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update repository-azure.asciidoc

* Update node-tool.asciidoc

* Update repository-azure.asciidoc

---------

Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Amy Jonsson <amy.jonsson@elastic.co>
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2023-05-24 12:32:46 +01:00
Luca Belluccini
d746295296
[DOCS] JDBC Driver troubleshooting params (#93858)
* [DOCS] JDBC Driver troubleshooting params

* Update docs/reference/sql/endpoints/jdbc.asciidoc

Co-authored-by: Bogdan Pintea <bogdan.pintea@elastic.co>

* Update docs/reference/sql/endpoints/jdbc.asciidoc

Co-authored-by: Bogdan Pintea <bogdan.pintea@elastic.co>

---------

Co-authored-by: Bogdan Pintea <bogdan.pintea@elastic.co>
2023-02-24 11:02:51 +01:00
Anthony McGlone
436d47da5c
[DOCS] Add API example for setting SQL permissions (#92491)
* [DOCS] Add API example for setting SQL permissions (#86711)

* Update docs/reference/sql/security.asciidoc

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>

* Update docs/reference/sql/security.asciidoc

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>

* Update docs/reference/sql/security.asciidoc

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>

* [DOCS] Update API example for setting SQL permissions (#86711)

* [DOCS] Update console result for API example (#86711)

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-01-16 11:11:46 +01:00
Bogdan Pintea
ee8d83e765
ODBC: update required .NET Framework version (#88852)
Update required ODBC .NET Framework version to reflect the compatibility
with the 4.x versions, replacing pinning it to the (EOL'd) 4.0 one.

Replace the link to the 4.8 framework with the generic .net page link.
2023-01-04 14:16:14 +01:00
didendron
84eb60ee16
SQL: Implement DATE_FORMAT function (#88388) 2022-09-12 09:33:34 +02:00
Luigi Dell'Aquila
e9ea4630bb
SQL: Set track_total_hits to false when not needed (#89106) 2022-08-22 17:22:13 +02:00
apeltop
71234f7464
[DOCS] Fix typos in docs (#88226) 2022-07-05 11:02:29 +02:00
Luigi Dell'Aquila
62f27f50ed
Add support for VERSION field type in SQL and EQL (#87590) 2022-06-23 08:54:20 +02:00
Luigi Dell'Aquila
3dc4176a1a Revert "Add support for VERSION field type in SQL and EQL (#85502)"
This reverts commit 79b0078b0d.
2022-06-09 09:34:26 +02:00
Luigi Dell'Aquila
79b0078b0d
Add support for VERSION field type in SQL and EQL (#85502) 2022-06-09 08:43:23 +02:00
Luigi Dell'Aquila
bdebb25b60
Implement support for partial search results in SQL CLI (#86982)
Add support for

   allow_partial_search_results = true/false

command in SQL CLI.

If true, returns partial results if there are shard request timeouts or shard failures.
If false, returns an error with no partial results.
2022-05-26 16:59:37 +02:00
Luigi Dell'Aquila
f69c7396d9
SQL: Fix FORMAT function to better comply with Microsoft SQL Server specification (#86225) 2022-05-18 12:03:00 +02:00
Bogdan Pintea
d8e6cc2096
SQ: Allow partial results in SQL queries (#85897)
This adds support for partial results to SQL.
The lenient mode is controlled by a new query paramter,
`allow_partial_search_results`, false by default. On shard failures, the
errors are added as Warning headers to the response. Only a first set of
failures are sent to the client, the last header briefs on the number of
remaining suppressed ones.
2022-04-21 18:12:50 +02:00
Bogdan Pintea
f50ceecbd4
SQL: Update DbVisualizer connection steps (#85167)
Update DbVisualizer connection steps to reflect version 13.0's integrated
Elasticsearch support.
2022-03-31 16:48:24 +02:00
Tobias Stadler
e3deacf547
[DOCS] Fix typos (#83895) 2022-02-15 12:42:17 -05:00
edh-oss
5ef77ef370
Add/update source block delimeters (#83624)
Asciidoc source blocks are to be delimited with four dashes. This adds missing delimiters, and updates some that contained only three dashes. It matters for parsing purposes.
2022-02-11 14:19:30 -05:00
James Rodewig
6522e6eea2
[DOCS] Update multi-target syntax refs (#83703) 2022-02-09 13:00:07 -05:00
Bogdan Pintea
ca76121ac0
List unsigned_long type as supported SQL type (#83480)
Add unsigned_long as an (experimentally) supported SQL type and its
limitations.
2022-02-04 12:14:56 +01:00
James Rodewig
adca5b9dc5
[DOCS] SQL: Update client version compatability for 7.17 (#81869)
Replaces a 7.x reference with the `{prev-major-last}` variable, which will use the last minor of the previous major (currently 7.17 for 8.x).

Relates to #70451.
2022-01-13 08:39:43 -05:00
Bogdan Pintea
13a0e420a3
SQL: Add CCS SQL documentation (#81545)
This adds the documentation for CCS SQL.

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2022-01-05 20:01:01 +01:00
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
edh-oss
3c23a9e9cd
[DOCS] Remove [testenv="gold+"] attributes (#79309)
Changes:

* Removes several `[testenv="gold+"]` attributes from the docs. `gold+` is not a valid [subscription level](https://www.elastic.co/subscriptions) or testenv value.
* Moves two `[testenv="basic"]` attributes to the file header. This makes the `testenv` placement consistent and fixes the yml file generated from `docs/reference/snapshot-restore/register-repository.asciidoc`.

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-10-27 16:32:30 -04:00
Lukas Wegmann
9e66494106
SQL: fix use of requestTimeout and pageTimeout query parameters (#79360)
Resolves #72151 The _sql endpoint offers a `page_timeout` parameter for
customizing how long scroll contexts should be kept open (if needed) and
a `request_timeout` parameter which the docs describe as "Timeout before
the request fails.". Currently, the value of the `page_timeout`
parameter is used as the `timeout` in subsequent _search requests and
not as the timeout in the `scroll` configuration. For the `scroll`
configuration, SQL uses the `request_timeout` parameter. This PR
addresses the issue by swapping the uses of `page_timeout` and
`request_timeout` in querier. Additionally, the PR removes some unused
artifacts that might have caused some confusion: - The `timeout` and
`keepAlive` fields in `Querier`. Instead, `Querier` directly uses the
according fields in `SqlConfiguration`. - The `SqlConfiguration`
parameter from `ScrollCursor.clear`, it's not used but required an
instance of `SqlConfiguration` with all default values. - One overloaded
constructor of `SqlConfiguration` that was only used for calling
`ScrollCursor.clear` (and some tests) and used default values for an
(arbitrary?) subset of the fields. - The fields related to async
requests in `SqlConfiguration`. I'm a bit unsure about this one but the
fields are never read and it does not seem like an SQL specific concern.
The whole creation of the async tasks is handled in
`TransportSqlQueryAction` and the downstream components do not require
the information.
2021-10-27 09:21:52 -04:00
Lukas Wegmann
008daa17a3
SQL: Adjust JDBC docs to use milliseconds for timeouts (#79628)
Resolves #79480

My initial thought was to change the properties to be interpreted as seconds but this might not be worth it. All relevant places in the code seem to assume the timeouts to be in ms and there does not seem to be a consistent use of ms or s across JDBC drivers (Postgres uses seconds, MySQL uses ms, MS SQL mixes the two depending on the connection property).

Hence, just fixing the docs might be easier.
2021-10-26 13:44:15 +02:00
Dan Hermann
4a36d5cd79
Remove endpoint for freezing indices (#78918) 2021-10-26 06:37:56 -05:00
Andrei Stefan
47852146c1
Mention scoring characteristics (#78965) 2021-10-12 12:11:57 +03:00
Lukas Wegmann
627c0ee9c6
SQL: Fix disjunctions (and IN) with multiple date math expressions (#76424)
* SQL: Fix disjunctions with multiple date math expressions

* review comments

* remove redundant FieldAttribute parameter

* address comments and add more specs

* fix typo
2021-08-31 17:30:49 +02:00
James Rodewig
39ae8d07ae
[DOCS] Update Kibana dev console screenshots for new EUI theme (#75626)
Changes:

* Updates the Kibana dev console screenshots to use the new EUI theme
* Corrects an example SQL query in one screenshot. The previous screenshot used `_/sql`, which is not a valid URI.
2021-07-22 09:40:03 -04:00
James Rodewig
6b102733b4 [DOCS] Retitle 'SQL access' page to 'SQL' 2021-07-21 09:57:22 -04:00
James Rodewig
ea635d67a6
[DOCS] SQL: Add formal API docs (#75506)
Adds formal API docs for the following APIs:

* Clear SQL cursor
* SQL search
* SQL translate

Other changes:

* Removes and redirects the "Supported REST parameters section." This is now covered in the SQL search API docs.
* Updates a few related xrefs.

Closes #75085
2021-07-21 08:04:21 -04:00
James Rodewig
77c0302ea9 Fix TOC order 2021-07-19 13:48:57 -04:00
James Rodewig
83be31b1f6 [DOCS] Remove leading slashes 2021-07-19 13:42:41 -04:00
James Rodewig
a9ed7dc1eb
[DOCS] Document async SQL APIs (#75078)
Adds formal API docs and JSON specs for the following APIs:

* Get async SQL search
* Get async SQL search status
* Delete async SQL search

Closes #74845
2021-07-12 10:12:02 -04:00
James Rodewig
75c585c0f1
[DOCS] Mute snippet tests for #75069 (#75237) 2021-07-12 09:50:18 -04:00
James Rodewig
0f5a0e711e
[DOCS] SQL: Document async SQL search (#74975) (#75037)
Documents async SQL search functionality.

I plan to add formal API documentation for the async APIs with a later PR.

Relates to #73991 and #74845.
# Conflicts:
#	docs/reference/release-notes/highlights.asciidoc
2021-07-07 09:07:03 -04:00
debadair
29bb8fd67e
[DOCS] Add info about GET/POST to the API conventions. (#74529)
* [DOCS] Add info about GET/POST to the API conventions.

* Fixed anchor

* Added redirect

* Incorporated review suggestions
2021-06-30 09:24:42 -07:00
James Rodewig
47adf545c4
[DOCS] SQL: Document null handling for functions (#74444)
Closes #74193.
2021-06-23 11:11:26 -04:00
James Rodewig
853f2436ee
[DOCS] SQL: Move null handling to arg descriptions (#74255)
https://github.com/elastic/elasticsearch/pull/74201 documents `null` handling  to the arg descriptions of several string functions.

This PR moves pre-existing docs for `null` handling and similar edge case handling for string functions to arg descriptions for consistency.

Relates to #74193
2021-06-17 15:50:02 -04:00
James Rodewig
5fc6d73aa5
[DOCS] SQL: Document null handing for string functions (#74201) 2021-06-16 14:21:08 -04:00
James Rodewig
8a899419bc [DOCS] Change multi field to multi-field 2021-06-15 11:40:03 -04:00
Bogdan Pintea
522283c90e
SQL: Add ODBC proxy support documentation (#73263)
This documents how to configure the proxy support for ODBC.
It also removes the documentation of the connection string values, these
are now all covered by the GUI settings.

Co-authored-by: Andrei Stefan <astefan@users.noreply.github.com>
2021-05-20 16:56:02 +02:00