Skip to content

Commit

Permalink
Typos
Browse files Browse the repository at this point in the history
  • Loading branch information
refset committed Jul 7, 2020
1 parent d883382 commit ff3e16e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/get_started.adoc
Expand Up @@ -34,9 +34,9 @@ include::./src/docs/examples.clj[tags=include-crux-api]
include::./src/docs/examples.clj[tags=start-standalone-node]
----

For the purposes of this "Hello World" we are using the simplest configuration of Crux, which only requires the crux-core module. All of the logs and indexes are held only in memory, so your data won't be persisted across restarts. This is useful when testing and experimenting as there is no additional complexity or stateful use of Kafka or RocksDB to think about.
For the purposes of this "Hello World" we are using the simplest configuration of Crux, which only requires the crux-core module. All of the logs and indexes are held purely in-memory, so your data won't be persisted across restarts. This is useful when testing and experimenting as there is no additional complexity or stateful use of Kafka or RocksDB to think about.

Once started, the node gives us access to an empty Crux database instance and API for running transactions and issuing queries. Depending on how you configure your topology, multiple nodes may share the same database, but in this case your node exclusive owns the database instance. If a Kafka or JDBC module topology was used instead then the same database instance would be available across multiple nodes to provide stronger durability, high-availabilty and horizontal scaling.
Once started, the node gives us access to an empty Crux database instance and API for running transactions and issuing queries. Depending on how you configure your topology, multiple nodes may share the same database, but in this case your node exclusively owns the database instance. If a Kafka or JDBC module topology was used instead then the same database instance would be available across multiple nodes to provide fault-tolerant durability, high-availabilty and horizontal scaling.

=== Transacting

Expand All @@ -48,7 +48,7 @@ include::./src/docs/examples.clj[tags=submit-tx]
[#get-started-query]
=== Querying

A query executes against a `db` context. This `db` context represents the database "as a value" at a fixed & consistent point-in-time against which other APIs can be used. The `db` value should be thought of as a lightweight reference - it is not a container for a resource or lock. The point-in-time is implicitly "now", unless otherwise specified, and there the context returned represents the latest view of the database following the most recently processed transaction. The main query API is eager but you may also consume the results lazily as the entire Crux query engine and index structure is lazy by design.
A query executes against a `db` context. This `db` context represents the database "as a value" at a fixed & consistent point-in-time against which other APIs can be used. The `db` context should be thought of as a lightweight reference - it is not a container for a resource or lock. The point-in-time is implicitly "now", unless otherwise specified, and there the context returned represents the latest view of the database following the most recently processed transaction. The main query API is eager but you may also consume the results lazily as the entire Crux query engine and index structure is lazy by design.

[source,clj]
----
Expand Down
3 changes: 1 addition & 2 deletions docs/what_is_crux.adoc
Expand Up @@ -56,8 +56,7 @@ did you know it?".
=== Query

Crux supports a Datalog query interface for traversing graph relationships
across your documents. Queries are executed so that the results are lazily
streamed from the underlying indexes.
across your documents. Query results are lazily streamed from the underlying Key-Value indexes.

Crux is ultimately a store of versioned EDN documents. The fields within these
documents are automatically indexed as Entity-Attribute-Value triples to
Expand Down

0 comments on commit ff3e16e

Please sign in to comment.