Skip to content

Commit

Permalink
Merge pull request #426 from confluentinc/0.1.x-components-clean-up
Browse files Browse the repository at this point in the history
Clarify the deployment modes
  • Loading branch information
miguno authored Oct 30, 2017
2 parents 8020df0 + 8cc97c5 commit f3a8f60
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
15 changes: 8 additions & 7 deletions docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,17 @@
- [Modes of operation](#modes-of-operation)

# Components
The main components of KSQL are CLI, engine, and the REST interface.
The main components of KSQL are the KSQL CLI and the KSQL server.

#### CLI
Provides a familiar interface, designed users of MySQL, Postgres, etc.
#### KSQL CLI
The KSQL CLI allows you to interactively write KSQL queries.
Its interface should be familiar to users of MySQL, Postgres, Oracle, Hive, Presto, etc.

#### Engine
Performs the data processing.
The KSQL CLI acts as a client to the KSQL server (see next section).

#### REST interface
Enables an engine to receive instructions from the CLI.
#### KSQL Server
The KSQL server runs the engine that executes KSQL queries, which includes the data processing as well as reading
data from and writing data to the target Kafka cluster.

# Terminology
When using KSQL, the following terminology is used.
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/quickstart-non-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ connect is [UP]
$ mvn clean compile install -DskipTests
```

1. Start KSQL. The `local` argument starts the KSQL engine locally.
1. Start KSQL. The `local` argument starts KSQL in [standalone mode](/docs/concepts.md#modes-of-operation).

```bash
$ ./bin/ksql-cli local
Expand Down
4 changes: 2 additions & 2 deletions docs/syntax-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -455,9 +455,9 @@ TERMINATE query_id;
Terminate a persistent query. Persistent queries run continuously until they are explicitly terminated.

* In standalone mode, exiting the CLI will stop (think: "pause") any persistent queries because exiting the CLI will
also stop the KSQL engine. When the CLI is restarted, the engine will be restarted, too, and any previously defined
also stop the KSQL server. When the CLI is restarted, the server will be restarted, too, and any previously defined
persistent queries will resume processing.
* In client-server mode, exiting the CLI will not stop persistent queries because the KSQL engine(s) will continue to
* In client-server mode, exiting the CLI will not stop persistent queries because the KSQL server(s) will continue to
process the queries.

(To terminate a non-persistent query use `Ctrl-C` in the CLI.)
Expand Down

0 comments on commit f3a8f60

Please sign in to comment.