Skip to content

Commit

Permalink
Add esql version
Browse files Browse the repository at this point in the history
Adds a `version` parameter to the ESQL `_query` request endpoint. We'll
do some work to give this a default value in the generated clients soon,
but for 8.14+ this'll be a required parameter.
  • Loading branch information
nik9000 committed Apr 15, 2024
1 parent 07e6742 commit 28775f9
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 2 deletions.
32 changes: 31 additions & 1 deletion output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions output/typescript/types.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 34 additions & 0 deletions specification/esql/_types/Version.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import { integer } from '@_types/Numeric'
import { Duration } from '@_types/Time'

export enum Version {
/**
* Run against the first version of ESQL.
*/
'2024.04.01',
/**
* Run against the unreleased version of the ESQL language. This will
* contain any changes staged for release that have yet to be included
* in a version.
*/
snapshot
}
7 changes: 6 additions & 1 deletion specification/esql/query/QueryRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import { RequestBase } from '@_types/Base'
import { QueryContainer } from '@_types/query_dsl/abstractions'
import { ScalarValue } from '@_types/common'
import { Version } from '@esql/_types/Version'

/**
* Executes an ES|QL request
Expand Down Expand Up @@ -59,6 +60,10 @@ export interface Request extends RequestBase {
/**
* The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.
*/
query: string
query: string,
/**
* The version of the ES|QL language in which the "query" field uses was written.
*/
version: Version
}
}

0 comments on commit 28775f9

Please sign in to comment.