Added new docs examples (#1189)

This commit is contained in:
Tomas Della Vedova
2020-05-15 10:34:39 +02:00
committed by GitHub
parent 4659b9849c
commit 803739b4cb
54 changed files with 1321 additions and 9 deletions

View File

@ -0,0 +1,12 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.cluster.health({
wait_for_status: 'yellow',
timeout: '50s'
})
console.log(response)
----

View File

@ -0,0 +1,39 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
index: 'drivers',
body: {
query: {
nested: {
path: 'driver',
query: {
nested: {
path: 'driver.vehicle',
query: {
bool: {
must: [
{
match: {
'driver.vehicle.make': 'Powell Motors'
}
},
{
match: {
'driver.vehicle.model': 'Canyonero'
}
}
]
}
}
}
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,16 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.putSettings({
index: 'twitter',
body: {
index: {
refresh_interval: '1s'
}
}
})
console.log(response)
----

View File

@ -0,0 +1,43 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.bulk({
body: [
{
update: {
_id: '5',
_index: 'index1'
}
},
{
doc: {
my_field: 'foo'
}
},
{
update: {
_id: '6',
_index: 'index1'
}
},
{
doc: {
my_field: 'foo'
}
},
{
create: {
_id: '7',
_index: 'index1'
}
},
{
my_field: 'foo'
}
]
})
console.log(response)
----

View File

@ -0,0 +1,12 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.count({
index: 'twitter',
q: 'user:kimchy'
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'test1',
body: {
mappings: {
properties: {
user: {
type: 'keyword'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
remove: {
index: 'test1',
alias: 'alias1'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,16 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.putSettings({
index: 'twitter',
body: {
index: {
refresh_interval: null
}
}
})
console.log(response)
----

View File

@ -0,0 +1,13 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
index: 'alias2',
q: 'user:kimchy',
routing: '2,3'
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
tags: {
type: 'keyword'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,55 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response0 = await client.index({
index: 'my_index',
id: '1',
body: {
message: 'some arrays in this document...',
tags: [
'elasticsearch',
'wow'
],
lists: [
{
name: 'prog_list',
description: 'programming list'
},
{
name: 'cool_list',
description: 'cool stuff list'
}
]
}
})
console.log(response0)
const response1 = await client.index({
index: 'my_index',
id: '2',
body: {
message: 'no arrays in this document...',
tags: 'elasticsearch',
lists: {
name: 'prog_list',
description: 'programming list'
}
}
})
console.log(response1)
const response2 = await client.search({
index: 'my_index',
body: {
query: {
match: {
tags: 'elasticsearch'
}
}
}
})
console.log(response2)
----

View File

@ -0,0 +1,36 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'drivers',
body: {
mappings: {
properties: {
driver: {
type: 'nested',
properties: {
last_name: {
type: 'text'
},
vehicle: {
type: 'nested',
properties: {
make: {
type: 'text'
},
model: {
type: 'text'
}
}
}
}
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,23 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
add: {
indices: [
'test1',
'test2'
],
alias: 'alias1'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,22 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
regexp: {
user: {
value: 'k.*y',
flags: 'ALL',
max_determinized_states: 10000,
rewrite: 'constant_score'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,57 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response0 = await client.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
date: {
type: 'date'
}
}
}
}
})
console.log(response0)
const response1 = await client.index({
index: 'my_index',
id: '1',
body: {
date: '2015-01-01'
}
})
console.log(response1)
const response2 = await client.index({
index: 'my_index',
id: '2',
body: {
date: '2015-01-01T12:10:30Z'
}
})
console.log(response2)
const response3 = await client.index({
index: 'my_index',
id: '3',
body: {
date: 1420070400001
}
})
console.log(response3)
const response4 = await client.search({
index: 'my_index',
body: {
sort: {
date: 'asc'
}
}
})
console.log(response4)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
function_score: {
random_score: {
seed: 10,
field: '_seq_no'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
add: {
index: 'test*',
alias: 'all_test_indices'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,12 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.get({
index: 'test',
id: '1'
})
console.log(response)
----

View File

@ -0,0 +1,26 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
tag: {
type: 'text',
fielddata: true,
fielddata_frequency_filter: {
min: 0.001,
max: 0.1,
min_segment_size: 500
}
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,37 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
index: 'my_index',
body: {
query: {
nested: {
path: 'obj1',
query: {
bool: {
must: [
{
match: {
'obj1.name': 'blue'
}
},
{
range: {
'obj1.count': {
gt: 5
}
}
}
]
}
},
score_mode: 'avg'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,25 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
add: {
index: 'test1',
alias: 'alias2',
filter: {
term: {
user: 'kimchy'
}
}
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,16 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.putSettings({
index: 'twitter',
body: {
index: {
number_of_replicas: 2
}
}
})
console.log(response)
----

View File

@ -0,0 +1,49 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response0 = await client.index({
index: 'drivers',
id: '1',
body: {
driver: {
last_name: 'McQueen',
vehicle: [
{
make: 'Powell Motors',
model: 'Canyonero'
},
{
make: 'Miller-Meteor',
model: 'Ecto-1'
}
]
}
}
})
console.log(response0)
const response1 = await client.index({
index: 'drivers',
id: '2',
refresh: true,
body: {
driver: {
last_name: 'Hudson',
vehicle: [
{
make: 'Mifune',
model: 'Mach Five'
},
{
make: 'Miller-Meteor',
model: 'Ecto-1'
}
]
}
}
})
console.log(response1)
----

View File

@ -0,0 +1,22 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
function_score: {
field_value_factor: {
field: 'likes',
factor: 1.2,
modifier: 'sqrt',
missing: 1
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,34 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response0 = await client.index({
index: 'twitter',
id: '1',
refresh: true,
body: {
user: 'kimchy'
}
})
console.log(response0)
const response1 = await client.count({
index: 'twitter',
q: 'user:kimchy'
})
console.log(response1)
const response2 = await client.count({
index: 'twitter',
body: {
query: {
term: {
user: 'kimchy'
}
}
}
})
console.log(response2)
----

View File

@ -5,12 +5,11 @@
----
const response = await client.search({
body: {
aggs: {
products: {
terms: {
field: 'product',
size: 5
}
from: 0,
size: 10,
query: {
term: {
user: 'kimchy'
}
}
}

View File

@ -0,0 +1,22 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
function_score: {
query: {
match_all: {}
},
boost: '5',
random_score: {},
boost_mode: 'multiply'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,19 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.putMapping({
index: 'my_index',
body: {
properties: {
my_field: {
type: 'text',
fielddata: true
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,28 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
add: {
index: 'test',
alias: 'alias1',
is_write_index: false
}
},
{
add: {
index: 'test2',
alias: 'alias1',
is_write_index: true
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,26 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
remove: {
index: 'test1',
alias: 'alias1'
}
},
{
add: {
index: 'test1',
alias: 'alias2'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,9 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.cluster.health()
console.log(response)
----

View File

@ -0,0 +1,15 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.index({
index: 'alias1',
id: '1',
body: {
foo: 'bar'
}
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
add: {
index: 'test1',
alias: 'alias1'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,43 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
function_score: {
query: {
match_all: {}
},
boost: '5',
functions: [
{
filter: {
match: {
test: 'bar'
}
},
random_score: {},
weight: 23
},
{
filter: {
match: {
test: 'cat'
}
},
weight: 42
}
],
max_boost: 42,
score_mode: 'max',
boost_mode: 'multiply',
min_score: 42
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,30 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
function_score: {
query: {
match: {
message: 'elasticsearch'
}
},
script_score: {
script: {
params: {
a: 5,
b: 1.2
},
source: "params.a / Math.pow(params.b, doc['likes'].value)"
}
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,31 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response0 = await client.indices.close({
index: 'twitter'
})
console.log(response0)
const response1 = await client.indices.putSettings({
index: 'twitter',
body: {
analysis: {
analyzer: {
content: {
type: 'custom',
tokenizer: 'whitespace'
}
}
}
}
})
console.log(response1)
const response2 = await client.indices.open({
index: 'twitter'
})
console.log(response2)
----

View File

@ -0,0 +1,21 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
add: {
index: 'test',
alias: 'alias1',
routing: '1'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,46 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.bulk({
filter_path: 'items.*.error',
body: [
{
update: {
_id: '5',
_index: 'index1'
}
},
{
doc: {
my_field: 'baz'
}
},
{
update: {
_id: '6',
_index: 'index1'
}
},
{
doc: {
my_field: 'baz'
}
},
{
update: {
_id: '7',
_index: 'index1'
}
},
{
doc: {
my_field: 'baz'
}
}
]
})
console.log(response)
----

View File

@ -0,0 +1,12 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.cluster.health({
index: 'twitter',
level: 'shards'
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
obj1: {
type: 'nested'
}
}
}
}
})
console.log(response)
----

View File

@ -4,8 +4,7 @@
[source, js]
----
const response = await client.search({
index: 'twitter',
q: 'tag:wow'
index: 'twitter'
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
add: {
index: 'twitter',
alias: 'alias1'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,35 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response0 = await client.indices.create({
index: 'test'
})
console.log(response0)
const response1 = await client.indices.create({
index: 'test_2'
})
console.log(response1)
const response2 = await client.indices.updateAliases({
body: {
actions: [
{
add: {
index: 'test_2',
alias: 'test'
}
},
{
remove_index: {
index: 'test'
}
}
]
}
})
console.log(response2)
----

View File

@ -0,0 +1,40 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
function_score: {
functions: [
{
gauss: {
price: {
origin: '0',
scale: '20'
}
}
},
{
gauss: {
location: {
origin: '11, 12',
scale: '2km'
}
}
}
],
query: {
match: {
properties: 'balcony'
}
},
score_mode: 'multiply'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,16 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.putSettings({
index: 'twitter',
body: {
index: {
refresh_interval: '-1'
}
}
})
console.log(response)
----

View File

@ -0,0 +1,21 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
date: {
type: 'date',
format: 'yyyy-MM-dd HH:mm:ss||yyyy-MM-dd||epoch_millis'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,24 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
function_score: {
gauss: {
date: {
origin: '2013-09-17',
scale: '10d',
offset: '5d',
decay: 0.5
}
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,26 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
function_score: {
query: {
match: {
message: 'elasticsearch'
}
},
script_score: {
script: {
source: "Math.log(2 + doc['likes'].value)"
}
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,25 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
my_field: {
type: 'text',
fields: {
keyword: {
type: 'keyword'
}
}
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,26 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
add: {
index: 'test1',
alias: 'alias1'
}
},
{
add: {
index: 'test2',
alias: 'alias1'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,27 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
add: {
index: 'test',
alias: 'alias1',
is_write_index: true
}
},
{
add: {
index: 'test2',
alias: 'alias1'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,22 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.updateAliases({
body: {
actions: [
{
add: {
index: 'test',
alias: 'alias2',
search_routing: '1,2',
index_routing: '2'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,12 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.forcemerge({
index: 'twitter',
max_num_segments: '5'
})
console.log(response)
----

View File

@ -61,7 +61,20 @@ const enabledFiles = [
'mapping/types/nested.asciidoc',
'mapping/params/format.asciidoc',
'docs/delete-by-query.asciidoc',
'search/request/sort.asciidoc'
'search/request/sort.asciidoc',
'query-dsl/function-score-query.asciidoc',
'query-dsl/nested-query.asciidoc',
'query-dsl/regexp-query.asciidoc',
'mapping/types/array.asciidoc',
'mapping/types/date.asciidoc',
'mapping/types/keyword.asciidoc',
'mapping/params/fielddata.asciidoc',
'cluster/health.asciidoc',
'docs/bulk.asciidoc',
'indices/aliases.asciidoc',
'indices/update-settings.asciidoc',
'search/request/from-size.asciidoc',
'search/count.asciidoc'
]
function generate () {