From c7c6b3dacdf1132a035396de602ca1d4ba46ff5a Mon Sep 17 00:00:00 2001 From: kelvinqian00 <32022576+kelvinqian00@users.noreply.github.com> Date: Tue, 24 Sep 2024 15:38:49 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20yetanaly?= =?UTF-8?q?tics/lrsql@9551e885105f9f327db5123e249197e3a8b2f180=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- authority.html | 2 +- aws.html | 2 +- dev.html | 4 ++-- docker.html | 2 +- endpoints.html | 2 +- env_vars.html | 2 +- general_faq.html | 2 +- https.html | 2 +- index.html | 2 +- oidc.html | 2 +- oidc/auth0.html | 2 +- overview.html | 2 +- postgres.html | 2 +- postman.html | 2 +- reactions.html | 2 +- sqlite.html | 2 +- startup.html | 2 +- superset.html | 2 +- troubleshooting.html | 2 +- 19 files changed, 20 insertions(+), 20 deletions(-) diff --git a/authority.html b/authority.html index 4498c2f1..f8900373 100644 --- a/authority.html +++ b/authority.html @@ -167,7 +167,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/aws.html b/aws.html index 80b1329b..d753afdc 100644 --- a/aws.html +++ b/aws.html @@ -129,7 +129,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/dev.html b/dev.html index 73b6080b..36d006d6 100644 --- a/dev.html +++ b/dev.html @@ -126,7 +126,7 @@

<- Back to Index

Developer Documentation

The SQL LRS is a Clojure Web Application built on the Pedestal Framework.

Build

The SQL LRS can be built or run with the following Makefile targets. They can be executed with make [target].

Build and Test Targets

TargetDescription
ciCalled when running continuous integration; runs all test cases in all SQL flavors.
test-sqliteRun all tests with SQLite database.
test-postgresRun all tests with Postgres database version 11. Set the LRSQL_TEST_DB_VERSION env var to a valid Postgres docker tag to use another version.
test-postgres-11Run all tests with Postgres database version 11.
test-postgres-12Run all tests with Postgres database version 12.
test-postgres-13Run all tests with Postgres database version 13.
test-postgres-14Run all tests with Postgres database version 14.
test-postgres-15Run all tests with Postgres database version 15.
bundleBuild a complete distribution of the SQL LRS including the user interface and native runtimes for multiple operating systems.
benchRun a load test and benchmark performance, returning performance metrics on predefined test data. Requires a running SQL LRS instance to test against. This test sends requests synchronously on one thread.
bench-asyncSame as bench but it runs with concurrent requests on multiple threads.
check-vulnRun the nvd-clojure tool, which checks for vulnerabilities against the National Vulnerability Database.

Run Targets

TargetDescription
ephemeralStart an in-memory SQL LRS based on SQLite DB.
ephemeral-prodSimilar to ephemeral, except that the :prod profile is used, enabling the use of environment variables without full compilation.
sqliteStart a SQLite-based SQL LRS.
postgresStart a Postgres SQL LRS. Requires a running Postgres instance.
run-jar-sqliteSimilar to sqlite but it runs the finished Jar instead of directly from Clojure. Runs with a predefined default set of env variables.
run-jar-sqlite-ephemeralSimilar to ephemeral but it runs the finished Jar instead of directly from Clojure. Runs with a predefined default set of env variables.
run-jar-postgresSimilar to postgres but it runs the finished Jar instead of directly from Clojure. Runs with a predefined default set of env variables.

Cleanup Targets

TargetDescription
cleanRemoves all build artifacts.
clean-non-dlSame as clean except that it does not delete downloaded folders.
clean-devRemoves development files.
clean-exeRemoves the finished Windows executables, allowing recreation.

Benchmarking

You can customize and run benchmarks for SQL LRS (or any conformant LRS, though the benchmarking framework was designed for SQL LRS). The benchmarking framework will insert auto-generated Statements into a running SQL LRS instance, then querying them and recording query time statistics.

1. Set up insertion inputs

This step can be skipped if your DB already has Statements stored and you are only running queries.

The insertion input file is a JSON file that follows the DATASIM input format. The benchmarking framework uses DATASIM to generate a Statement sequence from that input file. See the DATASIM documentation for more information about the proper input format.

2. Set up query inputs

The query input file is a JSON file containing an array of Statement query parameter objects. The following is an example query input:

[{}, { "verb": "https://w3id.org/xapi/video/verbs/seeked" }]
 

See the Statement resource documentation for a full list of query parameters.

3. Start an LRS instance

Start an instance of the SQL LRS (or any conformant LRS). The above Makefile targets provide a convenient way of doing so.

4. Run the benchmarks

In another terminal, run the benchmarking framework by calling:

clojure -M:bench -m lrsql.bench [arguments]
-

The following is the full list of arguments (which can also be accessed by passing the --help argument):

ArgumentValueDefaultDescription
-e, --lrs-endpointURI
http://0.0.0.0:8080/xapi/statements(URI)
The HTTP(S) endpoint of the (SQL) LRS webserver for Statement POSTs and GETs.
-i, --insert-inputFilepathNoneThe location of a JSON file containing a DATASIM input spec. If present, this input is used to insert statements into the DB.
-s, --input-sizeInteger1000The total number of statements to insert. Ignored if -i is not present.
-b, --batch-sizeInteger10The batch size to use for inserting statements. Ignored if -i is not present.
-a, --asyncNo argsN/AIf provided, insert statements asynchronously.
-c, --concurrencyInteger10The number of parallel threads to run during statement insertion and querying. Ignored if -a is not present.
-r, --statement-refsKeywordnoneHow Statement References should be generated and inserted. Valid options are none (no Statement References), half (half of the Statements have StatementRef objects), and all (all Statements have StatementRef objects).
-q, --query-inputFilepathNoneThe location of a JSON file containing an array of statement query params. If not present, the benchmark does a single query with no params.
-n, --query-numberInteger30The number of times each query is performed.
-u, --userStringNoneHTTP Basic Auth user.
-p, --passStringNoneHTTP Basic Auth password.
-h, --helpNo argsN/AHelp menu.

5. Wait for results

After the bench has run, you should see results that look something like this:

********** Query benchmark results for n = 30 (in ms) **********
+

The following is the full list of arguments (which can also be accessed by passing the --help argument):

ArgumentValueDefaultDescription
-e, --lrs-endpointURI
http://0.0.0.0:8080/xapi/statements(URI)
The HTTP(S) endpoint of the (SQL) LRS webserver for Statement POSTs and GETs.
-i, --insert-inputFilepathNoneThe location of a JSON file containing a DATASIM input spec. If given, this input is used to insert statements into the DB.
-s, --input-sizeInteger1000The total number of statements to insert. Ignored if -i is not given.
-b, --batch-sizeInteger10The batch size to use for inserting statements. Ignored if -i is not given.
-a, --async?BooleanfalseWhether to insert asynchronously or not.
-c, --concurrencyInteger10The number of parallel threads to run during statement insertion and querying. Ignored if -a is false.
-r, --statement-refsKeywordnoneHow Statement References should be generated and inserted. Valid options are none (no Statement References), half (half of the Statements have StatementRef objects), and all (all Statements have StatementRef objects).
-q, --query-inputFilepathNoneThe location of a JSON file containing an array of statement query params. If not given, the benchmark does a single query with no params.
-n, --query-numberInteger30The number of times each query is performed.
-u, --userStringNoneHTTP Basic Auth user.
-p, --passStringNoneHTTP Basic Auth password.
-h, --helpNo argsNoneHelp menu.

5. Wait for results

After the bench has run, you should see results that look something like this:

********** Query benchmark results for n = 30 (in ms) **********
 
 |                                              :query | :mean | :sd | :max | :min | :total |
 |-----------------------------------------------------+-------+-----+------+------+--------|
@@ -138,7 +138,7 @@
          © 2021-2024 Yet Analytics Inc. |
          Licensed under the Apache 2.0 License |
          Contribute on GitHub
-         Build: 6bdee027a58770de612343df04b08177a690e52d
+         Build: 9551e885105f9f327db5123e249197e3a8b2f180
         
       
     
diff --git a/docker.html b/docker.html
index fb2ac9af..8b967e3a 100644
--- a/docker.html
+++ b/docker.html
@@ -175,7 +175,7 @@
          © 2021-2024 Yet Analytics Inc. |
          Licensed under the Apache 2.0 License |
          Contribute on GitHub
-         Build: 6bdee027a58770de612343df04b08177a690e52d
+         Build: 9551e885105f9f327db5123e249197e3a8b2f180
         
       
     
diff --git a/endpoints.html b/endpoints.html
index 4d7d0f98..c6ccc5af 100644
--- a/endpoints.html
+++ b/endpoints.html
@@ -132,7 +132,7 @@
          © 2021-2024 Yet Analytics Inc. |
          Licensed under the Apache 2.0 License |
          Contribute on GitHub
-         Build: 6bdee027a58770de612343df04b08177a690e52d
+         Build: 9551e885105f9f327db5123e249197e3a8b2f180
         
       
     
diff --git a/env_vars.html b/env_vars.html
index 19c9c1a8..83386f9c 100644
--- a/env_vars.html
+++ b/env_vars.html
@@ -129,7 +129,7 @@
          © 2021-2024 Yet Analytics Inc. |
          Licensed under the Apache 2.0 License |
          Contribute on GitHub
-         Build: 6bdee027a58770de612343df04b08177a690e52d
+         Build: 9551e885105f9f327db5123e249197e3a8b2f180
         
       
     
diff --git a/general_faq.html b/general_faq.html
index f0e6cdb5..43c194ac 100644
--- a/general_faq.html
+++ b/general_faq.html
@@ -129,7 +129,7 @@
          © 2021-2024 Yet Analytics Inc. |
          Licensed under the Apache 2.0 License |
          Contribute on GitHub
-         Build: 6bdee027a58770de612343df04b08177a690e52d
+         Build: 9551e885105f9f327db5123e249197e3a8b2f180
         
       
     
diff --git a/https.html b/https.html
index 66e688c8..8f276a16 100644
--- a/https.html
+++ b/https.html
@@ -155,7 +155,7 @@
          © 2021-2024 Yet Analytics Inc. |
          Licensed under the Apache 2.0 License |
          Contribute on GitHub
-         Build: 6bdee027a58770de612343df04b08177a690e52d
+         Build: 9551e885105f9f327db5123e249197e3a8b2f180
         
       
     
diff --git a/index.html b/index.html
index c4d45e19..df917dc1 100644
--- a/index.html
+++ b/index.html
@@ -129,7 +129,7 @@ 

Documentation Index

Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/oidc.html b/oidc.html index 3789e1ab..49ceab60 100644 --- a/oidc.html +++ b/oidc.html @@ -134,7 +134,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/oidc/auth0.html b/oidc/auth0.html index 956211f7..97296207 100644 --- a/oidc/auth0.html +++ b/oidc/auth0.html @@ -172,7 +172,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/overview.html b/overview.html index 50bb1cb0..aabeb378 100644 --- a/overview.html +++ b/overview.html @@ -129,7 +129,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/postgres.html b/postgres.html index 90732ffd..105de0ee 100644 --- a/postgres.html +++ b/postgres.html @@ -162,7 +162,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/postman.html b/postman.html index 22d848bb..5ac53c65 100644 --- a/postman.html +++ b/postman.html @@ -129,7 +129,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/reactions.html b/reactions.html index 33f398af..c4777864 100644 --- a/reactions.html +++ b/reactions.html @@ -294,7 +294,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/sqlite.html b/sqlite.html index e6448291..af1485eb 100644 --- a/sqlite.html +++ b/sqlite.html @@ -135,7 +135,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/startup.html b/startup.html index 245b1223..554b0d82 100644 --- a/startup.html +++ b/startup.html @@ -170,7 +170,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/superset.html b/superset.html index af22691b..61c9a270 100644 --- a/superset.html +++ b/superset.html @@ -145,7 +145,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180 diff --git a/troubleshooting.html b/troubleshooting.html index c2a0a4ab..718a419a 100644 --- a/troubleshooting.html +++ b/troubleshooting.html @@ -129,7 +129,7 @@ © 2021-2024 Yet Analytics Inc. | Licensed under the Apache 2.0 License | Contribute on GitHub - Build: 6bdee027a58770de612343df04b08177a690e52d + Build: 9551e885105f9f327db5123e249197e3a8b2f180