You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by jm...@apache.org on 2021/07/23 17:49:06 UTC
[datasketches-server] branch testing updated: remove unused config
file, update readme with build instructions
This is an automated email from the ASF dual-hosted git repository.
jmalkin pushed a commit to branch testing
in repository https://gitbox.apache.org/repos/asf/datasketches-server.git
The following commit(s) were added to refs/heads/testing by this push:
new 38eb2ee remove unused config file, update readme with build instructions
38eb2ee is described below
commit 38eb2eec99b31669e33d2c55ff3e4cf8b4f9c503
Author: Jon Malkin <jm...@users.noreply.github.com>
AuthorDate: Fri Jul 23 10:48:54 2021 -0700
remove unused config file, update readme with build instructions
---
README.md | 17 +++++++++++--
example/example_config.json | 62 ---------------------------------------------
2 files changed, 15 insertions(+), 64 deletions(-)
diff --git a/README.md b/README.md
index 9b03b92..14f5224 100644
--- a/README.md
+++ b/README.md
@@ -10,9 +10,22 @@ is on ease-of-use rather than speed.
The repository is still in an early state and lacks both unit tests and
robust documentation.
+## Installation and Running
+
+The server requires Java 8. There is no pre-built jar currently, so the server must be built
+locally. Running `mvn package` will download the relevant dependencies, including the
+DataSketches Java library and the Jetty web server. Once built, a stand-alone server is launched
+by running
+```
+java -cp <path_to_jar> org.apache.datasketches.server.SketchServer <json_config_file>
+```
+where the most convenient option will likely be the jar-with-dependencies. The configuration
+file format is described below.
+
+
## Interaction
-Configuration and interaction with the server are done via JSON. We will
+Configuration and interaction with the server happen via JSON. We will
demonstrate the main features of the server by creating a simple configuration
and using that for some example requests and responses.
@@ -21,7 +34,7 @@ a JSON Array. Also, the server does not implement a transactional database. In t
of an error partway through an array the server will return an error, but the
effects of any requests processed up to that point will be retained.
-JSON input may be passed in via either POST or GET.
+The server accepts JSON input presented via either POST or GET.
### Sketch Families
diff --git a/example/example_config.json b/example/example_config.json
deleted file mode 100644
index 2c0b24c..0000000
--- a/example/example_config.json
+++ /dev/null
@@ -1,62 +0,0 @@
-{
- "port": 8080,
- "bookstoreSketches": [
- { "name": "cpc_int",
- "k": 12,
- "type": "int",
- "family": "cpc"
- },
- { "name": "cpc_string",
- "k": 12,
- "type": "string",
- "family": "cpc"
- }
- ],
- "bookGenreDurationSet": {
- "family": "hll",
- "type": "double",
- "k": 14,
- "names": [
- "hll1",
- "hll2",
- "hll3",
- "hll4"
- ]
- },
- "set2": {
- "k": 12,
- "family": "theta",
- "type": "float",
- "names": [
- "theta0",
- "theta1",
- "theta2",
- "theta3",
- "theta4"
- ]
- },
- "sketches_B": [
- { "name": "kll",
- "k": "160",
- "family": "kll"
- },
- { "name": "cpc",
- "k": "14",
- "type": "string",
- "family": "cpc"
- },
- { "name": "fi",
- "k": "128",
- "family": "frequency"
- },
- { "name": "rs",
- "k": "20",
- "family": "reservoir"
- },
- { "name": "vo",
- "k": "20",
- "family": "varopt"
- }
- ]
-}
-
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org