Homec4science
Diffusion YCSB (master) Browse

R7507/elasticsearch5/README.md
385a3898a779master

Last Change
Raw File

README.md
View Options

<!--
Copyright (c) 2017 YCSB contributors. All rights reserved.
Licensed 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. See accompanying
LICENSE file.
-->
## Quick Start
This section describes how to run YCSB on Elasticsearch 5.x running locally.
### 1. Install and Start Elasticsearch
[Download and install Elasticsearch][1]. When starting Elasticsearch, you should
[configure][2] the cluster name to be `es.ycsb.cluster` (see below).
### 2. Set Up YCSB
Clone the YCSB git repository and compile:
git clone git://github.com/brianfrankcooper/YCSB.git
cd YCSB
mvn clean package
### 3. Run YCSB
Now you are ready to run! First, load the data:
./bin/ycsb load elasticsearch5 -s -P workloads/workloada
Then, run the workload:
./bin/ycsb run elasticsearch5 -s -P workloads/workloada
The Elasticsearch 5 binding requires a standalone instance of Elasticsearch.
You must specify a hosts list for the transport client to connect to via
`-p es.hosts.list=<hostname1:port1>,...,<hostnamen:portn>`:
./bin/ycsb run elasticsearch5 -s -P workloads/workloada \
-p es.hosts.list=<hostname1:port1>,...,<hostnamen:portn>`
Note that `es.hosts.list` defaults to `localhost:9300`. For further
configuration see below:
### Defaults Configuration
The default setting for the Elasticsearch node that is created is as follows:
es.setting.cluster.name=es.ycsb.cluster
es.index.key=es.ycsb
es.number_of_shards=1
es.number_of_replicas=0
es.new_index=false
es.hosts.list=localhost:9300
### Custom Configuration
If you wish to customize the settings used to create the Elasticsearch node
you can created a new property file that contains your desired Elasticsearch
node settings and pass it in via the parameter to 'bin/ycsb' script. Note that
the default properties will be kept if you don't explicitly overwrite them.
Assuming that we have a properties file named "myproperties.data" that contains
custom Elasticsearch node configuration you can execute the following to
pass it into the Elasticsearch client:
./bin/ycsb run elasticsearch5 -P workloads/workloada -P myproperties.data -s
If you wish to change the default index name you can set the following property:
es.index.key=my_index_key
By default this will use localhost:9300 as a seed node to discover the cluster.
You can also specify
es.hosts.list=(\w+:\d+)+
(a comma-separated list of host/port pairs) to change this.
### Configuring the transport client
The `elasticsearch5` binding starts a transport client to connect to
Elasticsearch using the transport protocol. You can pass arbitrary settings to
this instance by using properties with the prefix `es.setting.` followed by any
valid Elasticsearch setting. For example, assuming that you started your
Elasticsearch node with the cluster name `my-elasticsearch-cluster`, you would
need to configure the transport client to use the same cluster name via
./bin/ycsb run elasticsearch5 -P <workload> \
-p es.setting.cluster.name=my-elasticsearch-cluster
### Using the Elasticsearch low-level REST client
The Elasticsearch 5 bindings also ship with an implementation that uses the
low-level Elasticsearch REST client. The name of this binding is
`elasticsearch-rest`. For example:
./bin/ycsb load elasticsearch5-rest -P workloads/workloada
You can configure the hosts to connect to via the same `es.hosts.list` property
used to configure the transport client in the `elasticsearch5` binding (note
that by default you should use port 9200)
[1]: https://www.elastic.co/guide/en/elasticsearch/reference/5.5/_installation.html
[2]: https://www.elastic.co/guide/en/elasticsearch/reference/5.5/settings.html
c4science · Help