Skip to content

Commit d9aae3d

Browse files
authored
Quick start update (#29)
1 parent 5f7dc16 commit d9aae3d

File tree

11 files changed

+37
-41
lines changed

11 files changed

+37
-41
lines changed

docs/about/contact.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ If you have any issues with any of the particular Bullet sub-components, feel fr
66

77
| | |
88
| ------------- | ------ |
9-
| Storm | [https://github.com/bullet-db/bullet-storm/issues](https://github.com/bullet-db/bullet-storm/issues) |
10-
| Spark | [https://github.com/bullet-db/bullet-spark/issues](https://github.com/bullet-db/bullet-spark/issues) |
11-
| Web Service | [https://github.com/bullet-db/bullet-service/issues](https://github.com/bullet-db/bullet-service/issues) |
12-
| UI | [https://github.com/bullet-db/bullet-ui/issues](https://github.com/bullet-db/bullet-ui/issues) |
13-
| Record | [https://github.com/bullet-db/bullet-record/issues](https://github.com/bullet-db/bullet-record/issues) |
14-
| Core | [https://github.com/bullet-db/bullet-core/issues](https://github.com/bullet-db/bullet-core/issues) |
15-
| Kafka PubSub | [https://github.com/bullet-db/bullet-kafka/issues](https://github.com/bullet-db/bullet-kafka/issues) |
16-
| Documentation | [https://github.com/bullet-db/bullet-docs/issues](https://github.com/bullet-db/bullet-docs/issues) |
9+
| Storm | [https://github.com/bullet-db/bullet-storm/issues](https://github.com/bullet-db/bullet-storm/issues) |
10+
| Spark | [https://github.com/bullet-db/bullet-spark/issues](https://github.com/bullet-db/bullet-spark/issues) |
11+
| Web Service | [https://github.com/bullet-db/bullet-service/issues](https://github.com/bullet-db/bullet-service/issues) |
12+
| UI | [https://github.com/bullet-db/bullet-ui/issues](https://github.com/bullet-db/bullet-ui/issues) |
13+
| Record | [https://github.com/bullet-db/bullet-record/issues](https://github.com/bullet-db/bullet-record/issues) |
14+
| Core | [https://github.com/bullet-db/bullet-core/issues](https://github.com/bullet-db/bullet-core/issues) |
15+
| Kafka PubSub | [https://github.com/bullet-db/bullet-kafka/issues](https://github.com/bullet-db/bullet-kafka/issues) |
16+
| Documentation | [https://github.com/bullet-db/bullet-db.github.io/issues](https://github.com/bullet-db/bullet-db.github.io/issues) |
1717

1818
## Mailing Lists
1919

docs/apidocs/bullet-ui/0.6.0/index.html

-1
This file was deleted.

docs/apidocs/bullet-ui/0.6.1/index.html

-1
This file was deleted.

docs/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,15 @@ Bullet queries allow you to filter, project and aggregate data. You can also spe
6363

6464
* See the [UI Usage section](ui/usage.md) for using the UI to build Bullet queries. This is the same UI you will build in the Quick Starts.
6565

66-
* See the API section ([JSON](ws/api-json.md), [BQL](ws/api-bql.md)) for building Bullet API queries
66+
* See the API section ([BQL](ws/api-bql.md), or the more verbose, underlying query format - [JSON](ws/api-json.md)) for building Bullet API queries
6767

6868
* For examples using the API, see [Examples](ws/examples.md). These are actual albeit cleansed queries sourced from the instance at Yahoo.
6969

7070
## Termination conditions
7171

7272
A Bullet query terminates and returns whatever has been collected so far when:
7373

74-
1. A maximum duration is reached. In other words, a query runs for a defined time window.
74+
1. A maximum duration is reached. In other words, a query runs for a defined time window (which can be infinite).
7575
2. A maximum number of records is reached (only applicable for queries that are fetching raw data records and not aggregating).
7676

7777
## Filters

docs/quick-start/spark.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ mkdir -p $BULLET_HOME/pubsub
3737
mkdir -p $BULLET_HOME/service
3838
mkdir -p $BULLET_HOME/ui
3939
cd $BULLET_HOME
40-
curl -LO https://github.com/bullet-db/bullet-db.github.io/releases/download/v0.5.2/examples_artifacts.tar.gz
40+
curl -LO https://github.com/bullet-db/bullet-db.github.io/releases/download/v0.6.0/examples_artifacts.tar.gz
4141
tar -xzf examples_artifacts.tar.gz
4242
export BULLET_EXAMPLES=$BULLET_HOME/bullet-examples
4343
```
@@ -50,7 +50,7 @@ For this instance of Bullet we will use the Kafka PubSub implementation found in
5050

5151
```bash
5252
cd $BULLET_HOME/pubsub
53-
curl -Lo bullet-kafka.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-kafka/0.3.0/bullet-kafka-0.3.0-fat.jar
53+
curl -Lo bullet-kafka.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-kafka/0.3.2/bullet-kafka-0.3.2-fat.jar
5454
curl -LO https://archive.apache.org/dist/kafka/0.11.0.1/kafka_2.12-0.11.0.1.tgz
5555
tar -xzf kafka_2.12-0.11.0.1.tgz
5656
export KAFKA_DIR=$BULLET_HOME/pubsub/kafka_2.12-0.11.0.1
@@ -96,7 +96,7 @@ tar -xzf spark-2.2.1-bin-hadoop2.7.tgz
9696

9797
```bash
9898
cp $BULLET_HOME/bullet-examples/backend/spark/* $BULLET_SPARK
99-
curl -Lo bullet-spark.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-spark/0.1.2/bullet-spark-0.1.2-standalone.jar
99+
curl -Lo bullet-spark.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-spark/0.2.1/bullet-spark-0.2.1-standalone.jar
100100
```
101101

102102
#### Step 8: Launch the Bullet Spark Backend
@@ -121,7 +121,7 @@ The Backend will usually be up and running usually within 5-10 seconds. Once it
121121

122122
```bash
123123
cd $BULLET_HOME/service
124-
curl -Lo bullet-service.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-service/0.2.1/bullet-service-0.2.1-embedded.jar
124+
curl -Lo bullet-service.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-service/0.4.3/bullet-service-0.4.3-embedded.jar
125125
cp $BULLET_EXAMPLES/web-service/example_kafka_pubsub_config.yaml $BULLET_HOME/service/
126126
cp $BULLET_EXAMPLES/web-service/example_columns.json $BULLET_HOME/service/
127127
```
@@ -174,8 +174,8 @@ nvm use v6.9.4
174174
#### Step 13: Install the Bullet UI
175175

176176
```bash
177-
curl -LO https://github.com/bullet-db/bullet-ui/releases/download/v0.5.0/bullet-ui-v0.5.0.tar.gz
178-
tar -xzf bullet-ui-v0.5.0.tar.gz
177+
curl -LO https://github.com/bullet-db/bullet-ui/releases/download/v0.6.1/bullet-ui-v0.6.1.tar.gz
178+
tar -xzf bullet-ui-v0.6.1.tar.gz
179179
cp $BULLET_EXAMPLES/ui/env-settings.json config/
180180
```
181181

docs/quick-start/storm.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ This section gets you running a mock instance of Bullet to play around with. The
44

55
At the end of this section, you will have:
66

7-
* Setup the Bullet topology using a custom spout on [bullet-storm-0.8.3](https://github.com/bullet-db/bullet-storm/releases/tag/bullet-storm-0.8.3)
8-
* Setup the [Web Service](../ws/setup.md) talking to the topology and serving a schema for your UI using [bullet-service-0.3.0](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.3.0)
9-
* Setup the [REST PubSub](../pubsub/rest.md) talking to the topology and Web Service using [bullet-core-0.4.2](https://github.com/bullet-db/bullet-core/releases/tag/bullet-core-0.4.2).
10-
* Setup the [UI](../ui/setup.md) talking to the Web Service using [bullet-ui-0.5.0](https://github.com/bullet-db/bullet-ui/releases/tag/v0.5.0)
7+
* Setup the Bullet topology using a custom spout on [bullet-storm-0.8.5](https://github.com/bullet-db/bullet-storm/releases/tag/bullet-storm-0.8.5)
8+
* Setup the [Web Service](../ws/setup.md) talking to the topology and serving a schema for your UI using [bullet-service-0.4.3](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.3)
9+
* Setup the [REST PubSub](../pubsub/rest.md) talking to the topology and Web Service using [bullet-core-0.6.4](https://github.com/bullet-db/bullet-core/releases/tag/bullet-core-0.6.4).
10+
* Setup the [UI](../ui/setup.md) talking to the Web Service using [bullet-ui-0.6.1](https://github.com/bullet-db/bullet-ui/releases/tag/v0.6.1)
1111

1212
**Prerequisites**
1313

@@ -43,7 +43,7 @@ mkdir -p $BULLET_HOME/backend/storm
4343
mkdir -p $BULLET_HOME/service
4444
mkdir -p $BULLET_HOME/ui
4545
cd $BULLET_HOME
46-
curl -LO https://github.com/bullet-db/bullet-db.github.io/releases/download/v0.5.2/examples_artifacts.tar.gz
46+
curl -LO https://github.com/bullet-db/bullet-db.github.io/releases/download/v0.6.0/examples_artifacts.tar.gz
4747
tar -xzf examples_artifacts.tar.gz
4848
export BULLET_EXAMPLES=$BULLET_HOME/bullet-examples
4949
```
@@ -133,7 +133,7 @@ Visit the UI and see if the topology is up. You should see the ```DataSource```
133133

134134
```bash
135135
cd $BULLET_HOME/service
136-
curl -Lo bullet-service.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-service/0.3.0/bullet-service-0.3.0-embedded.jar
136+
curl -Lo bullet-service.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-service/0.4.3/bullet-service-0.4.3-embedded.jar
137137
cp $BULLET_EXAMPLES/web-service/example* $BULLET_HOME/service/
138138
```
139139

@@ -168,8 +168,8 @@ nvm use v6.9.4
168168

169169
```bash
170170
cd $BULLET_HOME/ui
171-
curl -LO https://github.com/bullet-db/bullet-ui/releases/download/src/bullet-ui-v0.5.0.tar.gz
172-
tar -xzf bullet-ui-v0.5.0.tar.gz
171+
curl -LO https://github.com/bullet-db/bullet-ui/releases/download/src/bullet-ui-v0.6.1.tar.gz
172+
tar -xzf bullet-ui-v0.6.1.tar.gz
173173
cp $BULLET_EXAMPLES/ui/env-settings.json config/
174174
```
175175

docs/releases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ The Web Service implementation that can serve a static schema from a file and ta
144144

145145
| Date | Release | Highlights | APIDocs |
146146
| ------------ | -------------------------------------------------------------------------------------- | ---------- | ------- |
147-
| 2018-11-28 | [**0.4.4**](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.3) | Updates bullet-bql to 0.2.1 | [JavaDocs](apidocs/bullet-service/0.4.3/index.html) |
147+
| 2018-11-28 | [**0.4.3**](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.3) | Updates bullet-bql to 0.2.1 | [JavaDocs](apidocs/bullet-service/0.4.3/index.html) |
148148
| 2018-11-26 | [**0.4.2**](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.2) | BQL to JSON endpoint, dead backend reaper, new types in Schema, bullet-core 0.6.4 | [JavaDocs](apidocs/bullet-service/0.4.2/index.html) |
149149
| 2018-09-06 | [**0.4.1**](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.1) | Max Queries limit and bullet-bql 0.1.2 | [JavaDocs](apidocs/bullet-service/0.4.1/index.html) |
150150
| 2018-07-17 | [**0.4.0**](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.0) | Enhanced Web Service to support BQL queries | [JavaDocs](apidocs/bullet-service/0.4.0/index.html) |

docs/ws/api-bql.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,7 @@ and `limit_clause` is one of
113113

114114
* **String**: character string which can have escapes. Example: `'this is a string'`, `'this is ''another'' string'`.
115115

116-
* **ColumnReference**: representation of a single column. Unquoted ColumnReference must start with a letter or `_`. Example: `column_name`.
117-
118-
* **Dereference**: representation of a column field. Example: `column_name.field_name`.
116+
* **ColumnReference**: representation of a column field. Unquoted ColumnReference must start with a letter or `_`. Example: `column_name` or `column_name.foo` or `column_name.foo.bar` or `column_name.0.bar`.
119117

120118
* **All**: representation of all columns. Example: `*`. `column_name.*` is interpreted as `column_name`.
121119

examples/install-all-spark.sh

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
set -euo pipefail
44

5-
BULLET_EXAMPLES_VERSION=0.5.2
6-
BULLET_UI_VERSION=0.5.0
7-
BULLET_WS_VERSION=0.3.0
8-
BULLET_KAFKA_VERSION=0.3.0
9-
BULLET_SPARK_VERSION=0.1.2
5+
BULLET_EXAMPLES_VERSION=0.6.0
6+
BULLET_UI_VERSION=0.6.1
7+
BULLET_WS_VERSION=0.4.3
8+
BULLET_KAFKA_VERSION=0.3.2
9+
BULLET_SPARK_VERSION=0.2.1
1010
KAFKA_VERSION=0.11.0.1
1111
SPARK_VERSION=2.2.1
1212
NVM_VERSION=0.33.1

examples/install-all-storm.sh

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
set -euo pipefail
44

5-
BULLET_EXAMPLES_VERSION=0.5.2
6-
BULLET_UI_VERSION=0.5.0
7-
BULLET_WS_VERSION=0.3.0
5+
BULLET_EXAMPLES_VERSION=0.6.0
6+
BULLET_UI_VERSION=0.6.1
7+
BULLET_WS_VERSION=0.4.3
88
STORM_VERSION=1.2.2
99
NVM_VERSION=0.33.1
1010
NODE_VERSION=6.9.4

examples/storm/pom.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
2727
<maven.compiler.source>1.8</maven.compiler.source>
2828
<maven.compiler.target>1.8</maven.compiler.target>
29-
<bullet.storm.version>0.8.3</bullet.storm.version>
30-
<bullet.core.version>0.4.2</bullet.core.version>
31-
<bullet.record.version>0.2.0</bullet.record.version>
29+
<bullet.storm.version>0.8.5</bullet.storm.version>
30+
<bullet.core.version>0.6.4</bullet.core.version>
31+
<bullet.record.version>0.3.0</bullet.record.version>
3232
<storm.version>1.1.3</storm.version>
3333
</properties>
3434

0 commit comments

Comments
 (0)