Added new docs examples (#1233)

This commit is contained in:
Tomas Della Vedova
2020-06-26 09:24:14 +02:00
committed by GitHub
parent 83e5147d9d
commit 148f2fd864
77 changed files with 1652 additions and 9 deletions

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.cluster.putSettings({
body: {
transient: {
'cluster.routing.use_adaptive_replica_selection': false
}
}
})
console.log(response)
----

View File

@ -0,0 +1,14 @@
// 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: 'twitter',
size: '0',
q: 'extra:test',
filter_path: 'hits.total'
})
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.cat.indices({
index: 'twi*',
v: true,
s: 'index'
})
console.log(response)
----

View File

@ -0,0 +1,14 @@
// 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.getMapping({
index: '_all'
})
console.log(response0)
const response1 = await client.indices.getMapping()
console.log(response1)
----

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.search({
q: 'elasticsearch',
filter_path: 'took,hits.hits._id,hits.hits._score'
})
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({
index: 'sales',
size: '0',
body: {
aggs: {
sales_over_time: {
date_histogram: {
field: 'date',
fixed_interval: '30d'
}
}
}
}
})
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.updateByQuery({
index: 'twitter',
body: {
slice: {
id: 0,
max: 2
},
script: {
source: "ctx._source['extra'] = 'test'"
}
}
})
console.log(response0)
const response1 = await client.updateByQuery({
index: 'twitter',
body: {
slice: {
id: 1,
max: 2
},
script: {
source: "ctx._source['extra'] = 'test'"
}
}
})
console.log(response1)
----

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 response0 = await client.search({
index: 'twitter',
scroll: '1m',
body: {
slice: {
id: 0,
max: 2
},
query: {
match: {
title: 'elasticsearch'
}
}
}
})
console.log(response0)
const response1 = await client.search({
index: 'twitter',
scroll: '1m',
body: {
slice: {
id: 1,
max: 2
},
query: {
match: {
title: 'elasticsearch'
}
}
}
})
console.log(response1)
----

View File

@ -0,0 +1,11 @@
// 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.state({
filter_path: 'routing_table.indices.**.state'
})
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.search({
body: {
query: {
match_all: {}
},
stats: [
'group1',
'group2'
]
}
})
console.log(response)
----

View File

@ -0,0 +1,11 @@
// 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.state({
filter_path: 'metadata.indices.*.stat*'
})
console.log(response)
----

View File

@ -0,0 +1,11 @@
// 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.state({
filter_path: 'metadata.indices.*.state,-metadata.indices.logstash-*'
})
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.search({
body: {
from: 5,
size: 20,
query: {
term: {
'user.id': '8a4f500d'
}
}
}
})
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({
index: 'sales',
size: '0',
body: {
aggs: {
types_count: {
value_count: {
script: {
id: 'my_script',
params: {
field: 'type'
}
}
}
}
}
}
})
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: {
suggest: {
'my-suggest-1': {
text: 'tring out Elasticsearch',
term: {
field: 'message'
}
},
'my-suggest-2': {
text: 'kmichy',
term: {
field: 'user'
}
}
}
}
})
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({
index: 'sales',
size: '0',
body: {
aggs: {
sales_over_time: {
date_histogram: {
field: 'date',
fixed_interval: '2w'
}
}
}
}
})
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.updateByQuery({
index: 'twitter',
body: {
script: {
source: 'ctx._source.likes++',
lang: 'painless'
},
query: {
term: {
user: 'kimchy'
}
}
}
})
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: 'test',
body: {
mappings: {
dynamic: false,
properties: {
text: {
type: 'text'
}
}
}
}
})
console.log(response0)
const response1 = await client.index({
index: 'test',
refresh: true,
body: {
text: 'words words',
flag: 'bar'
}
})
console.log(response1)
const response2 = await client.index({
index: 'test',
refresh: true,
body: {
text: 'words words',
flag: 'foo'
}
})
console.log(response2)
const response3 = await client.indices.putMapping({
index: 'test',
body: {
properties: {
text: {
type: 'text'
},
flag: {
type: 'text',
analyzer: 'keyword'
}
}
}
})
console.log(response3)
----

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.search({
index: 'sales',
size: '0',
body: {
aggs: {
type_count: {
value_count: {
script: {
source: "doc['type'].value"
}
}
}
}
}
})
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.search({
index: 'sales',
size: '0',
body: {
aggs: {
sale_date: {
date_histogram: {
field: 'date',
calendar_interval: 'year',
missing: '2000/01/01'
}
}
}
}
})
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.clearScroll({
body: {
scroll_id: [
'DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==',
'DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAAABFmtSWWRRWUJrU2o2ZExpSGJCVmQxYUEAAAAAAAAAAxZrUllkUVlCa1NqNmRMaUhiQlZkMWFBAAAAAAAAAAIWa1JZZFFZQmtTajZkTGlIYkJWZDFhQQAAAAAAAAAFFmtSWWRRWUJrU2o2ZExpSGJCVmQxYUEAAAAAAAAABBZrUllkUVlCa1NqNmRMaUhiQlZkMWFB'
]
}
})
console.log(response)
----

View File

@ -0,0 +1,17 @@
// 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.refresh()
console.log(response0)
const response1 = await client.search({
index: 'twitter',
size: '0',
q: 'extra:test',
filter_path: 'hits.total'
})
console.log(response1)
----

View File

@ -0,0 +1,65 @@
// 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: {
city: {
type: 'text',
fields: {
raw: {
type: 'keyword'
}
}
}
}
}
}
})
console.log(response0)
const response1 = await client.index({
index: 'my_index',
id: '1',
body: {
city: 'New York'
}
})
console.log(response1)
const response2 = await client.index({
index: 'my_index',
id: '2',
body: {
city: 'York'
}
})
console.log(response2)
const response3 = await client.search({
index: 'my_index',
body: {
query: {
match: {
city: 'york'
}
},
sort: {
'city.raw': 'asc'
},
aggs: {
Cities: {
terms: {
field: 'city.raw'
}
}
}
}
})
console.log(response3)
----

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.search({
body: {
suggest: {
text: 'tring out Elasticsearch',
'my-suggest-1': {
term: {
field: 'message'
}
},
'my-suggest-2': {
term: {
field: 'user'
}
}
}
}
})
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.updateByQuery({
index: 'twitter',
conflicts: 'proceed',
body: {
query: {
term: {
user: 'kimchy'
}
}
}
})
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.updateByQuery({
index: 'twitter',
scroll_size: '100'
})
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.getSettings({
index: 'twitter',
flat_settings: 'false'
})
console.log(response)
----

View File

@ -0,0 +1,17 @@
// 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: 'twitter',
routing: 'kimchy',
body: {
user: 'kimchy',
post_date: '2009-11-15T14:12:12',
message: 'trying out Elasticsearch'
}
})
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.search({
index: 'sales',
size: '0',
body: {
aggs: {
types_count: {
value_count: {
field: 'type'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,11 @@
// 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({
filter_path: '-_shards'
})
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({
index: 'twitter',
body: {
query: {
match: {
message: 'tring out Elasticsearch'
}
},
suggest: {
'my-suggestion': {
text: 'tring out Elasticsearch',
term: {
field: 'message'
}
}
}
}
})
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 response0 = await client.index({
index: 'library',
refresh: true,
body: {
title: 'Book #1',
rating: 200.1
}
})
console.log(response0)
const response1 = await client.index({
index: 'library',
refresh: true,
body: {
title: 'Book #2',
rating: 1.7
}
})
console.log(response1)
const response2 = await client.index({
index: 'library',
refresh: true,
body: {
title: 'Book #3',
rating: 0.1
}
})
console.log(response2)
const response3 = await client.search({
filter_path: 'hits.hits._source',
_source: 'title',
sort: 'rating:desc'
})
console.log(response3)
----

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: 'twitter',
size: 'surprise_me',
error_trace: 'true'
})
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({
index: 'sales',
size: '0',
body: {
aggs: {
dayOfWeek: {
terms: {
script: {
lang: 'painless',
source: "doc['date'].value.dayOfWeekEnum.value"
}
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,42 @@
// 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',
refresh: true,
body: {
date: '2015-10-01T00:30:00Z'
}
})
console.log(response0)
const response1 = await client.index({
index: 'my_index',
id: '2',
refresh: true,
body: {
date: '2015-10-01T01:30:00Z'
}
})
console.log(response1)
const response2 = await client.search({
index: 'my_index',
size: '0',
body: {
aggs: {
by_day: {
date_histogram: {
field: 'date',
calendar_interval: 'day'
}
}
}
}
})
console.log(response2)
----

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: {
match_phrase: {
message: {
query: 'this is a test',
analyzer: 'my_analyzer'
}
}
}
}
})
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.nodes.stats({
metric: 'indices',
index_metric: 'search'
})
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({
index: 'sales',
size: '0',
body: {
aggs: {
sales_over_time: {
date_histogram: {
field: 'date',
calendar_interval: '2d'
}
}
}
}
})
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.tasks.list({
detailed: 'true',
actions: '*byquery'
})
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.search({
index: 'twitter',
scroll: '1m',
body: {
size: 100,
query: {
match: {
title: 'elasticsearch'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,17 @@
// 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: {
match_phrase: {
message: 'this is a test'
}
}
}
})
console.log(response)
----

View File

@ -4,9 +4,8 @@
[source, js]
----
const response = await client.search({
index: 'twitter',
body: {
from: 0,
size: 10,
query: {
term: {
user: 'kimchy'

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.search({
index: 'sales',
size: '0',
body: {
aggs: {
sales_over_time: {
date_histogram: {
field: 'date',
calendar_interval: '1M',
format: 'yyyy-MM-dd'
}
}
}
}
})
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.search({
index: 'twitter',
routing: 'kimchy',
body: {
query: {
bool: {
must: {
query_string: {
query: 'some query string here'
}
},
filter: {
term: {
user: 'kimchy'
}
}
}
}
}
})
console.log(response)
----

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 response0 = await client.index({
index: 'my_index',
id: '1',
body: {
text: 'Document with ID 1'
}
})
console.log(response0)
const response1 = await client.index({
index: 'my_index',
id: '2',
refresh: 'true',
body: {
text: 'Document with ID 2'
}
})
console.log(response1)
const response2 = await client.search({
index: 'my_index',
body: {
query: {
terms: {
_id: [
'1',
'2'
]
}
}
}
})
console.log(response2)
----

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.search({
index: 'my_index',
size: '0',
body: {
aggs: {
by_day: {
date_histogram: {
field: 'date',
calendar_interval: 'day',
time_zone: '-01:00'
}
}
}
}
})
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.cluster.putSettings({
body: {
transient: {
'logger.org.elasticsearch.transport': 'trace'
}
}
})
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({
index: 'sales',
size: '0',
body: {
aggs: {
sales_over_time: {
date_histogram: {
field: 'date',
calendar_interval: '1M',
format: 'yyyy-MM-dd',
keyed: true
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,18 @@
// 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: '%3Clogstash-%7Bnow%2Fd%7D%3E',
body: {
query: {
match: {
test: 'data'
}
}
}
})
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 response0 = await client.updateByQuery({
index: 'test',
refresh: true,
conflicts: 'proceed'
})
console.log(response0)
const response1 = await client.search({
index: 'test',
filter_path: 'hits.total',
body: {
query: {
match: {
flag: 'foo'
}
}
}
})
console.log(response1)
----

View File

@ -0,0 +1,18 @@
// 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: '%3Clogstash-%7Bnow%2Fd-2d%7D%3E%2C%3Clogstash-%7Bnow%2Fd-1d%7D%3E%2C%3Clogstash-%7Bnow%2Fd%7D%3E',
body: {
query: {
match: {
test: 'data'
}
}
}
})
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.updateByQuery({
index: 'twitter',
conflicts: 'proceed'
})
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.search({
index: 'twitter',
size: 'surprise_me'
})
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.create({
index: 'my_index',
body: {
mappings: {
properties: {
number_of_bytes: {
type: 'integer'
},
time_in_seconds: {
type: 'float'
},
price: {
type: 'scaled_float',
scaling_factor: 100
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,11 @@
// 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.getMapping({
index: 'twitter'
})
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 response0 = await client.index({
index: 'my_index',
id: '1',
refresh: true,
body: {
date: '2015-10-01T05:30:00Z'
}
})
console.log(response0)
const response1 = await client.index({
index: 'my_index',
id: '2',
refresh: true,
body: {
date: '2015-10-01T06:30:00Z'
}
})
console.log(response1)
const response2 = await client.search({
index: 'my_index',
size: '0',
body: {
aggs: {
by_day: {
date_histogram: {
field: 'date',
calendar_interval: 'day',
offset: '+6h'
}
}
}
}
})
console.log(response2)
----

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.search({
index: 'test',
filter_path: 'hits.total',
body: {
query: {
match: {
flag: 'foo'
}
}
}
})
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.clearScroll({
body: {
scroll_id: 'DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=='
}
})
console.log(response)
----

View File

@ -0,0 +1,14 @@
// 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.scroll({
body: {
scroll: '1m',
scroll_id: 'DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=='
}
})
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({
index: 'sales',
size: '0',
body: {
aggs: {
sales_over_time: {
date_histogram: {
field: 'date',
calendar_interval: 'month'
}
}
}
}
})
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({
index: 'sales',
size: '0',
body: {
aggs: {
t_shirts: {
filter: {
term: {
type: 't-shirt'
}
},
aggs: {
avg_price: {
avg: {
field: 'price'
}
}
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,11 @@
// 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.clearScroll({
scroll_id: 'DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==,DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAAABFmtSWWRRWUJrU2o2ZExpSGJCVmQxYUEAAAAAAAAAAxZrUllkUVlCa1NqNmRMaUhiQlZkMWFBAAAAAAAAAAIWa1JZZFFZQmtTajZkTGlIYkJWZDFhQQAAAAAAAAAFFmtSWWRRWUJrU2o2ZExpSGJCVmQxYUEAAAAAAAAABBZrUllkUVlCa1NqNmRMaUhiQlZkMWFB'
})
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.getSettings({
index: 'twitter',
flat_settings: 'true'
})
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.updateByQueryRethrottle({
task_id: 'r1A2WoRbTwKZ516z6NEs5A:36619',
requests_per_second: '-1'
})
console.log(response)
----

View File

@ -0,0 +1,11 @@
// 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.get({
index: 'twitter'
})
console.log(response)
----

View File

@ -0,0 +1,11 @@
// 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.clearScroll({
scroll_id: '_all'
})
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 response0 = await client.ingest.putPipeline({
id: 'set-foo',
body: {
description: 'sets foo',
processors: [
{
set: {
field: 'foo',
value: 'bar'
}
}
]
}
})
console.log(response0)
const response1 = await client.updateByQuery({
index: 'twitter',
pipeline: 'set-foo'
})
console.log(response1)
----

View File

@ -0,0 +1,11 @@
// 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.updateByQuery({
index: 'twitter,blog'
})
console.log(response)
----

View File

@ -0,0 +1,11 @@
// 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.getMapping({
index: 'twitter,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.search({
scroll: '1m',
body: {
sort: [
'_doc'
]
}
})
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.updateByQuery({
index: 'twitter',
routing: '1'
})
console.log(response)
----

View File

@ -0,0 +1,71 @@
// 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: 'metrics_index',
id: '1',
body: {
'network.name': 'net-1',
latency_histo: {
values: [
0.1,
0.2,
0.3,
0.4,
0.5
],
counts: [
3,
7,
23,
12,
6
]
}
}
})
console.log(response0)
const response1 = await client.index({
index: 'metrics_index',
id: '2',
body: {
'network.name': 'net-2',
latency_histo: {
values: [
0.1,
0.2,
0.3,
0.4,
0.5
],
counts: [
8,
17,
8,
7,
6
]
}
}
})
console.log(response1)
const response2 = await client.search({
index: 'metrics_index',
size: '0',
body: {
aggs: {
total_requests: {
value_count: {
field: 'latency_histo'
}
}
}
}
})
console.log(response2)
----

View File

@ -0,0 +1,18 @@
// 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.updateByQuery({
index: 'twitter',
refresh: true,
slices: '5',
body: {
script: {
source: "ctx._source['extra'] = 'test'"
}
}
})
console.log(response)
----

View File

@ -0,0 +1,61 @@
// 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: {
text: {
type: 'text',
fields: {
english: {
type: 'text',
analyzer: 'english'
}
}
}
}
}
}
})
console.log(response0)
const response1 = await client.index({
index: 'my_index',
id: '1',
body: {
text: 'quick brown fox'
}
})
console.log(response1)
const response2 = await client.index({
index: 'my_index',
id: '2',
body: {
text: 'quick brown foxes'
}
})
console.log(response2)
const response3 = await client.search({
index: 'my_index',
body: {
query: {
multi_match: {
query: 'quick brown foxes',
fields: [
'text',
'text.english'
],
type: 'most_fields'
}
}
}
})
console.log(response3)
----

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({
index: 'twitter',
scroll: '1m',
body: {
slice: {
field: 'date',
id: 0,
max: 10
},
query: {
match: {
title: 'elasticsearch'
}
}
}
})
console.log(response)
----

View File

@ -1,7 +1,7 @@
[[client-usage]]
== Usage
Using the client is straightforward, it supports all the public APIs of {es},
Using the client is straightforward, it supports all the public APIs of {es},
and every method exposes the same signature.
@ -40,11 +40,11 @@ The returned value of every API call is formed as follows:
NOTE: The body is a boolean value when you use `HEAD` APIs.
The above value is returned even if there is an error during the execution of
the request, this means that you can safely use the
The above value is returned even if there is an error during the execution of
the request, this means that you can safely use the
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment[destructuring assignment].
The `meta` key contains all the information about the request, such as attempt,
The `meta` key contains all the information about the request, such as attempt,
options, and the connection that has been used.
[source,js]
@ -181,8 +181,8 @@ _Default:_ `null`
=== Error handling
The client exposes a variety of error objects that you can use to enhance your
error handling. You can find all the error objects inside the `errors` key in
The client exposes a variety of error objects that you can use to enhance your
error handling. You can find all the error objects inside the `errors` key in
the client.
[source,js]

View File

@ -74,7 +74,24 @@ const enabledFiles = [
'indices/aliases.asciidoc',
'indices/update-settings.asciidoc',
'search/request/from-size.asciidoc',
'search/count.asciidoc'
'search/count.asciidoc',
'setup/logging-config.asciidoc',
'search/request/from-size.asciidoc',
'query-dsl/match-phrase-query.asciidoc',
'aggregations/metrics/valuecount-aggregation.asciidoc',
'aggregations/bucket/datehistogram-aggregation.asciidoc',
'aggregations/bucket/filter-aggregation.asciidoc',
'mapping/types/numeric.asciidoc',
'mapping/fields/id-field.asciidoc',
'mapping/params/multi-fields.asciidoc',
'api-conventions.asciidoc',
'cat/indices.asciidoc',
'docs/update-by-query.asciidoc',
'indices/get-index.asciidoc',
'indices/get-mapping.asciidoc',
'search.asciidoc',
'search/request/scroll.asciidoc',
'search/suggesters.asciidoc'
]
function generate () {