From 01defb88a781082d2e8821aafdd3754ecb789193 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 18 Mar 2024 17:25:37 +0000 Subject: [PATCH 001/118] Fix dependency ref and comment out excessive .factory builds --- .factory/automation.yml | 832 +++++++++++++------------- dependencies/vaticle/repositories.bzl | 2 +- 2 files changed, 417 insertions(+), 417 deletions(-) diff --git a/.factory/automation.yml b/.factory/automation.yml index 9283a81ce2..31b9addc19 100644 --- a/.factory/automation.yml +++ b/.factory/automation.yml @@ -75,221 +75,221 @@ build: git add $DOCS_DIRS git diff --exit-code HEAD $DOCS_DIRS - test-rust-unit-integration: - image: vaticle-ubuntu-20.04 # Ubuntu 20.04 has GLIBC version 2.31 (2020) which we should verify to compile against - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - bazel test //rust:typedb_driver_unit_tests --test_output=streamed || exit 1 - tool/test/start-core-server.sh && - bazel test //rust/tests --test_output=streamed --test_arg=-- \ - --test_arg=integration::queries::core && - export CORE_FAILED= || export CORE_FAILED=1 - tool/test/stop-core-server.sh - if [[ -n "$CORE_FAILED" ]]; then exit 1; fi - - source tool/test/start-cloud-servers.sh 3 && # use source to receive export vars - bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ - --test_arg=integration::queries::cloud \ - --test_arg=integration::runtimes && - export CLOUD_FAILED= || export CLOUD_FAILED=1 - tool/test/stop-cloud-servers.sh - if [[ -n "$CLOUD_FAILED" ]]; then exit 1; fi - - test-rust-behaviour-minimal: - image: vaticle-ubuntu-20.04 # Ubuntu 20.04 has GLIBC version 2.31 (2020) which we should verify to compile against - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - source tool/test/start-cloud-servers.sh 3 && # use source to receive export vars - bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ - --test_arg=behaviour::concept && - bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ - --test_arg=behaviour::connection && - bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ - --test_arg=behaviour::driver && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-cloud-servers.sh - exit $TEST_SUCCESS - - test-rust-behaviour-query-read: - machine: 8-core-32-gb - image: vaticle-ubuntu-20.04 # Ubuntu 20.04 has GLIBC version 2.31 (2020) which we should verify to compile against - filter: - owner: vaticle - branch: [master, development] - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - source tool/test/start-cloud-servers.sh 3 && # use source to receive export vars - bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ - --test_arg=behaviour::query::language::match_ \ - --test_arg=behaviour::query::language::get \ - --test_arg=behaviour::query::language::fetch \ - --test_arg=behaviour::query::language::modifiers \ - --test_arg=behaviour::query::language::expression && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-cloud-servers.sh - exit $TEST_SUCCESS - - test-rust-behaviour-query-write: - machine: 8-core-32-gb - image: vaticle-ubuntu-20.04 # Ubuntu 20.04 has GLIBC version 2.31 (2020) which we should verify to compile against - filter: - owner: vaticle - branch: [master, development] - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - source tool/test/start-cloud-servers.sh 3 && # use source to receive export vars - bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ - --test_arg=behaviour::query::language::define \ - --test_arg=behaviour::query::language::undefine \ - --test_arg=behaviour::query::language::insert \ - --test_arg=behaviour::query::language::delete \ - --test_arg=behaviour::query::language::update \ - --test_arg=behaviour::query::language::rule_validation && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-cloud-servers.sh - exit $TEST_SUCCESS - - test-c-integration: - image: vaticle-ubuntu-20.04 # Ubuntu 20.04 has GLIBC version 2.31 (2020) which we should verify to compile against - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - tool/test/start-core-server.sh && - bazel test //c/tests/integration:test-driver --test_output=errors && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-core-server.sh - exit $TEST_SUCCESS - - test-java-integration: - image: vaticle-ubuntu-22.04 - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - bazel test //java/test/integration/... --test_output=errors - - test-java-behaviour-core: - image: vaticle-ubuntu-22.04 - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - .factory/test-core.sh //java/test/behaviour/connection/... --test_output=errors --jobs=1 - # TODO: delete --jobs=1 if we fix the issue with excess memory usage - .factory/test-core.sh //java/test/behaviour/concept/... --test_output=errors - .factory/test-core.sh //java/test/behaviour/driver/query/... --test_output=errors - .factory/test-core.sh //java/test/behaviour/query/language/... --test_output=errors --jobs=1 - - test-java-behaviour-cloud: - image: vaticle-ubuntu-22.04 - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - .factory/test-cloud.sh //java/test/behaviour/connection/... --test_output=errors --jobs=1 - # TODO: delete --jobs=1 if we fix the issue with excess memory usage - .factory/test-cloud.sh //java/test/behaviour/concept/... --test_output=errors - .factory/test-cloud.sh //java/test/behaviour/driver/query/... --test_output=errors - .factory/test-cloud.sh //java/test/behaviour/query/language/... --test_output=errors --jobs=1 - - test-python-behaviour-core: - image: vaticle-ubuntu-22.04 - dependencies: - - build - type: foreground - command: | - export PATH="$HOME/.local/bin:$PATH" - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - - tool/test/start-core-server.sh && - .factory/test-core.sh //python/tests/behaviour/connection/database/... --test_output=streamed --jobs=1 && - .factory/test-core.sh //python/tests/behaviour/connection/session/... --test_output=streamed --jobs=1 && - .factory/test-core.sh //python/tests/behaviour/connection/transaction/... --test_output=streamed --jobs=1 && - .factory/test-core.sh //python/tests/behaviour/concept/... --test_output=errors --jobs=1 && - .factory/test-core.sh //python/tests/behaviour/driver/query/... --test_output=errors && - .factory/test-core.sh //python/tests/behaviour/query/language/... --test_output=errors --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-core-server.sh - exit $TEST_SUCCESS - - test-python-behaviour-cloud: - image: vaticle-ubuntu-22.04 - dependencies: - - build - type: foreground - command: | - export PATH="$HOME/.local/bin:$PATH" - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - - source tool/test/start-cloud-servers.sh && # use source to receive export vars - .factory/test-cloud.sh //python/tests/behaviour/connection/database/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && - .factory/test-cloud.sh //python/tests/behaviour/connection/session/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && - .factory/test-cloud.sh //python/tests/behaviour/connection/transaction/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && - .factory/test-cloud.sh //python/tests/behaviour/connection/user/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && - .factory/test-cloud.sh //python/tests/behaviour/concept/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //python/tests/behaviour/driver/query/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors && - .factory/test-cloud.sh //python/tests/behaviour/query/language/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-cloud-servers.sh - exit $TEST_SUCCESS - - test-python-integration-core: - image: vaticle-ubuntu-22.04 - dependencies: - - build - type: foreground - command: | - export PATH="$HOME/.local/bin:$PATH" - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - - tool/test/start-core-server.sh && - bazel test //python/tests/integration:test_connection --test_output=streamed --jobs=1 && - bazel test //python/tests/integration:test_stream --test_output=streamed --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-core-server.sh - exit $TEST_SUCCESS +# test-rust-unit-integration: +# image: vaticle-ubuntu-20.04 # Ubuntu 20.04 has GLIBC version 2.31 (2020) which we should verify to compile against +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# bazel test //rust:typedb_driver_unit_tests --test_output=streamed || exit 1 +# tool/test/start-core-server.sh && +# bazel test //rust/tests --test_output=streamed --test_arg=-- \ +# --test_arg=integration::queries::core && +# export CORE_FAILED= || export CORE_FAILED=1 +# tool/test/stop-core-server.sh +# if [[ -n "$CORE_FAILED" ]]; then exit 1; fi +# +# source tool/test/start-cloud-servers.sh 3 && # use source to receive export vars +# bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ +# --test_arg=integration::queries::cloud \ +# --test_arg=integration::runtimes && +# export CLOUD_FAILED= || export CLOUD_FAILED=1 +# tool/test/stop-cloud-servers.sh +# if [[ -n "$CLOUD_FAILED" ]]; then exit 1; fi +# +# test-rust-behaviour-minimal: +# image: vaticle-ubuntu-20.04 # Ubuntu 20.04 has GLIBC version 2.31 (2020) which we should verify to compile against +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# source tool/test/start-cloud-servers.sh 3 && # use source to receive export vars +# bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ +# --test_arg=behaviour::concept && +# bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ +# --test_arg=behaviour::connection && +# bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ +# --test_arg=behaviour::driver && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-cloud-servers.sh +# exit $TEST_SUCCESS +# +# test-rust-behaviour-query-read: +# machine: 8-core-32-gb +# image: vaticle-ubuntu-20.04 # Ubuntu 20.04 has GLIBC version 2.31 (2020) which we should verify to compile against +# filter: +# owner: vaticle +# branch: [master, development] +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# source tool/test/start-cloud-servers.sh 3 && # use source to receive export vars +# bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ +# --test_arg=behaviour::query::language::match_ \ +# --test_arg=behaviour::query::language::get \ +# --test_arg=behaviour::query::language::fetch \ +# --test_arg=behaviour::query::language::modifiers \ +# --test_arg=behaviour::query::language::expression && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-cloud-servers.sh +# exit $TEST_SUCCESS +# +# test-rust-behaviour-query-write: +# machine: 8-core-32-gb +# image: vaticle-ubuntu-20.04 # Ubuntu 20.04 has GLIBC version 2.31 (2020) which we should verify to compile against +# filter: +# owner: vaticle +# branch: [master, development] +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# source tool/test/start-cloud-servers.sh 3 && # use source to receive export vars +# bazel test //rust/tests --test_output=streamed --test_env=ROOT_CA=$ROOT_CA --test_arg=-- \ +# --test_arg=behaviour::query::language::define \ +# --test_arg=behaviour::query::language::undefine \ +# --test_arg=behaviour::query::language::insert \ +# --test_arg=behaviour::query::language::delete \ +# --test_arg=behaviour::query::language::update \ +# --test_arg=behaviour::query::language::rule_validation && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-cloud-servers.sh +# exit $TEST_SUCCESS +# +# test-c-integration: +# image: vaticle-ubuntu-20.04 # Ubuntu 20.04 has GLIBC version 2.31 (2020) which we should verify to compile against +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# tool/test/start-core-server.sh && +# bazel test //c/tests/integration:test-driver --test_output=errors && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-core-server.sh +# exit $TEST_SUCCESS +# +# test-java-integration: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# bazel test //java/test/integration/... --test_output=errors +# +# test-java-behaviour-core: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# .factory/test-core.sh //java/test/behaviour/connection/... --test_output=errors --jobs=1 +# # TODO: delete --jobs=1 if we fix the issue with excess memory usage +# .factory/test-core.sh //java/test/behaviour/concept/... --test_output=errors +# .factory/test-core.sh //java/test/behaviour/driver/query/... --test_output=errors +# .factory/test-core.sh //java/test/behaviour/query/language/... --test_output=errors --jobs=1 +# +# test-java-behaviour-cloud: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# .factory/test-cloud.sh //java/test/behaviour/connection/... --test_output=errors --jobs=1 +# # TODO: delete --jobs=1 if we fix the issue with excess memory usage +# .factory/test-cloud.sh //java/test/behaviour/concept/... --test_output=errors +# .factory/test-cloud.sh //java/test/behaviour/driver/query/... --test_output=errors +# .factory/test-cloud.sh //java/test/behaviour/query/language/... --test_output=errors --jobs=1 +# +# test-python-behaviour-core: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# type: foreground +# command: | +# export PATH="$HOME/.local/bin:$PATH" +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# +# tool/test/start-core-server.sh && +# .factory/test-core.sh //python/tests/behaviour/connection/database/... --test_output=streamed --jobs=1 && +# .factory/test-core.sh //python/tests/behaviour/connection/session/... --test_output=streamed --jobs=1 && +# .factory/test-core.sh //python/tests/behaviour/connection/transaction/... --test_output=streamed --jobs=1 && +# .factory/test-core.sh //python/tests/behaviour/concept/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //python/tests/behaviour/driver/query/... --test_output=errors && +# .factory/test-core.sh //python/tests/behaviour/query/language/... --test_output=errors --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-core-server.sh +# exit $TEST_SUCCESS +# +# test-python-behaviour-cloud: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# type: foreground +# command: | +# export PATH="$HOME/.local/bin:$PATH" +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# +# source tool/test/start-cloud-servers.sh && # use source to receive export vars +# .factory/test-cloud.sh //python/tests/behaviour/connection/database/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && +# .factory/test-cloud.sh //python/tests/behaviour/connection/session/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && +# .factory/test-cloud.sh //python/tests/behaviour/connection/transaction/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && +# .factory/test-cloud.sh //python/tests/behaviour/connection/user/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && +# .factory/test-cloud.sh //python/tests/behaviour/concept/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //python/tests/behaviour/driver/query/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors && +# .factory/test-cloud.sh //python/tests/behaviour/query/language/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-cloud-servers.sh +# exit $TEST_SUCCESS +# +# test-python-integration-core: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# type: foreground +# command: | +# export PATH="$HOME/.local/bin:$PATH" +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# +# tool/test/start-core-server.sh && +# bazel test //python/tests/integration:test_connection --test_output=streamed --jobs=1 && +# bazel test //python/tests/integration:test_stream --test_output=streamed --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-core-server.sh +# exit $TEST_SUCCESS # test-python-integration-cloud-failover: # machine: 4-core-16-gb @@ -309,207 +309,207 @@ build: # bazel run @vaticle_dependencies//distribution/artifact:create-netrc # bazel test //python/tests/integration:test_cloud_failover --test_output=errors - test-nodejs-integration: - image: vaticle-ubuntu-22.04 - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - bazel build //nodejs/... - cp -rL bazel-bin/nodejs/node_modules nodejs/. - cp -rL bazel-bin/nodejs/dist nodejs/. - tool/test/start-core-server.sh && - node nodejs/test/integration/test-concept.js && - node nodejs/test/integration/test-connection.js && - node nodejs/test/integration/test-query.js && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-core-server.sh - exit $TEST_SUCCESS - - test-nodejs-cloud-failover: - machine: 4-core-16-gb - image: vaticle-ubuntu-22.04 - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - bazel build //nodejs/... - cp -rL bazel-bin/nodejs/node_modules nodejs/. - cp -rL bazel-bin/nodejs/dist nodejs/. - source tool/test/start-cloud-servers.sh 3 && # use source to receive export vars - node nodejs/test/integration/test-cloud-failover.js && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-cloud-servers.sh - exit $TEST_SUCCESS - - test-nodejs-behaviour-core: - image: vaticle-ubuntu-22.04 - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - tool/test/start-core-server.sh && - .factory/test-core.sh //nodejs/test/behaviour/connection/database/... --test_output=errors --jobs=1 && - .factory/test-core.sh //nodejs/test/behaviour/connection/session/... --test_output=errors --jobs=1 && - .factory/test-core.sh //nodejs/test/behaviour/connection/transaction/... --test_output=errors --jobs=1 && - .factory/test-core.sh //nodejs/test/behaviour/concept/... --test_output=errors --jobs=1 && - .factory/test-core.sh //nodejs/test/behaviour/driver/query/... --test_output=errors --jobs=1 && - .factory/test-core.sh //nodejs/test/behaviour/query/language/... --test_output=errors --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-core-server.sh - exit $TEST_SUCCESS - - test-nodejs-behaviour-cloud: - image: vaticle-ubuntu-22.04 - dependencies: - - build - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - source tool/test/start-cloud-servers.sh && # use source to receive export vars - .factory/test-cloud.sh //nodejs/test/behaviour/connection/database/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //nodejs/test/behaviour/connection/session/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //nodejs/test/behaviour/connection/transaction/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //nodejs/test/behaviour/connection/user/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //nodejs/test/behaviour/concept/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //nodejs/test/behaviour/driver/query/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //nodejs/test/behaviour/query/language/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-cloud-servers.sh - exit $TEST_SUCCESS - - test-cpp-integration-core: - image: vaticle-ubuntu-22.04 - dependencies: - - build - type: foreground - command: | - sudo apt-get update - sudo apt install clang-format-15 -y && sudo ln -s $(which clang-format-15) /usr/bin/clang-format - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - tool/test/start-core-server.sh && - bazel test //cpp/test/integration/... --test_output=streamed --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-core-server.sh - exit $TEST_SUCCESS - - test-cpp-behaviour-core: - image: vaticle-ubuntu-22.04 - dependencies: - - build - type: foreground - command: | - sudo apt-get update - sudo apt install clang-format-15 -y && sudo ln -s $(which clang-format-15) /usr/bin/clang-format - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - tool/test/start-core-server.sh && - .factory/test-core.sh //cpp/test/behaviour/connection/database/... --test_output=streamed --jobs=1 && - .factory/test-core.sh //cpp/test/behaviour/connection/session/... --test_output=streamed --jobs=1 && - .factory/test-core.sh //cpp/test/behaviour/connection/transaction/... --test_output=streamed --jobs=1 && - .factory/test-core.sh //cpp/test/behaviour/concept/... --test_output=errors --jobs=1 && - .factory/test-core.sh //cpp/test/behaviour/driver/query/... --test_output=errors && - .factory/test-core.sh //cpp/test/behaviour/query/language/... --test_output=errors --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-core-server.sh - exit $TEST_SUCCESS - - test-cpp-behaviour-cloud: - image: vaticle-ubuntu-22.04 - dependencies: - - build - type: foreground - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - source tool/test/start-cloud-servers.sh && - .factory/test-cloud.sh //cpp/test/behaviour/connection/database/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && - .factory/test-cloud.sh //cpp/test/behaviour/connection/session/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && - .factory/test-cloud.sh //cpp/test/behaviour/connection/transaction/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && - .factory/test-cloud.sh //cpp/test/behaviour/connection/user/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && - .factory/test-cloud.sh //cpp/test/behaviour/concept/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //cpp/test/behaviour/driver/query/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors && - .factory/test-cloud.sh //cpp/test/behaviour/query/language/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-cloud-servers.sh - exit $TEST_SUCCESS - - test-csharp-integration-core: - image: vaticle-ubuntu-22.04 - dependencies: - - build - type: foreground - command: | - sudo apt-get update - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - tool/test/start-core-server.sh && - bazel test //csharp/Test/Integration/... --test_output=streamed --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-core-server.sh - exit $TEST_SUCCESS - - test-csharp-behaviour-core: - image: vaticle-ubuntu-22.04 - dependencies: - - build - type: foreground - command: | - sudo apt-get update - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - tool/test/start-core-server.sh && - .factory/test-core.sh //csharp/Test/Behaviour/Connection/Database/... --test_output=errors --jobs=1 && - .factory/test-core.sh //csharp/Test/Behaviour/Connection/Session/... --test_output=errors --jobs=1 && - .factory/test-core.sh //csharp/Test/Behaviour/Connection/Transaction/... --test_output=errors --jobs=1 && - .factory/test-core.sh //csharp/Test/Behaviour/Concept/... --test_output=errors --jobs=1 && - .factory/test-core.sh //csharp/Test/Behaviour/Driver/Query/... --test_output=errors && - .factory/test-core.sh //csharp/Test/Behaviour/Query/Language/... --test_output=errors --jobs=1 && - .factory/test-core.sh //csharp/Test/Behaviour/Query/Reasoner/... --test_output=errors --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-core-server.sh - exit $TEST_SUCCESS - - test-csharp-behaviour-cloud: - image: vaticle-ubuntu-22.04 - dependencies: - - build - type: foreground - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - source tool/test/start-cloud-servers.sh && - .factory/test-cloud.sh //csharp/Test/Behaviour/Connection/Database/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //csharp/Test/Behaviour/Connection/Session/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //csharp/Test/Behaviour/Connection/Transaction/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //csharp/Test/Behaviour/Connection/User/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //csharp/Test/Behaviour/Concept/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //csharp/Test/Behaviour/Driver/Query/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors && - .factory/test-cloud.sh //csharp/Test/Behaviour/Query/Language/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - .factory/test-cloud.sh //csharp/Test/Behaviour/Query/Reasoner/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-cloud-servers.sh - exit $TEST_SUCCESS +# test-nodejs-integration: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# bazel build //nodejs/... +# cp -rL bazel-bin/nodejs/node_modules nodejs/. +# cp -rL bazel-bin/nodejs/dist nodejs/. +# tool/test/start-core-server.sh && +# node nodejs/test/integration/test-concept.js && +# node nodejs/test/integration/test-connection.js && +# node nodejs/test/integration/test-query.js && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-core-server.sh +# exit $TEST_SUCCESS +# +# test-nodejs-cloud-failover: +# machine: 4-core-16-gb +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# bazel build //nodejs/... +# cp -rL bazel-bin/nodejs/node_modules nodejs/. +# cp -rL bazel-bin/nodejs/dist nodejs/. +# source tool/test/start-cloud-servers.sh 3 && # use source to receive export vars +# node nodejs/test/integration/test-cloud-failover.js && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-cloud-servers.sh +# exit $TEST_SUCCESS +# +# test-nodejs-behaviour-core: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# tool/test/start-core-server.sh && +# .factory/test-core.sh //nodejs/test/behaviour/connection/database/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //nodejs/test/behaviour/connection/session/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //nodejs/test/behaviour/connection/transaction/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //nodejs/test/behaviour/concept/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //nodejs/test/behaviour/driver/query/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //nodejs/test/behaviour/query/language/... --test_output=errors --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-core-server.sh +# exit $TEST_SUCCESS +# +# test-nodejs-behaviour-cloud: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# source tool/test/start-cloud-servers.sh && # use source to receive export vars +# .factory/test-cloud.sh //nodejs/test/behaviour/connection/database/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //nodejs/test/behaviour/connection/session/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //nodejs/test/behaviour/connection/transaction/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //nodejs/test/behaviour/connection/user/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //nodejs/test/behaviour/concept/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //nodejs/test/behaviour/driver/query/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //nodejs/test/behaviour/query/language/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-cloud-servers.sh +# exit $TEST_SUCCESS +# +# test-cpp-integration-core: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# type: foreground +# command: | +# sudo apt-get update +# sudo apt install clang-format-15 -y && sudo ln -s $(which clang-format-15) /usr/bin/clang-format +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# tool/test/start-core-server.sh && +# bazel test //cpp/test/integration/... --test_output=streamed --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-core-server.sh +# exit $TEST_SUCCESS +# +# test-cpp-behaviour-core: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# type: foreground +# command: | +# sudo apt-get update +# sudo apt install clang-format-15 -y && sudo ln -s $(which clang-format-15) /usr/bin/clang-format +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# tool/test/start-core-server.sh && +# .factory/test-core.sh //cpp/test/behaviour/connection/database/... --test_output=streamed --jobs=1 && +# .factory/test-core.sh //cpp/test/behaviour/connection/session/... --test_output=streamed --jobs=1 && +# .factory/test-core.sh //cpp/test/behaviour/connection/transaction/... --test_output=streamed --jobs=1 && +# .factory/test-core.sh //cpp/test/behaviour/concept/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //cpp/test/behaviour/driver/query/... --test_output=errors && +# .factory/test-core.sh //cpp/test/behaviour/query/language/... --test_output=errors --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-core-server.sh +# exit $TEST_SUCCESS +# +# test-cpp-behaviour-cloud: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# type: foreground +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# source tool/test/start-cloud-servers.sh && +# .factory/test-cloud.sh //cpp/test/behaviour/connection/database/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && +# .factory/test-cloud.sh //cpp/test/behaviour/connection/session/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && +# .factory/test-cloud.sh //cpp/test/behaviour/connection/transaction/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && +# .factory/test-cloud.sh //cpp/test/behaviour/connection/user/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && +# .factory/test-cloud.sh //cpp/test/behaviour/concept/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //cpp/test/behaviour/driver/query/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors && +# .factory/test-cloud.sh //cpp/test/behaviour/query/language/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-cloud-servers.sh +# exit $TEST_SUCCESS +# +# test-csharp-integration-core: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# type: foreground +# command: | +# sudo apt-get update +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# tool/test/start-core-server.sh && +# bazel test //csharp/Test/Integration/... --test_output=streamed --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-core-server.sh +# exit $TEST_SUCCESS +# +# test-csharp-behaviour-core: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# type: foreground +# command: | +# sudo apt-get update +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# tool/test/start-core-server.sh && +# .factory/test-core.sh //csharp/Test/Behaviour/Connection/Database/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //csharp/Test/Behaviour/Connection/Session/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //csharp/Test/Behaviour/Connection/Transaction/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //csharp/Test/Behaviour/Concept/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //csharp/Test/Behaviour/Driver/Query/... --test_output=errors && +# .factory/test-core.sh //csharp/Test/Behaviour/Query/Language/... --test_output=errors --jobs=1 && +# .factory/test-core.sh //csharp/Test/Behaviour/Query/Reasoner/... --test_output=errors --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-core-server.sh +# exit $TEST_SUCCESS +# +# test-csharp-behaviour-cloud: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# type: foreground +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# source tool/test/start-cloud-servers.sh && +# .factory/test-cloud.sh //csharp/Test/Behaviour/Connection/Database/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //csharp/Test/Behaviour/Connection/Session/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //csharp/Test/Behaviour/Connection/Transaction/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //csharp/Test/Behaviour/Connection/User/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //csharp/Test/Behaviour/Concept/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //csharp/Test/Behaviour/Driver/Query/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors && +# .factory/test-cloud.sh //csharp/Test/Behaviour/Query/Language/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# .factory/test-cloud.sh //csharp/Test/Behaviour/Query/Reasoner/... --test_env=ROOT_CA=$ROOT_CA --test_output=errors --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-cloud-servers.sh +# exit $TEST_SUCCESS sync-dependencies: image: vaticle-ubuntu-22.04 diff --git a/dependencies/vaticle/repositories.bzl b/dependencies/vaticle/repositories.bzl index c21a255c0a..9e2fde1dc1 100644 --- a/dependencies/vaticle/repositories.bzl +++ b/dependencies/vaticle/repositories.bzl @@ -21,7 +21,7 @@ def vaticle_dependencies(): git_repository( name = "vaticle_dependencies", remote = "https://github.com/vaticle/dependencies", - commit = "d4f15f19dc330a1e3f80438b9a21486462ed106b", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies + commit = "215564b3d6d97788407930f332fa6da336799ac1", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies ) def vaticle_typeql(): From 73bb7918a19ef71372fc7294c93a7b6a7bb0ffd9 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 19 Mar 2024 09:39:39 +0000 Subject: [PATCH 002/118] Add csharp tests to automation. Update maven artifacts --- .factory/automation.yml | 74 ++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/.factory/automation.yml b/.factory/automation.yml index 31b9addc19..a9a8fc91f5 100644 --- a/.factory/automation.yml +++ b/.factory/automation.yml @@ -510,43 +510,43 @@ build: # export TEST_SUCCESS=0 || export TEST_SUCCESS=1 # tool/test/stop-cloud-servers.sh # exit $TEST_SUCCESS - - sync-dependencies: - image: vaticle-ubuntu-22.04 - filter: - owner: vaticle - branch: [master, development] - dependencies: - - build - - build-dependency - - build-docs - - test-rust-unit-integration - - test-rust-behaviour-minimal - - test-rust-behaviour-query-read - - test-rust-behaviour-query-write - - test-c-integration - - test-java-integration - - test-java-behaviour-core - - test-java-behaviour-cloud - - test-python-behaviour-core - - test-python-behaviour-cloud - - test-python-integration-core - - test-nodejs-integration - - test-nodejs-cloud-failover - - test-nodejs-behaviour-core - - test-nodejs-behaviour-cloud - - test-cpp-integration-core - - test-cpp-behaviour-core - - test-cpp-behaviour-cloud - - test-csharp-integration-core - - test-csharp-behaviour-core - - test-csharp-behaviour-cloud - command: | - sudo add-apt-repository -y ppa:deadsnakes/ppa - sudo apt update && sudo apt install -y python3.9 python3.9-distutils python3-pip - python3.9 -m pip install -U cffi - export SYNC_DEPENDENCIES_TOKEN=$REPO_GITHUB_TOKEN - bazel run @vaticle_dependencies//tool/sync:dependencies -- --source ${FACTORY_REPO}@${FACTORY_COMMIT} +# +# sync-dependencies: +# image: vaticle-ubuntu-22.04 +# filter: +# owner: vaticle +# branch: [master, development] +# dependencies: +# - build +# - build-dependency +# - build-docs +# - test-rust-unit-integration +# - test-rust-behaviour-minimal +# - test-rust-behaviour-query-read +# - test-rust-behaviour-query-write +# - test-c-integration +# - test-java-integration +# - test-java-behaviour-core +# - test-java-behaviour-cloud +# - test-python-behaviour-core +# - test-python-behaviour-cloud +# - test-python-integration-core +# - test-nodejs-integration +# - test-nodejs-cloud-failover +# - test-nodejs-behaviour-core +# - test-nodejs-behaviour-cloud +# - test-cpp-integration-core +# - test-cpp-behaviour-core +# - test-cpp-behaviour-cloud +# - test-csharp-integration-core +# - test-csharp-behaviour-core +# - test-csharp-behaviour-cloud +# command: | +# sudo add-apt-repository -y ppa:deadsnakes/ppa +# sudo apt update && sudo apt install -y python3.9 python3.9-distutils python3-pip +# python3.9 -m pip install -U cffi +# export SYNC_DEPENDENCIES_TOKEN=$REPO_GITHUB_TOKEN +# bazel run @vaticle_dependencies//tool/sync:dependencies -- --source ${FACTORY_REPO}@${FACTORY_COMMIT} # TODO: assembly tests for all drivers to run in factory From 07194f011d3469a16c13934d14a3fa72d5ad638b Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 21 Mar 2024 16:45:44 +0000 Subject: [PATCH 003/118] Refactor error messages codes. Update deps --- .factory/automation.yml | 20 +------------------- cpp/lib/common/error_message.cpp | 12 ++++++++++++ java/common/exception/ErrorMessage.java | 8 ++++++-- python/typedb/common/exception.py | 2 +- 4 files changed, 20 insertions(+), 22 deletions(-) diff --git a/.factory/automation.yml b/.factory/automation.yml index a9a8fc91f5..ab09b243ac 100644 --- a/.factory/automation.yml +++ b/.factory/automation.yml @@ -290,25 +290,7 @@ build: # export TEST_SUCCESS=0 || export TEST_SUCCESS=1 # tool/test/stop-core-server.sh # exit $TEST_SUCCESS - -# test-python-integration-cloud-failover: -# machine: 4-core-16-gb -# image: vaticle-ubuntu-22.04 -# dependencies: -# - build -# type: foreground -# command: | -# export PATH="$HOME/.local/bin:$PATH" -# sudo apt-get update -# sudo apt install python3-pip -y -# python3 -m pip install -U pip -# python3 -m pip install -r python/requirements_dev.txt -# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME -# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD -# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh -# bazel run @vaticle_dependencies//distribution/artifact:create-netrc -# bazel test //python/tests/integration:test_cloud_failover --test_output=errors - +# # test-nodejs-integration: # image: vaticle-ubuntu-22.04 # dependencies: diff --git a/cpp/lib/common/error_message.cpp b/cpp/lib/common/error_message.cpp index c40952b5e6..b12e777587 100644 --- a/cpp/lib/common/error_message.cpp +++ b/cpp/lib/common/error_message.cpp @@ -30,7 +30,11 @@ namespace TypeDB { namespace DriverError { +<<<<<<< HEAD #define ERR_DRIVER(ID, MSG) ERRMSG("CCDR", "Driver Error", ID, MSG) +======= +#define ERR_DRIVER(ID, MSG) ERRMSG("DRI", "Driver Error", ID, MSG) +>>>>>>> 08a62756 (Refactor error messages codes. Update deps) DECLSPEC_DLL extern const ErrorMessage DRIVER_CLOSED = ERR_DRIVER(1, "The driver has been closed and no further operation is allowed."); DECLSPEC_DLL extern const ErrorMessage SESSION_CLOSED = ERR_DRIVER(2, "The session has been closed and no further operation is allowed."); DECLSPEC_DLL extern const ErrorMessage TRANSACTION_CLOSED = ERR_DRIVER(3, "The transaction has been closed and no further operation is allowed."); @@ -46,7 +50,11 @@ DECLSPEC_DLL extern const ErrorMessage CALLBACK_EXCEPTION = ERR_DRIVER(9, "An ex namespace ConceptError { +<<<<<<< HEAD #define ERR_CONCEPT(ID, MSG) ERRMSG("CCCO", "Concept Error", ID, MSG) +======= +#define ERR_CONCEPT(ID, MSG) ERRMSG("CON", "Concept Error", ID, MSG) +>>>>>>> 08a62756 (Refactor error messages codes. Update deps) DECLSPEC_DLL extern const ErrorMessage INVALID_CONCEPT_CASTING = ERR_CONCEPT(1, "Invalid concept conversion from '%s' to '%s'."); DECLSPEC_DLL extern const ErrorMessage MISSING_TRANSACTION = ERR_CONCEPT(2, "Transaction cannot be null."); DECLSPEC_DLL extern const ErrorMessage MISSING_IID = ERR_CONCEPT(3, "IID cannot be null or empty."); @@ -62,7 +70,11 @@ DECLSPEC_DLL extern const ErrorMessage UNRECOGNISED_ANNOTATION = ERR_CONCEPT(9, namespace QueryError { +<<<<<<< HEAD #define ERR_QUERY(ID, MSG) ERRMSG("CCQR", "Query Error", ID, MSG) +======= +#define ERR_QUERY(ID, MSG) ERRMSG("QRY", "Query Error", ID, MSG) +>>>>>>> 08a62756 (Refactor error messages codes. Update deps) DECLSPEC_DLL extern const ErrorMessage VARIABLE_DOES_NOT_EXIST = ERR_QUERY(1, "The variable '%s' does not exist."); DECLSPEC_DLL extern const ErrorMessage MISSING_QUERY = ERR_QUERY(2, "Query cannot be null or empty."); #undef ERR_QUERY diff --git a/java/common/exception/ErrorMessage.java b/java/common/exception/ErrorMessage.java index 91176cd898..88f60a120f 100644 --- a/java/common/exception/ErrorMessage.java +++ b/java/common/exception/ErrorMessage.java @@ -79,7 +79,7 @@ public static class Concept extends ErrorMessage { public static final Concept UNRECOGNISED_ANNOTATION = new Concept(9, "The annotation '%s' is not recognised."); - private static final String codePrefix = "JCO"; + private static final String codePrefix = "CON"; private static final String messagePrefix = "Concept Error"; Concept(int number, String message) { @@ -93,7 +93,11 @@ public static class Query extends ErrorMessage { public static final Query MISSING_QUERY = new Query(2, "Query cannot be null or empty."); +<<<<<<< HEAD private static final String codePrefix = "JQR"; +======= + private static final String codePrefix = "QRY"; +>>>>>>> 08a62756 (Refactor error messages codes. Update deps) private static final String messagePrefix = "Query Error"; Query(int number, String message) { @@ -111,7 +115,7 @@ public static class Internal extends ErrorMessage { public static final Internal NULL_NATIVE_VALUE = new Internal(4, "Unhandled null pointer to a native object encountered!"); - private static final String codePrefix = "JIN"; + private static final String codePrefix = "INT"; private static final String messagePrefix = "Java Internal Error"; Internal(int number, String message) { diff --git a/python/typedb/common/exception.py b/python/typedb/common/exception.py index dab23170ec..ca1a92e702 100644 --- a/python/typedb/common/exception.py +++ b/python/typedb/common/exception.py @@ -138,7 +138,7 @@ class InternalErrorMessage(ErrorMessage): """ def __init__(self, code: int, message: str): - super(InternalErrorMessage, self).__init__(code_prefix="PIN", code_number=code, + super(InternalErrorMessage, self).__init__(code_prefix="INT", code_number=code, message_prefix="Python Internal Error", message_body=message) From 70d3c11f37d3d4f8d50856b541658ee25dc4bf6a Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Fri, 15 Mar 2024 17:58:01 +0000 Subject: [PATCH 004/118] Start the quickstart test, several experiments. Wip --- .../{Connection => Quickstart}/BUILD | 2 +- .../QuickstartTest.cs} | 58 +++++++++++++++++++ 2 files changed, 59 insertions(+), 1 deletion(-) rename csharp/Test/Integration/{Connection => Quickstart}/BUILD (97%) rename csharp/Test/Integration/{Connection/ConnectionTest.cs => Quickstart/QuickstartTest.cs} (69%) diff --git a/csharp/Test/Integration/Connection/BUILD b/csharp/Test/Integration/Quickstart/BUILD similarity index 97% rename from csharp/Test/Integration/Connection/BUILD rename to csharp/Test/Integration/Quickstart/BUILD index 6d341614a8..64db0bb039 100644 --- a/csharp/Test/Integration/Connection/BUILD +++ b/csharp/Test/Integration/Quickstart/BUILD @@ -22,7 +22,7 @@ load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") csharp_integration_test( name = "test", - srcs = ["ConnectionTest.cs"], + srcs = ["QuickstartTest.cs"], deps = [ "//csharp:driver-csharp", "//csharp/Api:api", diff --git a/csharp/Test/Integration/Connection/ConnectionTest.cs b/csharp/Test/Integration/Quickstart/QuickstartTest.cs similarity index 69% rename from csharp/Test/Integration/Connection/ConnectionTest.cs rename to csharp/Test/Integration/Quickstart/QuickstartTest.cs index 5be4cc32f8..ee237bed0a 100644 --- a/csharp/Test/Integration/Connection/ConnectionTest.cs +++ b/csharp/Test/Integration/Quickstart/QuickstartTest.cs @@ -20,6 +20,7 @@ using NUnit.Framework; using System; using System.Collections.Generic; +using System.Linq; using TypeDB.Driver; using TypeDB.Driver.Api; @@ -91,6 +92,63 @@ public static void CheckAllDatabases(IDatabaseManager dbManager, ICollection Date: Mon, 18 Mar 2024 09:33:42 +0000 Subject: [PATCH 005/118] Progress on the quickstart test --- .../Integration/Quickstart/QuickstartTest.cs | 32 ++++++++++++++----- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/csharp/Test/Integration/Quickstart/QuickstartTest.cs b/csharp/Test/Integration/Quickstart/QuickstartTest.cs index ee237bed0a..8ede066ea1 100644 --- a/csharp/Test/Integration/Quickstart/QuickstartTest.cs +++ b/csharp/Test/Integration/Quickstart/QuickstartTest.cs @@ -100,6 +100,25 @@ public ConnectionTestFixture() if (db != null) db.Delete();} catch(TypeDBDriverException e) { Console.WriteLine(e); } } + private void ProcessPersonInsertResult(IConceptMap[] results, string variableName) + { + Assert.AreEqual(1, results.Length); + + var result = results[0]; + var variable = result.Get(variableName); + + Assert.IsNotNull(variable); + Assert.IsTrue(variable.IsEntity()); + Assert.AreEqual(2, result.Variables.Count()); + Assert.AreEqual(2, result.Concepts.Count()); + + var attribute = result.Get("_0"); + Assert.IsNotNull(attribute); + Assert.IsTrue(variable.AsAttribute().IsAttribute()); // Reenable and check the fail!! + Console.WriteLine($"Attr: {attribute}"); +// Assert.AreEqual("") + } + [Test] public void Test() { @@ -110,6 +129,7 @@ public void Test() IDatabase mydb = driver.Databases.Get(dbName); System.Console.WriteLine(mydb.Name); + // Example with "using" using (ITypeDBSession schemaSession = driver.Session(dbName, SessionType.SCHEMA)) { using (ITypeDBTransaction writeTransaction = schemaSession.Transaction(TransactionType.WRITE)) @@ -123,15 +143,14 @@ public void Test() } } + // Example with manual sessions and transactions management + ITypeDBSession dataSession = driver.Session(dbName, SessionType.DATA); ITypeDBTransaction dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE); string query = "insert $p isa person, has name 'Alice';"; var results = dataWriteTransaction.Query.Insert(query).ToArray(); - foreach (var result in results) - { - Console.WriteLine(result); - } + ProcessPersonInsertResult(results, "p"); dataWriteTransaction.Close(); dataSession.Close(); @@ -140,10 +159,7 @@ public void Test() dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE); var results2 = dataWriteTransaction.Query.Insert("insert $p isa person, has name 'Bob';").ToArray(); - foreach (var result in results2) - { - Console.WriteLine(result); - } + ProcessPersonInsertResult(results2, "p"); mydb.Delete(); From e9c9462a8da7bc741da6fa6d75a6b39f580f63e7 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 18 Mar 2024 11:36:03 +0000 Subject: [PATCH 006/118] Complete two versions of the quickstart test, gonna refactor later --- .../Integration/Quickstart/QuickstartTest.cs | 234 ++++++++++++------ 1 file changed, 152 insertions(+), 82 deletions(-) diff --git a/csharp/Test/Integration/Quickstart/QuickstartTest.cs b/csharp/Test/Integration/Quickstart/QuickstartTest.cs index 8ede066ea1..a18f35c645 100644 --- a/csharp/Test/Integration/Quickstart/QuickstartTest.cs +++ b/csharp/Test/Integration/Quickstart/QuickstartTest.cs @@ -96,126 +96,196 @@ public ConnectionTestFixture() { ITypeDBDriver driver = TypeDB.CoreDriver(TypeDB.DEFAULT_ADDRESS); - try {var db = driver.Databases.Get("mydb"); + try {var db = driver.Databases.Get("access-management-db"); if (db != null) db.Delete();} catch(TypeDBDriverException e) { Console.WriteLine(e); } } - private void ProcessPersonInsertResult(IConceptMap[] results, string variableName) + private void ProcessPersonInsertResult( + IConceptMap[] results, + string variableName, + string expectedVariableTypeLabel, + string expectedAttributeValue) { Assert.AreEqual(1, results.Length); var result = results[0]; - var variable = result.Get(variableName); - - Assert.IsNotNull(variable); - Assert.IsTrue(variable.IsEntity()); Assert.AreEqual(2, result.Variables.Count()); Assert.AreEqual(2, result.Concepts.Count()); + var entity = result.Get(variableName); + Assert.IsNotNull(entity); + Assert.IsTrue(entity.IsEntity()); + + var entityType = entity.AsEntity().Type; + Assert.IsNotNull(entityType); + Assert.IsTrue(entityType.IsType() && entityType.IsEntityType()); + Assert.AreEqual(expectedVariableTypeLabel, entityType.Label.ToString()); + var attribute = result.Get("_0"); Assert.IsNotNull(attribute); - Assert.IsTrue(variable.AsAttribute().IsAttribute()); // Reenable and check the fail!! - Console.WriteLine($"Attr: {attribute}"); -// Assert.AreEqual("") + Assert.IsTrue(attribute.IsAttribute()); + + var attributeValue = attribute.AsAttribute().Value; + Assert.IsNotNull(attributeValue); + Assert.IsTrue(attributeValue.IsString()); + Assert.AreEqual(expectedAttributeValue, attributeValue.AsString()); } - [Test] - public void Test() + private void ProcessPersonMatchResult( + IEnumerable results, + string variableName, + string expectedAttributeValue, + string expectedVariableTypeLabel) { - ITypeDBDriver driver = TypeDB.CoreDriver(TypeDB.DEFAULT_ADDRESS); - - string dbName = "mydb"; - driver.Databases.Create(dbName); - IDatabase mydb = driver.Databases.Get(dbName); - System.Console.WriteLine(mydb.Name); - - // Example with "using" - using (ITypeDBSession schemaSession = driver.Session(dbName, SessionType.SCHEMA)) - { - using (ITypeDBTransaction writeTransaction = schemaSession.Transaction(TransactionType.WRITE)) - { - writeTransaction.Query.Define("define person sub entity;").Resolve(); // Can throw exceptions, so could be wrapped in try-catch! + var collectedResults = results.ToArray(); + Assert.AreEqual(1, collectedResults.Length); // Only one insert has been committed - string longQuery = "define name sub attribute, value string; person owns name;"; - writeTransaction.Query.Define(longQuery).Resolve(); + var result = collectedResults[0]; - writeTransaction.Commit(); - } - } - - // Example with manual sessions and transactions management - - ITypeDBSession dataSession = driver.Session(dbName, SessionType.DATA); - ITypeDBTransaction dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE); - - string query = "insert $p isa person, has name 'Alice';"; - var results = dataWriteTransaction.Query.Insert(query).ToArray(); - ProcessPersonInsertResult(results, "p"); - - dataWriteTransaction.Close(); - dataSession.Close(); - - dataSession = driver.Session(dbName, SessionType.DATA); - dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE); - - var results2 = dataWriteTransaction.Query.Insert("insert $p isa person, has name 'Bob';").ToArray(); - ProcessPersonInsertResult(results2, "p"); + var attribute = result.Get(variableName); + Assert.IsNotNull(attribute); + Assert.IsTrue(attribute.IsAttribute()); + var attributeValue = attribute.AsAttribute().Value; + Assert.IsNotNull(attributeValue); + Assert.IsTrue(attributeValue.IsString()); + Assert.AreEqual(expectedAttributeValue, attributeValue.AsString()); - mydb.Delete(); + var attributeType = attribute.AsAttribute().Type; + Assert.IsNotNull(attributeType); + Assert.IsTrue(attributeType.IsType() && attributeType.IsAttributeType()); + Assert.AreEqual(expectedVariableTypeLabel, attributeType.Label.ToString()); } [Test] - public void OpenAndCloseConnection() + public void Usings() { - ITypeDBDriver driver = Utils.OpenConnection(); - Utils.CloseConnection(driver); - } + string dbName = "access-management-db"; + string serverAddr = "127.0.0.1:1729"; + try + { + using (ITypeDBDriver driver = TypeDB.CoreDriver(serverAddr)) + { + driver.Databases.Create(dbName); + IDatabase database = driver.Databases.Get(dbName); + + // Example of one transaction for one session + using (ITypeDBSession schemaSession = driver.Session(dbName, SessionType.SCHEMA)) + { + // Example of multiple queries for one transaction + using (ITypeDBTransaction writeTransaction = schemaSession.Transaction(TransactionType.WRITE)) + { + writeTransaction.Query.Define("define person sub entity;").Resolve(); + + string longQuery = "define name sub attribute, value string; person owns name;"; + writeTransaction.Query.Define(longQuery).Resolve(); + + writeTransaction.Commit(); + } + } + + // Example of multiple transactions for one session + using (ITypeDBSession dataSession = driver.Session(dbName, SessionType.DATA)) + { + // Examples of one query for one transaction + using (ITypeDBTransaction dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE)) + { + string query = "insert $p isa person, has name 'Alice';"; + IConceptMap[] insertResults = dataWriteTransaction.Query.Insert(query).ToArray(); + ProcessPersonInsertResult(insertResults, "p", "person", "Alice"); + + dataWriteTransaction.Commit(); + } + + using (ITypeDBTransaction dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE)) + { + IConceptMap[] insertResults = + dataWriteTransaction.Query.Insert("insert $p isa person, has name 'Bob';").ToArray(); + ProcessPersonInsertResult(insertResults, "p", "person", "Bob"); + + // Not committed + } + + using (ITypeDBTransaction dataReadTransaction = dataSession.Transaction(TransactionType.READ)) + { + IEnumerable matchResults = + dataReadTransaction.Query.Get("match $p isa person, has name $n; get $n;"); + + // Matches only Alice as Bob has not been committed + ProcessPersonMatchResult(matchResults, "n", "Alice", "name"); + } + } + + database.Delete(); + } + } + catch (TypeDBDriverException e) + { + Console.WriteLine($"Caught TypeDB Driver Exception: {e}"); + // ... + } + } + [Test] - public void CreateAndDeleteAndRecreateDatabase() + public void Manual() { - string expectedDbName = "hello_from_csharp"; + string dbName = "access-management-db"; + string serverAddr = "127.0.0.1:1729"; - ITypeDBDriver driver = Utils.OpenConnection(); - IDatabaseManager dbManager = driver.Databases; + try + { + ITypeDBDriver driver = TypeDB.CoreDriver(serverAddr); + driver.Databases.Create(dbName); - Assert.Throws(() => dbManager.Contains("")); - Utils.CheckAllDatabases(dbManager, new HashSet()); + IDatabase database = driver.Databases.Get(dbName); - IDatabase db1 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); + ITypeDBSession schemaSession = driver.Session(dbName, SessionType.SCHEMA); + ITypeDBTransaction writeTransaction = schemaSession.Transaction(TransactionType.WRITE); - Utils.CheckAllDatabases(dbManager, new HashSet(){expectedDbName}); - Assert.False(dbManager.Contains(expectedDbName + "1")); - Assert.False(dbManager.Contains(expectedDbName.Substring(1))); - Assert.False(dbManager.Contains(expectedDbName.Remove(expectedDbName.Length - 1))); - Assert.Throws(() => dbManager.Contains("")); + writeTransaction.Query.Define("define person sub entity;").Resolve(); - Utils.DeleteDatabase(dbManager, db1); + string longQuery = "define name sub attribute, value string; person owns name;"; + writeTransaction.Query.Define(longQuery).Resolve(); - IDatabase db2 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); + writeTransaction.Commit(); // No need to close manually if committed + schemaSession.Close(); - Utils.CheckAllDatabases(dbManager, new HashSet(){expectedDbName}); - Utils.DeleteDatabase(dbManager, db2); - Utils.CloseConnection(driver); - } + ITypeDBSession dataSession = driver.Session(dbName, SessionType.DATA); + ITypeDBTransaction dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE); - [Test] - public void FailCreateTwoDatabasesWithSameName() - { - string expectedDbName = "hello_from_csharp"; + string query = "insert $p isa person, has name 'Alice';"; + IConceptMap[] insertResults = dataWriteTransaction.Query.Insert(query).ToArray(); + ProcessPersonInsertResult(insertResults, "p", "person", "Alice"); + + dataWriteTransaction.Commit(); + dataSession.Close(); + + dataSession = driver.Session(dbName, SessionType.DATA); + dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE); + + insertResults = dataWriteTransaction.Query.Insert("insert $p isa person, has name 'Bob';").ToArray(); + ProcessPersonInsertResult(insertResults, "p", "person", "Bob"); - ITypeDBDriver driver = Utils.OpenConnection(); - IDatabaseManager dbManager = driver.Databases; + // dataWriteTransaction.Commit(); // Not committed - IDatabase db1 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); + ITypeDBTransaction readTransaction = dataSession.Transaction(TransactionType.READ); + IEnumerable matchResults = + readTransaction.Query.Get("match $p isa person, has name $n; get $n;"); - var exception = Assert.Throws( - () => Utils.CreateDatabaseNoChecks(dbManager, expectedDbName)); - Assert.That(exception.Message, Does.Contain("already exists")); + ProcessPersonMatchResult(matchResults, "n", "Alice", "name"); - Utils.DeleteDatabase(dbManager, db1); - Utils.CloseConnection(driver); + readTransaction.Close(); + dataSession.Close(); + + database.Delete(); + driver.Close(); + } + catch (TypeDBDriverException e) + { + Console.WriteLine($"Caught TypeDB Driver Exception: {e}"); + // ... + } } } } From c7ab812ee539828cc07e23d73b42be41580aff59 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 18 Mar 2024 12:24:30 +0000 Subject: [PATCH 007/118] Refactor and clean integration tests --- .../Test/Integration/Marshal/MarshalTest.cs | 18 +-- .../Integration/Quickstart/QuickstartTest.cs | 143 +++++++++++++----- 2 files changed, 107 insertions(+), 54 deletions(-) diff --git a/csharp/Test/Integration/Marshal/MarshalTest.cs b/csharp/Test/Integration/Marshal/MarshalTest.cs index 3c18f959d5..4164a0ecf8 100644 --- a/csharp/Test/Integration/Marshal/MarshalTest.cs +++ b/csharp/Test/Integration/Marshal/MarshalTest.cs @@ -47,11 +47,6 @@ public static void CloseConnection(ITypeDBDriver driver) Assert.False(driver.IsOpen()); } - public static void CreateDatabaseNoChecks(IDatabaseManager dbManager, string expectedDbName) - { - dbManager.Create(expectedDbName); - } - public static IDatabase CreateAndGetDatabase( IDatabaseManager dbManager, string expectedDbName, bool checkAbsence = true) { @@ -60,7 +55,7 @@ public static IDatabase CreateAndGetDatabase( Assert.False(dbManager.Contains(expectedDbName)); } - CreateDatabaseNoChecks(dbManager, expectedDbName); + dbManager.Create(expectedDbName); Assert.True(dbManager.Contains(expectedDbName)); IDatabase db = dbManager.Get(expectedDbName); @@ -78,17 +73,6 @@ public static void DeleteDatabase(IDatabaseManager dbManager, IDatabase db) db.Delete(); Assert.False(dbManager.Contains(dbName)); } - - public static void CheckAllDatabases(IDatabaseManager dbManager, ICollection expectedDbNames) - { - var allDbs = dbManager.GetAll(); - Assert.AreEqual(expectedDbNames.Count, allDbs.Count); - - foreach (var db in allDbs) - { - Assert.True(expectedDbNames.Contains(db.Name)); - } - } } [TestFixture] diff --git a/csharp/Test/Integration/Quickstart/QuickstartTest.cs b/csharp/Test/Integration/Quickstart/QuickstartTest.cs index a18f35c645..d0f271e82d 100644 --- a/csharp/Test/Integration/Quickstart/QuickstartTest.cs +++ b/csharp/Test/Integration/Quickstart/QuickstartTest.cs @@ -22,7 +22,6 @@ using System.Collections.Generic; using System.Linq; -using TypeDB.Driver; using TypeDB.Driver.Api; using TypeDB.Driver.Common; @@ -92,14 +91,6 @@ public static void CheckAllDatabases(IDatabaseManager dbManager, ICollection results, + IConceptMap[] results, string variableName, - string expectedAttributeValue, - string expectedVariableTypeLabel) + string expectedVariableTypeLabel, + string expectedAttributeValue) { - var collectedResults = results.ToArray(); - Assert.AreEqual(1, collectedResults.Length); // Only one insert has been committed + Assert.AreEqual(1, results.Length); // Only one insert has been committed - var result = collectedResults[0]; + var result = results[0]; var attribute = result.Get(variableName); Assert.IsNotNull(attribute); @@ -171,49 +161,49 @@ public void Usings() IDatabase database = driver.Databases.Get(dbName); // Example of one transaction for one session - using (ITypeDBSession schemaSession = driver.Session(dbName, SessionType.SCHEMA)) + using (ITypeDBSession session = driver.Session(dbName, SessionType.SCHEMA)) { // Example of multiple queries for one transaction - using (ITypeDBTransaction writeTransaction = schemaSession.Transaction(TransactionType.WRITE)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) { - writeTransaction.Query.Define("define person sub entity;").Resolve(); + transaction.Query.Define("define person sub entity;").Resolve(); string longQuery = "define name sub attribute, value string; person owns name;"; - writeTransaction.Query.Define(longQuery).Resolve(); + transaction.Query.Define(longQuery).Resolve(); - writeTransaction.Commit(); + transaction.Commit(); } } // Example of multiple transactions for one session - using (ITypeDBSession dataSession = driver.Session(dbName, SessionType.DATA)) + using (ITypeDBSession session = driver.Session(dbName, SessionType.DATA)) { // Examples of one query for one transaction - using (ITypeDBTransaction dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) { string query = "insert $p isa person, has name 'Alice';"; - IConceptMap[] insertResults = dataWriteTransaction.Query.Insert(query).ToArray(); + IConceptMap[] insertResults = transaction.Query.Insert(query).ToArray(); ProcessPersonInsertResult(insertResults, "p", "person", "Alice"); - dataWriteTransaction.Commit(); + transaction.Commit(); } - using (ITypeDBTransaction dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) { IConceptMap[] insertResults = - dataWriteTransaction.Query.Insert("insert $p isa person, has name 'Bob';").ToArray(); + transaction.Query.Insert("insert $p isa person, has name 'Bob';").ToArray(); ProcessPersonInsertResult(insertResults, "p", "person", "Bob"); // Not committed } - using (ITypeDBTransaction dataReadTransaction = dataSession.Transaction(TransactionType.READ)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.READ)) { - IEnumerable matchResults = - dataReadTransaction.Query.Get("match $p isa person, has name $n; get $n;"); + IConceptMap[] matchResults = + transaction.Query.Get("match $p isa person, has name $n; get $n;").ToArray(); // Matches only Alice as Bob has not been committed - ProcessPersonMatchResult(matchResults, "n", "Alice", "name"); + ProcessPersonMatchResult(matchResults, "n", "name", "Alice"); } } @@ -241,14 +231,14 @@ public void Manual() IDatabase database = driver.Databases.Get(dbName); ITypeDBSession schemaSession = driver.Session(dbName, SessionType.SCHEMA); - ITypeDBTransaction writeTransaction = schemaSession.Transaction(TransactionType.WRITE); + ITypeDBTransaction schemaWriteTransaction = schemaSession.Transaction(TransactionType.WRITE); - writeTransaction.Query.Define("define person sub entity;").Resolve(); + schemaWriteTransaction.Query.Define("define person sub entity;").Resolve(); string longQuery = "define name sub attribute, value string; person owns name;"; - writeTransaction.Query.Define(longQuery).Resolve(); + schemaWriteTransaction.Query.Define(longQuery).Resolve(); - writeTransaction.Commit(); // No need to close manually if committed + schemaWriteTransaction.Commit(); // No need to close manually if committed schemaSession.Close(); ITypeDBSession dataSession = driver.Session(dbName, SessionType.DATA); @@ -270,10 +260,10 @@ public void Manual() // dataWriteTransaction.Commit(); // Not committed ITypeDBTransaction readTransaction = dataSession.Transaction(TransactionType.READ); - IEnumerable matchResults = - readTransaction.Query.Get("match $p isa person, has name $n; get $n;"); + IConceptMap[] matchResults = + readTransaction.Query.Get("match $p isa person, has name $n; get $n;").ToArray(); - ProcessPersonMatchResult(matchResults, "n", "Alice", "name"); + ProcessPersonMatchResult(matchResults, "n", "name", "Alice"); readTransaction.Close(); dataSession.Close(); @@ -287,5 +277,84 @@ public void Manual() // ... } } + + [Test] + public void DocExample() + { + string dbName = "access-management-db"; + string serverAddr = "127.0.0.1:1729"; + + try + { + using (ITypeDBDriver driver = TypeDB.CoreDriver(serverAddr)) + { + driver.Databases.Create(dbName); + IDatabase database = driver.Databases.Get(dbName); + + // Example of one transaction for one session + using (ITypeDBSession session = driver.Session(dbName, SessionType.SCHEMA)) + { + // Example of multiple queries for one transaction + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) + { + transaction.Query.Define("define person sub entity;").Resolve(); + + string longQuery = "define name sub attribute, value string; person owns name;"; + transaction.Query.Define(longQuery).Resolve(); + + transaction.Commit(); + } + } + + // Example of multiple transactions for one session + using (ITypeDBSession session = driver.Session(dbName, SessionType.DATA)) + { + // Examples of one query for one transaction + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) + { + string query = "insert $p isa person, has name 'Alice';"; + IEnumerable insertResults = transaction.Query.Insert(query); + + Console.WriteLine($"Inserted with {insertResults.Count()} result(s)"); + + transaction.Commit(); + } + + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) + { + IEnumerable insertResults = + transaction.Query.Insert("insert $p isa person, has name 'Bob';"); + + foreach (IConceptMap insertResult in insertResults) + { + Console.WriteLine($"Inserted: {insertResult}"); + } + + // transaction.Commit(); // Not committed + } + + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.READ)) + { + IConceptMap[] matchResults = + transaction.Query.Get("match $p isa person, has name $n; get $n;").ToArray(); + + // Matches only Alice as Bob has not been committed + Console.WriteLine($"Found the first name: {matchResults[0]}"); + if (matchResults.Length > 1) // Will work only if the previous transaction is committed. + { + Console.WriteLine($"Found the second name: {matchResults[1]}"); + } + } + } + + database.Delete(); + } + } + catch (TypeDBDriverException e) + { + Console.WriteLine($"Caught TypeDB Driver Exception: {e}"); + // ... + } + } } } From 3919aad12b7b3cef888473948cbd8601cf59798d Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 18 Mar 2024 12:25:28 +0000 Subject: [PATCH 008/118] Rename test fixture --- .../Integration/Quickstart/QuickstartTest.cs | 63 +------------------ 1 file changed, 1 insertion(+), 62 deletions(-) diff --git a/csharp/Test/Integration/Quickstart/QuickstartTest.cs b/csharp/Test/Integration/Quickstart/QuickstartTest.cs index d0f271e82d..2a5a4a9f6c 100644 --- a/csharp/Test/Integration/Quickstart/QuickstartTest.cs +++ b/csharp/Test/Integration/Quickstart/QuickstartTest.cs @@ -27,69 +27,8 @@ namespace TypeDB.Driver.Test.Integration { - public static class Utils - { - public static ITypeDBDriver OpenConnection() - { - ITypeDBDriver driver = TypeDB.CoreDriver(TypeDB.DEFAULT_ADDRESS); - Assert.IsNotNull(driver); - Assert.True(driver.IsOpen()); - - return driver; - } - - public static void CloseConnection(ITypeDBDriver driver) - { - driver.Close(); - Assert.False(driver.IsOpen()); - } - - public static void CreateDatabaseNoChecks(IDatabaseManager dbManager, string expectedDbName) - { - dbManager.Create(expectedDbName); - } - - public static IDatabase CreateAndGetDatabase( - IDatabaseManager dbManager, string expectedDbName, bool checkAbsence = true) - { - if (checkAbsence) - { - Assert.False(dbManager.Contains(expectedDbName)); - } - - CreateDatabaseNoChecks(dbManager, expectedDbName); - Assert.True(dbManager.Contains(expectedDbName)); - - IDatabase db = dbManager.Get(expectedDbName); - Assert.IsNotNull(db); - - string realDbName = db.Name; - Assert.AreEqual(expectedDbName, realDbName); - - return db; - } - - public static void DeleteDatabase(IDatabaseManager dbManager, IDatabase db) - { - string dbName = db.Name; - db.Delete(); - Assert.False(dbManager.Contains(dbName)); - } - - public static void CheckAllDatabases(IDatabaseManager dbManager, ICollection expectedDbNames) - { - var allDbs = dbManager.GetAll(); - Assert.AreEqual(expectedDbNames.Count, allDbs.Count); - - foreach (var db in allDbs) - { - Assert.True(expectedDbNames.Contains(db.Name)); - } - } - } - [TestFixture] - public class ConnectionTestFixture + public class QuickstartTestFixture { private void ProcessPersonInsertResult( IConceptMap[] results, From 958fd6e929a4796e9cf09c56e43fa4140f145a6f Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 18 Mar 2024 12:41:08 +0000 Subject: [PATCH 009/118] Add more usages of concepts to the quickstart test --- csharp/Test/Integration/Quickstart/QuickstartTest.cs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/csharp/Test/Integration/Quickstart/QuickstartTest.cs b/csharp/Test/Integration/Quickstart/QuickstartTest.cs index 2a5a4a9f6c..db49c3df4f 100644 --- a/csharp/Test/Integration/Quickstart/QuickstartTest.cs +++ b/csharp/Test/Integration/Quickstart/QuickstartTest.cs @@ -278,10 +278,12 @@ public void DocExample() transaction.Query.Get("match $p isa person, has name $n; get $n;").ToArray(); // Matches only Alice as Bob has not been committed - Console.WriteLine($"Found the first name: {matchResults[0]}"); + var resultName = matchResults[0].Get("n"); + Console.WriteLine($"Found the first name: {resultName.AsAttribute().Value.AsString()}"); + if (matchResults.Length > 1) // Will work only if the previous transaction is committed. { - Console.WriteLine($"Found the second name: {matchResults[1]}"); + Console.WriteLine($"Found the second name as concept: {matchResults[1]}"); } } } From f27ffbd6bd1f3e7913ec8d5f96854863cd584b13 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 18 Mar 2024 14:28:24 +0000 Subject: [PATCH 010/118] Rename Quickstart -> Examples --- csharp/Test/Integration/{Quickstart => Examples}/BUILD | 2 +- .../{Quickstart/QuickstartTest.cs => Examples/ExamplesTest.cs} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename csharp/Test/Integration/{Quickstart => Examples}/BUILD (97%) rename csharp/Test/Integration/{Quickstart/QuickstartTest.cs => Examples/ExamplesTest.cs} (100%) diff --git a/csharp/Test/Integration/Quickstart/BUILD b/csharp/Test/Integration/Examples/BUILD similarity index 97% rename from csharp/Test/Integration/Quickstart/BUILD rename to csharp/Test/Integration/Examples/BUILD index 64db0bb039..f6c4097650 100644 --- a/csharp/Test/Integration/Quickstart/BUILD +++ b/csharp/Test/Integration/Examples/BUILD @@ -22,7 +22,7 @@ load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") csharp_integration_test( name = "test", - srcs = ["QuickstartTest.cs"], + srcs = ["ExamplesTest.cs"], deps = [ "//csharp:driver-csharp", "//csharp/Api:api", diff --git a/csharp/Test/Integration/Quickstart/QuickstartTest.cs b/csharp/Test/Integration/Examples/ExamplesTest.cs similarity index 100% rename from csharp/Test/Integration/Quickstart/QuickstartTest.cs rename to csharp/Test/Integration/Examples/ExamplesTest.cs From 8ffe135f0ace3d89dbbd1aa73b90fa68f8574703 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 18 Mar 2024 16:53:54 +0000 Subject: [PATCH 011/118] Start adding documentation --- cpp/README.md | 2 +- csharp/Api/BUILD | 7 +++++++ csharp/Common/BUILD | 7 +++++++ csharp/Common/Exception/TypeDBDriverException.cs | 3 +++ java/README.md | 6 +++--- nodejs/README.md | 6 +++--- python/README.md | 4 ++-- rust/README.md | 4 ++-- 8 files changed, 28 insertions(+), 11 deletions(-) diff --git a/cpp/README.md b/cpp/README.md index eae2f0ef0a..7eb7a64270 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -17,7 +17,7 @@ As usual, Add the include paths to your compile step & the library to your link A [sample `CMakeLists`](https://github.com/vaticle/typedb-driver/blob/master/cpp/test/assembly/CMakeLists.txt) is available on the TypeDB Driver repository. ## API Reference -Will be added to [the docs](https://typedb.com/docs/drivers/overview) in a later release. The general layout (of classes, their methods and intended usage) resembles the [Java Driver API](https://typedb.com/docs/clients/java-driver/api-reference). +To learn about the methods available for executing queries and retrieving their answers using Driver Java, refer to the [API Reference](https://typedb.com/docs/drivers/cpp/api-reference). ## Driver Architecture The C++ driver is a thin wrapper around the TypeDB rust driver, introducing classes for a more intuitive interface. Each C++ object holds a unique pointer to the corresponding native rust object and is the unique owner of that rust object. To ensure this, we enforce move-semantics on the C++ objects. The rust object is freed when the C++ object owning it is destructed. diff --git a/csharp/Api/BUILD b/csharp/Api/BUILD index 9421cd40a0..81344993e6 100644 --- a/csharp/Api/BUILD +++ b/csharp/Api/BUILD @@ -38,6 +38,13 @@ csharp_library( ) +filegroup( + name = "docs_source_files", + srcs = glob(["*.cs", "*/*.cs", "*/*/*.cs"]), + visibility = ["//csharp:__pkg__"], +) + + checkstyle_test( name = "checkstyle", include = glob(["*", "*/*", "*/*/*"]), diff --git a/csharp/Common/BUILD b/csharp/Common/BUILD index cd2f4c3094..131ca5214a 100644 --- a/csharp/Common/BUILD +++ b/csharp/Common/BUILD @@ -33,6 +33,13 @@ csharp_library( ) +filegroup( + name = "docs_source_files", + srcs = ["Label.cs", "Promise/*.cs", "Exception/TypeDBDriverException.cs"], + visibility = ["//csharp:__pkg__"], +) + + checkstyle_test( name = "checkstyle", size = "small", diff --git a/csharp/Common/Exception/TypeDBDriverException.cs b/csharp/Common/Exception/TypeDBDriverException.cs index f8f206532f..816ef59d5a 100644 --- a/csharp/Common/Exception/TypeDBDriverException.cs +++ b/csharp/Common/Exception/TypeDBDriverException.cs @@ -24,6 +24,9 @@ namespace TypeDB.Driver.Common { + /** + * Exceptions raised by the driver. + */ public class TypeDBDriverException : System.Exception { /** diff --git a/java/README.md b/java/README.md index 9f6dc0e92f..c78b8c81fe 100644 --- a/java/README.md +++ b/java/README.md @@ -1,10 +1,10 @@ # TypeDB Java Driver ## Driver Architecture -To learn about the mechanism that a TypeDB Driver uses to set up communication with databases running on the TypeDB Server, refer to the [Clients Overview](https://typedb.com/docs/clients/overview). +To learn about the mechanism that a TypeDB Driver uses to set up communication with databases running on the TypeDB Server, refer to the [Clients Overview](https://typedb.com/docs/drivers/overview). ## API Reference -To learn about the methods available for executing queries and retrieving their answers using Driver Java, refer to the [API Reference](https://typedb.com/docs/clients/java-driver/api-reference). +To learn about the methods available for executing queries and retrieving their answers using Driver Java, refer to the [API Reference](https://typedb.com/docs/drivers/java/api-reference). ## Import TypeDB Driver for Java through Maven @@ -25,7 +25,7 @@ To learn about the methods available for executing queries and retrieving their ``` -Further documentation: https://typedb.com/docs/clients/java-driver +Further documentation: https://typedb.com/docs/drivers/java/overview ## Build TypeDB Driver for Java from Source diff --git a/nodejs/README.md b/nodejs/README.md index 7043b0c636..b85cfccd5c 100644 --- a/nodejs/README.md +++ b/nodejs/README.md @@ -7,10 +7,10 @@ [![Stack Overflow](https://img.shields.io/badge/stackoverflow-typeql-3dce8c.svg)](https://stackoverflow.com/questions/tagged/typeql) ## Driver Architecture -To learn about the mechanism that a TypeDB Driver uses to set up communication with databases running on the TypeDB Server, refer to the [Clients Overview](https://typedb.com/docs/clients/overview). +To learn about the mechanism that a TypeDB Driver uses to set up communication with databases running on the TypeDB Server, refer to the [Clients Overview](https://typedb.com/docs/drivers/overview). ## API Reference -To learn about the methods available for executing queries and retrieving their answers using Driver NodeJS, refer to the [API Reference](https://typedb.com/docs/clients/nodejs-driver/api-reference). +To learn about the methods available for executing queries and retrieving their answers using Driver NodeJS, refer to the [API Reference](https://typedb.com/docs/drivers/nodejs/api-reference). ## Installation @@ -19,7 +19,7 @@ To learn about the methods available for executing queries and retrieving their ```shell script npm install typedb-driver ``` -Further documentation: https://typedb.com/docs/clients/nodejs-driver +Further documentation: https://typedb.com/docs/drivers/nodejs/overview ## Using TypeScript `typedb-driver` is a TypeScript project and provides its own type definitions out of the box - for example: diff --git a/python/README.md b/python/README.md index e47dc5258c..3732760ed6 100644 --- a/python/README.md +++ b/python/README.md @@ -1,10 +1,10 @@ # TypeDB Python Driver ## Driver Architecture -To learn about the mechanism that a TypeDB Driver uses to set up communication with databases running on the TypeDB Server, refer to the [Clients Overview](https://typedb.com/docs/clients/overview). +To learn about the mechanism that a TypeDB Driver uses to set up communication with databases running on the TypeDB Server, refer to the [Clients Overview](https://typedb.com/docs/drivers/overview). ## API Reference -To learn about the methods available for executing queries and retrieving their answers using Driver Python, refer to the [API Reference](https://typedb.com/docs/clients/python-driver/api-reference). +To learn about the methods available for executing queries and retrieving their answers using Driver Python, refer to the [API Reference](https://typedb.com/docs/drivers/python/api-reference). ## Install TypeDB Driver for Python through Pip ``` diff --git a/rust/README.md b/rust/README.md index c6653250f0..266d42f364 100644 --- a/rust/README.md +++ b/rust/README.md @@ -7,12 +7,12 @@ [![Stack Overflow](https://img.shields.io/badge/stackoverflow-typeql-3dce8c.svg)](https://stackoverflow.com/questions/tagged/typeql) ## Driver Architecture -To learn about the mechanism that a TypeDB Driver uses to set up communication with databases running on the TypeDB Server, refer to the [Clients Overview](https://typedb.com/docs/clients/overview). +To learn about the mechanism that a TypeDB Driver uses to set up communication with databases running on the TypeDB Server, refer to the [Clients Overview](https://typedb.com/docs/drivers/overview). The TypeDB Driver for Rust provides a fully async API that supports multiple async runtimes or a synchronous interface gated by the `sync` feature. ## API Reference -To learn about the methods available for executing queries and retrieving their answers using Driver Rust, refer to the [API Reference](https://typedb.com/docs/clients/rust-driver/api-reference). +To learn about the methods available for executing queries and retrieving their answers using Driver Rust, refer to the [API Reference](https://typedb.com/docs/drivers/rust/api-reference). ## Quickstart 1. Import `typedb-driver` through Cargo: From e8cc6681e3446fa93ede62b7f5773f2727bcd140 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 19 Mar 2024 17:36:15 +0000 Subject: [PATCH 012/118] Fix checkstyle --- .../Test/Integration/Examples/ExamplesTest.cs | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/csharp/Test/Integration/Examples/ExamplesTest.cs b/csharp/Test/Integration/Examples/ExamplesTest.cs index db49c3df4f..7be8ff0aef 100644 --- a/csharp/Test/Integration/Examples/ExamplesTest.cs +++ b/csharp/Test/Integration/Examples/ExamplesTest.cs @@ -100,10 +100,10 @@ public void Usings() IDatabase database = driver.Databases.Get(dbName); // Example of one transaction for one session - using (ITypeDBSession session = driver.Session(dbName, SessionType.SCHEMA)) + using (ITypeDBSession session = driver.Session(dbName, SessionType.Schema)) { // Example of multiple queries for one transaction - using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Write)) { transaction.Query.Define("define person sub entity;").Resolve(); @@ -115,10 +115,10 @@ public void Usings() } // Example of multiple transactions for one session - using (ITypeDBSession session = driver.Session(dbName, SessionType.DATA)) + using (ITypeDBSession session = driver.Session(dbName, SessionType.Data)) { // Examples of one query for one transaction - using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Write)) { string query = "insert $p isa person, has name 'Alice';"; IConceptMap[] insertResults = transaction.Query.Insert(query).ToArray(); @@ -127,7 +127,7 @@ public void Usings() transaction.Commit(); } - using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Write)) { IConceptMap[] insertResults = transaction.Query.Insert("insert $p isa person, has name 'Bob';").ToArray(); @@ -136,7 +136,7 @@ public void Usings() // Not committed } - using (ITypeDBTransaction transaction = session.Transaction(TransactionType.READ)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Read)) { IConceptMap[] matchResults = transaction.Query.Get("match $p isa person, has name $n; get $n;").ToArray(); @@ -169,8 +169,8 @@ public void Manual() IDatabase database = driver.Databases.Get(dbName); - ITypeDBSession schemaSession = driver.Session(dbName, SessionType.SCHEMA); - ITypeDBTransaction schemaWriteTransaction = schemaSession.Transaction(TransactionType.WRITE); + ITypeDBSession schemaSession = driver.Session(dbName, SessionType.Schema); + ITypeDBTransaction schemaWriteTransaction = schemaSession.Transaction(TransactionType.Write); schemaWriteTransaction.Query.Define("define person sub entity;").Resolve(); @@ -180,8 +180,8 @@ public void Manual() schemaWriteTransaction.Commit(); // No need to close manually if committed schemaSession.Close(); - ITypeDBSession dataSession = driver.Session(dbName, SessionType.DATA); - ITypeDBTransaction dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE); + ITypeDBSession dataSession = driver.Session(dbName, SessionType.Data); + ITypeDBTransaction dataWriteTransaction = dataSession.Transaction(TransactionType.Write); string query = "insert $p isa person, has name 'Alice';"; IConceptMap[] insertResults = dataWriteTransaction.Query.Insert(query).ToArray(); @@ -190,15 +190,15 @@ public void Manual() dataWriteTransaction.Commit(); dataSession.Close(); - dataSession = driver.Session(dbName, SessionType.DATA); - dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE); + dataSession = driver.Session(dbName, SessionType.Data); + dataWriteTransaction = dataSession.Transaction(TransactionType.Write); insertResults = dataWriteTransaction.Query.Insert("insert $p isa person, has name 'Bob';").ToArray(); ProcessPersonInsertResult(insertResults, "p", "person", "Bob"); // dataWriteTransaction.Commit(); // Not committed - ITypeDBTransaction readTransaction = dataSession.Transaction(TransactionType.READ); + ITypeDBTransaction readTransaction = dataSession.Transaction(TransactionType.Read); IConceptMap[] matchResults = readTransaction.Query.Get("match $p isa person, has name $n; get $n;").ToArray(); @@ -231,10 +231,10 @@ public void DocExample() IDatabase database = driver.Databases.Get(dbName); // Example of one transaction for one session - using (ITypeDBSession session = driver.Session(dbName, SessionType.SCHEMA)) + using (ITypeDBSession session = driver.Session(dbName, SessionType.Schema)) { // Example of multiple queries for one transaction - using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Write)) { transaction.Query.Define("define person sub entity;").Resolve(); @@ -246,10 +246,10 @@ public void DocExample() } // Example of multiple transactions for one session - using (ITypeDBSession session = driver.Session(dbName, SessionType.DATA)) + using (ITypeDBSession session = driver.Session(dbName, SessionType.Data)) { // Examples of one query for one transaction - using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Write)) { string query = "insert $p isa person, has name 'Alice';"; IEnumerable insertResults = transaction.Query.Insert(query); @@ -259,7 +259,7 @@ public void DocExample() transaction.Commit(); } - using (ITypeDBTransaction transaction = session.Transaction(TransactionType.WRITE)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Write)) { IEnumerable insertResults = transaction.Query.Insert("insert $p isa person, has name 'Bob';"); @@ -272,7 +272,7 @@ public void DocExample() // transaction.Commit(); // Not committed } - using (ITypeDBTransaction transaction = session.Transaction(TransactionType.READ)) + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Read)) { IConceptMap[] matchResults = transaction.Query.Get("match $p isa person, has name $n; get $n;").ToArray(); From 1fbf274a88437fb8cfc56ad978ec9a5c4f76e029 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 19 Mar 2024 18:24:18 +0000 Subject: [PATCH 013/118] Add doxygen html generation, wip --- csharp/BUILD | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/csharp/BUILD b/csharp/BUILD index 265f91fa0c..6329db506b 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -16,6 +16,7 @@ # under the License. load("@rules_dotnet//dotnet:defs.bzl", "csharp_binary", "csharp_library") +load("@vaticle_bazel_distribution//docs:cpp/rules.bzl", "doxygen_docs") load(":build_opts.bzl", "target_frameworks", "targeting_packs", "nullable_context") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") load(":rules.bzl", "swig_native_csharp_library") @@ -58,6 +59,22 @@ csharp_library( ) +filegroup( + name = "docs_source_files", + srcs = [":TypeDB.cs"], +) + + +# TODO: Not hermetic - requires doxygen on the host +doxygen_docs( + name = "docs_html", + project_name = "TypeDB C# Driver", + sources = [":docs_source_files", "//csharp/Api:docs_source_files", "//csharp/Common:docs_source_files"], + main_page_md = ":README.md", + tags = ["manual"], +) + + checkstyle_test( name = "checkstyle", size = "small", From 2f6807047c5c198c12aa3cddb2861a6c621a8d43 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 19 Mar 2024 18:35:52 +0000 Subject: [PATCH 014/118] Fix references in the common build --- csharp/Common/BUILD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/csharp/Common/BUILD b/csharp/Common/BUILD index 131ca5214a..f858e726e6 100644 --- a/csharp/Common/BUILD +++ b/csharp/Common/BUILD @@ -35,7 +35,7 @@ csharp_library( filegroup( name = "docs_source_files", - srcs = ["Label.cs", "Promise/*.cs", "Exception/TypeDBDriverException.cs"], + srcs = ["Label.cs", "Promise/Promise.cs", "Promise/VoidPromise.cs", "Exception/TypeDBDriverException.cs"], visibility = ["//csharp:__pkg__"], ) From 162b93ab9c3a5bafd657f04c3c5be3a8ed933656 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 20 Mar 2024 12:52:02 +0000 Subject: [PATCH 015/118] Refactor Properties <-> Methods. Fix some documentation --- .../Integration/Connection/ConnectionTest.cs | 149 ++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100644 csharp/Test/Integration/Connection/ConnectionTest.cs diff --git a/csharp/Test/Integration/Connection/ConnectionTest.cs b/csharp/Test/Integration/Connection/ConnectionTest.cs new file mode 100644 index 0000000000..b12de7c2c4 --- /dev/null +++ b/csharp/Test/Integration/Connection/ConnectionTest.cs @@ -0,0 +1,149 @@ +/* + * Copyright (C) 2022 Vaticle + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +using NUnit.Framework; +using System; +using System.Collections.Generic; + +using TypeDB.Driver; +using TypeDB.Driver.Api; +using TypeDB.Driver.Common; + +namespace TypeDB.Driver.Test.Integration +{ + public static class Utils + { + public static ITypeDBDriver OpenConnection() + { + ITypeDBDriver driver = TypeDB.CoreDriver(TypeDB.DEFAULT_ADDRESS); + Assert.IsNotNull(driver); + Assert.True(driver.IsOpen()); + + return driver; + } + + public static void CloseConnection(ITypeDBDriver driver) + { + driver.Close(); + Assert.False(driver.IsOpen()); + } + + public static void CreateDatabaseNoChecks(IDatabaseManager dbManager, string expectedDbName) + { + dbManager.Create(expectedDbName); + } + + public static IDatabase CreateAndGetDatabase( + IDatabaseManager dbManager, string expectedDbName, bool checkAbsence = true) + { + if (checkAbsence) + { + Assert.False(dbManager.Contains(expectedDbName)); + } + + CreateDatabaseNoChecks(dbManager, expectedDbName); + Assert.True(dbManager.Contains(expectedDbName)); + + IDatabase db = dbManager.Get(expectedDbName); + Assert.IsNotNull(db); + + string realDbName = db.Name; + Assert.AreEqual(expectedDbName, realDbName); + + return db; + } + + public static void DeleteDatabase(IDatabaseManager dbManager, IDatabase db) + { + string dbName = db.Name; + db.Delete(); + Assert.False(dbManager.Contains(dbName)); + } + + public static void CheckAllDatabases(IDatabaseManager dbManager, ICollection expectedDbNames) + { + var allDbs = dbManager.GetAll(); + Assert.AreEqual(expectedDbNames.Count, allDbs.Count); + + foreach (var db in allDbs) + { + Assert.True(expectedDbNames.Contains(db.Name)); + } + } + } + + [TestFixture] + public class ConnectionTestFixture + { + [Test] + public void OpenAndCloseConnection() + { + ITypeDBDriver driver = Utils.OpenConnection(); + Utils.CloseConnection(driver); + } + + [Test] + public void CreateAndDeleteAndRecreateDatabase() + { + string expectedDbName = "hello_from_csharp"; + + ITypeDBDriver driver = Utils.OpenConnection(); + IDatabaseManager dbManager = driver.Databases; + + Assert.Throws(() => dbManager.Contains("")); + Utils.CheckAllDatabases(dbManager, new HashSet()); + + IDatabase db1 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); + + Utils.CheckAllDatabases(dbManager, new HashSet(){expectedDbName}); + Assert.False(dbManager.Contains(expectedDbName + "1")); + Assert.False(dbManager.Contains(expectedDbName.Substring(1))); + Assert.False(dbManager.Contains(expectedDbName.Remove(expectedDbName.Length - 1))); + Assert.Throws(() => dbManager.Contains("")); + + Utils.DeleteDatabase(dbManager, db1); + + IDatabase db2 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); + + Utils.CheckAllDatabases(dbManager, new HashSet(){expectedDbName}); + Utils.DeleteDatabase(dbManager, db2); + Utils.CloseConnection(driver); + } + + [Test] + public void FailCreateTwoDatabasesWithSameName() + { + string expectedDbName = "hello_from_csharp"; + + ITypeDBDriver driver = Utils.OpenConnection(); + IDatabaseManager dbManager = driver.Databases; + + IDatabase db1 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); + + var exception = Assert.Throws( + () => Utils.CreateDatabaseNoChecks(dbManager, expectedDbName)); + Assert.That(exception.Message, Does.Contain("already exists")); + + Utils.DeleteDatabase(dbManager, db1); + Utils.CloseConnection(driver); + } + } +} From f1b57a55c38c80c978aaf656ff4a80b650f4ef7d Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Fri, 15 Mar 2024 17:58:01 +0000 Subject: [PATCH 016/118] Start the quickstart test, several experiments. Wip --- csharp/Test/Integration/Quickstart/BUILD | 48 +++++++++++++++ .../QuickstartTest.cs} | 58 +++++++++++++++++++ 2 files changed, 106 insertions(+) create mode 100644 csharp/Test/Integration/Quickstart/BUILD rename csharp/Test/Integration/{Connection/ConnectionTest.cs => Quickstart/QuickstartTest.cs} (69%) diff --git a/csharp/Test/Integration/Quickstart/BUILD b/csharp/Test/Integration/Quickstart/BUILD new file mode 100644 index 0000000000..056b125de5 --- /dev/null +++ b/csharp/Test/Integration/Quickstart/BUILD @@ -0,0 +1,48 @@ +# +# Copyright (C) 2022 Vaticle +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +load("//csharp:build_opts.bzl", "nullable_context", "target_frameworks", "targeting_packs") +load("//csharp/Test:rules.bzl", "csharp_integration_test") +load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") + + +csharp_integration_test( + name = "test", +<<<<<<<< HEAD:csharp/Test/Integration/Examples/BUILD + srcs = ["ExamplesTest.cs"], +======== + srcs = ["QuickstartTest.cs"], +>>>>>>>> 9e84f98e (Start the quickstart test, several experiments. Wip):csharp/Test/Integration/Quickstart/BUILD + deps = [ + "//csharp:driver-csharp", + "//csharp/Api:api", + "//csharp/Common:common", + ], + target_frameworks = target_frameworks, + targeting_packs = targeting_packs, +) + + +checkstyle_test( + name = "checkstyle", + include = glob(["*"]), + license_type = "apache-header", +) diff --git a/csharp/Test/Integration/Connection/ConnectionTest.cs b/csharp/Test/Integration/Quickstart/QuickstartTest.cs similarity index 69% rename from csharp/Test/Integration/Connection/ConnectionTest.cs rename to csharp/Test/Integration/Quickstart/QuickstartTest.cs index b12de7c2c4..10e4565d71 100644 --- a/csharp/Test/Integration/Connection/ConnectionTest.cs +++ b/csharp/Test/Integration/Quickstart/QuickstartTest.cs @@ -22,6 +22,7 @@ using NUnit.Framework; using System; using System.Collections.Generic; +using System.Linq; using TypeDB.Driver; using TypeDB.Driver.Api; @@ -93,6 +94,63 @@ public static void CheckAllDatabases(IDatabaseManager dbManager, ICollection Date: Mon, 18 Mar 2024 12:24:30 +0000 Subject: [PATCH 017/118] Resolve conflictsRefactor and clean integration tests --- csharp/Test/Integration/Quickstart/BUILD | 48 ---- .../Integration/Quickstart/QuickstartTest.cs | 207 ------------------ 2 files changed, 255 deletions(-) delete mode 100644 csharp/Test/Integration/Quickstart/BUILD delete mode 100644 csharp/Test/Integration/Quickstart/QuickstartTest.cs diff --git a/csharp/Test/Integration/Quickstart/BUILD b/csharp/Test/Integration/Quickstart/BUILD deleted file mode 100644 index 056b125de5..0000000000 --- a/csharp/Test/Integration/Quickstart/BUILD +++ /dev/null @@ -1,48 +0,0 @@ -# -# Copyright (C) 2022 Vaticle -# -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -load("//csharp:build_opts.bzl", "nullable_context", "target_frameworks", "targeting_packs") -load("//csharp/Test:rules.bzl", "csharp_integration_test") -load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - - -csharp_integration_test( - name = "test", -<<<<<<<< HEAD:csharp/Test/Integration/Examples/BUILD - srcs = ["ExamplesTest.cs"], -======== - srcs = ["QuickstartTest.cs"], ->>>>>>>> 9e84f98e (Start the quickstart test, several experiments. Wip):csharp/Test/Integration/Quickstart/BUILD - deps = [ - "//csharp:driver-csharp", - "//csharp/Api:api", - "//csharp/Common:common", - ], - target_frameworks = target_frameworks, - targeting_packs = targeting_packs, -) - - -checkstyle_test( - name = "checkstyle", - include = glob(["*"]), - license_type = "apache-header", -) diff --git a/csharp/Test/Integration/Quickstart/QuickstartTest.cs b/csharp/Test/Integration/Quickstart/QuickstartTest.cs deleted file mode 100644 index 10e4565d71..0000000000 --- a/csharp/Test/Integration/Quickstart/QuickstartTest.cs +++ /dev/null @@ -1,207 +0,0 @@ -/* - * Copyright (C) 2022 Vaticle - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -using NUnit.Framework; -using System; -using System.Collections.Generic; -using System.Linq; - -using TypeDB.Driver; -using TypeDB.Driver.Api; -using TypeDB.Driver.Common; - -namespace TypeDB.Driver.Test.Integration -{ - public static class Utils - { - public static ITypeDBDriver OpenConnection() - { - ITypeDBDriver driver = TypeDB.CoreDriver(TypeDB.DEFAULT_ADDRESS); - Assert.IsNotNull(driver); - Assert.True(driver.IsOpen()); - - return driver; - } - - public static void CloseConnection(ITypeDBDriver driver) - { - driver.Close(); - Assert.False(driver.IsOpen()); - } - - public static void CreateDatabaseNoChecks(IDatabaseManager dbManager, string expectedDbName) - { - dbManager.Create(expectedDbName); - } - - public static IDatabase CreateAndGetDatabase( - IDatabaseManager dbManager, string expectedDbName, bool checkAbsence = true) - { - if (checkAbsence) - { - Assert.False(dbManager.Contains(expectedDbName)); - } - - CreateDatabaseNoChecks(dbManager, expectedDbName); - Assert.True(dbManager.Contains(expectedDbName)); - - IDatabase db = dbManager.Get(expectedDbName); - Assert.IsNotNull(db); - - string realDbName = db.Name; - Assert.AreEqual(expectedDbName, realDbName); - - return db; - } - - public static void DeleteDatabase(IDatabaseManager dbManager, IDatabase db) - { - string dbName = db.Name; - db.Delete(); - Assert.False(dbManager.Contains(dbName)); - } - - public static void CheckAllDatabases(IDatabaseManager dbManager, ICollection expectedDbNames) - { - var allDbs = dbManager.GetAll(); - Assert.AreEqual(expectedDbNames.Count, allDbs.Count); - - foreach (var db in allDbs) - { - Assert.True(expectedDbNames.Contains(db.Name)); - } - } - } - - [TestFixture] - public class ConnectionTestFixture - { - public ConnectionTestFixture() - { - ITypeDBDriver driver = TypeDB.CoreDriver(TypeDB.DEFAULT_ADDRESS); - - try {var db = driver.Databases.Get("mydb"); - if (db != null) db.Delete();} catch(TypeDBDriverException e) { Console.WriteLine(e); } - } - - [Test] - public void Test() - { - ITypeDBDriver driver = TypeDB.CoreDriver(TypeDB.DEFAULT_ADDRESS); - - string dbName = "mydb"; - driver.Databases.Create(dbName); - IDatabase mydb = driver.Databases.Get(dbName); - System.Console.WriteLine(mydb.Name); - - using (ITypeDBSession schemaSession = driver.Session(dbName, SessionType.SCHEMA)) - { - using (ITypeDBTransaction writeTransaction = schemaSession.Transaction(TransactionType.WRITE)) - { - writeTransaction.Query.Define("define person sub entity;").Resolve(); // Can throw exceptions, so could be wrapped in try-catch! - - string longQuery = "define name sub attribute, value string; person owns name;"; - writeTransaction.Query.Define(longQuery).Resolve(); - - writeTransaction.Commit(); - } - } - - ITypeDBSession dataSession = driver.Session(dbName, SessionType.DATA); - ITypeDBTransaction dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE); - - string query = "insert $p isa person, has name 'Alice';"; - var results = dataWriteTransaction.Query.Insert(query).ToArray(); - foreach (var result in results) - { - Console.WriteLine(result); - } - - dataWriteTransaction.Close(); - dataSession.Close(); - - dataSession = driver.Session(dbName, SessionType.DATA); - dataWriteTransaction = dataSession.Transaction(TransactionType.WRITE); - - var results2 = dataWriteTransaction.Query.Insert("insert $p isa person, has name 'Bob';").ToArray(); - foreach (var result in results2) - { - Console.WriteLine(result); - } - - - mydb.Delete(); - } - - [Test] - public void OpenAndCloseConnection() - { - ITypeDBDriver driver = Utils.OpenConnection(); - Utils.CloseConnection(driver); - } - - [Test] - public void CreateAndDeleteAndRecreateDatabase() - { - string expectedDbName = "hello_from_csharp"; - - ITypeDBDriver driver = Utils.OpenConnection(); - IDatabaseManager dbManager = driver.Databases; - - Assert.Throws(() => dbManager.Contains("")); - Utils.CheckAllDatabases(dbManager, new HashSet()); - - IDatabase db1 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); - - Utils.CheckAllDatabases(dbManager, new HashSet(){expectedDbName}); - Assert.False(dbManager.Contains(expectedDbName + "1")); - Assert.False(dbManager.Contains(expectedDbName.Substring(1))); - Assert.False(dbManager.Contains(expectedDbName.Remove(expectedDbName.Length - 1))); - Assert.Throws(() => dbManager.Contains("")); - - Utils.DeleteDatabase(dbManager, db1); - - IDatabase db2 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); - - Utils.CheckAllDatabases(dbManager, new HashSet(){expectedDbName}); - Utils.DeleteDatabase(dbManager, db2); - Utils.CloseConnection(driver); - } - - [Test] - public void FailCreateTwoDatabasesWithSameName() - { - string expectedDbName = "hello_from_csharp"; - - ITypeDBDriver driver = Utils.OpenConnection(); - IDatabaseManager dbManager = driver.Databases; - - IDatabase db1 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); - - var exception = Assert.Throws( - () => Utils.CreateDatabaseNoChecks(dbManager, expectedDbName)); - Assert.That(exception.Message, Does.Contain("already exists")); - - Utils.DeleteDatabase(dbManager, db1); - Utils.CloseConnection(driver); - } - } -} From 0ae72e3d6c65f36d2c52a9eb91609935146e164e Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 20 Mar 2024 12:52:02 +0000 Subject: [PATCH 018/118] Fix rebase conflicts. --- .../Integration/Connection/ConnectionTest.cs | 149 ++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100644 csharp/Test/Integration/Connection/ConnectionTest.cs diff --git a/csharp/Test/Integration/Connection/ConnectionTest.cs b/csharp/Test/Integration/Connection/ConnectionTest.cs new file mode 100644 index 0000000000..b12de7c2c4 --- /dev/null +++ b/csharp/Test/Integration/Connection/ConnectionTest.cs @@ -0,0 +1,149 @@ +/* + * Copyright (C) 2022 Vaticle + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +using NUnit.Framework; +using System; +using System.Collections.Generic; + +using TypeDB.Driver; +using TypeDB.Driver.Api; +using TypeDB.Driver.Common; + +namespace TypeDB.Driver.Test.Integration +{ + public static class Utils + { + public static ITypeDBDriver OpenConnection() + { + ITypeDBDriver driver = TypeDB.CoreDriver(TypeDB.DEFAULT_ADDRESS); + Assert.IsNotNull(driver); + Assert.True(driver.IsOpen()); + + return driver; + } + + public static void CloseConnection(ITypeDBDriver driver) + { + driver.Close(); + Assert.False(driver.IsOpen()); + } + + public static void CreateDatabaseNoChecks(IDatabaseManager dbManager, string expectedDbName) + { + dbManager.Create(expectedDbName); + } + + public static IDatabase CreateAndGetDatabase( + IDatabaseManager dbManager, string expectedDbName, bool checkAbsence = true) + { + if (checkAbsence) + { + Assert.False(dbManager.Contains(expectedDbName)); + } + + CreateDatabaseNoChecks(dbManager, expectedDbName); + Assert.True(dbManager.Contains(expectedDbName)); + + IDatabase db = dbManager.Get(expectedDbName); + Assert.IsNotNull(db); + + string realDbName = db.Name; + Assert.AreEqual(expectedDbName, realDbName); + + return db; + } + + public static void DeleteDatabase(IDatabaseManager dbManager, IDatabase db) + { + string dbName = db.Name; + db.Delete(); + Assert.False(dbManager.Contains(dbName)); + } + + public static void CheckAllDatabases(IDatabaseManager dbManager, ICollection expectedDbNames) + { + var allDbs = dbManager.GetAll(); + Assert.AreEqual(expectedDbNames.Count, allDbs.Count); + + foreach (var db in allDbs) + { + Assert.True(expectedDbNames.Contains(db.Name)); + } + } + } + + [TestFixture] + public class ConnectionTestFixture + { + [Test] + public void OpenAndCloseConnection() + { + ITypeDBDriver driver = Utils.OpenConnection(); + Utils.CloseConnection(driver); + } + + [Test] + public void CreateAndDeleteAndRecreateDatabase() + { + string expectedDbName = "hello_from_csharp"; + + ITypeDBDriver driver = Utils.OpenConnection(); + IDatabaseManager dbManager = driver.Databases; + + Assert.Throws(() => dbManager.Contains("")); + Utils.CheckAllDatabases(dbManager, new HashSet()); + + IDatabase db1 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); + + Utils.CheckAllDatabases(dbManager, new HashSet(){expectedDbName}); + Assert.False(dbManager.Contains(expectedDbName + "1")); + Assert.False(dbManager.Contains(expectedDbName.Substring(1))); + Assert.False(dbManager.Contains(expectedDbName.Remove(expectedDbName.Length - 1))); + Assert.Throws(() => dbManager.Contains("")); + + Utils.DeleteDatabase(dbManager, db1); + + IDatabase db2 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); + + Utils.CheckAllDatabases(dbManager, new HashSet(){expectedDbName}); + Utils.DeleteDatabase(dbManager, db2); + Utils.CloseConnection(driver); + } + + [Test] + public void FailCreateTwoDatabasesWithSameName() + { + string expectedDbName = "hello_from_csharp"; + + ITypeDBDriver driver = Utils.OpenConnection(); + IDatabaseManager dbManager = driver.Databases; + + IDatabase db1 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); + + var exception = Assert.Throws( + () => Utils.CreateDatabaseNoChecks(dbManager, expectedDbName)); + Assert.That(exception.Message, Does.Contain("already exists")); + + Utils.DeleteDatabase(dbManager, db1); + Utils.CloseConnection(driver); + } + } +} From 4b40d1b82df27cf45ed082e8860b90c5f22f4445 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Fri, 15 Mar 2024 17:58:01 +0000 Subject: [PATCH 019/118] Fix conflicts for Quickstart and Examples tests. --- .../Integration/Connection/ConnectionTest.cs | 149 ------------------ 1 file changed, 149 deletions(-) delete mode 100644 csharp/Test/Integration/Connection/ConnectionTest.cs diff --git a/csharp/Test/Integration/Connection/ConnectionTest.cs b/csharp/Test/Integration/Connection/ConnectionTest.cs deleted file mode 100644 index b12de7c2c4..0000000000 --- a/csharp/Test/Integration/Connection/ConnectionTest.cs +++ /dev/null @@ -1,149 +0,0 @@ -/* - * Copyright (C) 2022 Vaticle - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -using NUnit.Framework; -using System; -using System.Collections.Generic; - -using TypeDB.Driver; -using TypeDB.Driver.Api; -using TypeDB.Driver.Common; - -namespace TypeDB.Driver.Test.Integration -{ - public static class Utils - { - public static ITypeDBDriver OpenConnection() - { - ITypeDBDriver driver = TypeDB.CoreDriver(TypeDB.DEFAULT_ADDRESS); - Assert.IsNotNull(driver); - Assert.True(driver.IsOpen()); - - return driver; - } - - public static void CloseConnection(ITypeDBDriver driver) - { - driver.Close(); - Assert.False(driver.IsOpen()); - } - - public static void CreateDatabaseNoChecks(IDatabaseManager dbManager, string expectedDbName) - { - dbManager.Create(expectedDbName); - } - - public static IDatabase CreateAndGetDatabase( - IDatabaseManager dbManager, string expectedDbName, bool checkAbsence = true) - { - if (checkAbsence) - { - Assert.False(dbManager.Contains(expectedDbName)); - } - - CreateDatabaseNoChecks(dbManager, expectedDbName); - Assert.True(dbManager.Contains(expectedDbName)); - - IDatabase db = dbManager.Get(expectedDbName); - Assert.IsNotNull(db); - - string realDbName = db.Name; - Assert.AreEqual(expectedDbName, realDbName); - - return db; - } - - public static void DeleteDatabase(IDatabaseManager dbManager, IDatabase db) - { - string dbName = db.Name; - db.Delete(); - Assert.False(dbManager.Contains(dbName)); - } - - public static void CheckAllDatabases(IDatabaseManager dbManager, ICollection expectedDbNames) - { - var allDbs = dbManager.GetAll(); - Assert.AreEqual(expectedDbNames.Count, allDbs.Count); - - foreach (var db in allDbs) - { - Assert.True(expectedDbNames.Contains(db.Name)); - } - } - } - - [TestFixture] - public class ConnectionTestFixture - { - [Test] - public void OpenAndCloseConnection() - { - ITypeDBDriver driver = Utils.OpenConnection(); - Utils.CloseConnection(driver); - } - - [Test] - public void CreateAndDeleteAndRecreateDatabase() - { - string expectedDbName = "hello_from_csharp"; - - ITypeDBDriver driver = Utils.OpenConnection(); - IDatabaseManager dbManager = driver.Databases; - - Assert.Throws(() => dbManager.Contains("")); - Utils.CheckAllDatabases(dbManager, new HashSet()); - - IDatabase db1 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); - - Utils.CheckAllDatabases(dbManager, new HashSet(){expectedDbName}); - Assert.False(dbManager.Contains(expectedDbName + "1")); - Assert.False(dbManager.Contains(expectedDbName.Substring(1))); - Assert.False(dbManager.Contains(expectedDbName.Remove(expectedDbName.Length - 1))); - Assert.Throws(() => dbManager.Contains("")); - - Utils.DeleteDatabase(dbManager, db1); - - IDatabase db2 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); - - Utils.CheckAllDatabases(dbManager, new HashSet(){expectedDbName}); - Utils.DeleteDatabase(dbManager, db2); - Utils.CloseConnection(driver); - } - - [Test] - public void FailCreateTwoDatabasesWithSameName() - { - string expectedDbName = "hello_from_csharp"; - - ITypeDBDriver driver = Utils.OpenConnection(); - IDatabaseManager dbManager = driver.Databases; - - IDatabase db1 = Utils.CreateAndGetDatabase(dbManager, expectedDbName); - - var exception = Assert.Throws( - () => Utils.CreateDatabaseNoChecks(dbManager, expectedDbName)); - Assert.That(exception.Message, Does.Contain("already exists")); - - Utils.DeleteDatabase(dbManager, db1); - Utils.CloseConnection(driver); - } - } -} From 24f5a9826bc2e8242332f890c8a90d8357f21d2a Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 20 Mar 2024 13:08:59 +0000 Subject: [PATCH 020/118] Fix conflicts. Rebase + resolve conflicts --- csharp/Test/Integration/Examples/ExamplesTest.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/csharp/Test/Integration/Examples/ExamplesTest.cs b/csharp/Test/Integration/Examples/ExamplesTest.cs index 7be8ff0aef..fd7548595c 100644 --- a/csharp/Test/Integration/Examples/ExamplesTest.cs +++ b/csharp/Test/Integration/Examples/ExamplesTest.cs @@ -39,7 +39,7 @@ private void ProcessPersonInsertResult( Assert.AreEqual(1, results.Length); var result = results[0]; - Assert.AreEqual(2, result.Variables.Count()); + Assert.AreEqual(2, result.GetVariables().Count()); Assert.AreEqual(2, result.Concepts.Count()); var entity = result.Get(variableName); From 2c2804527ddbec5ff05240ddf80dc948edcd11f9 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 20 Mar 2024 08:55:25 +0000 Subject: [PATCH 021/118] Fix references to doxygen --- c/BUILD | 2 +- cpp/BUILD | 2 +- csharp/BUILD | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/c/BUILD b/c/BUILD index 6eec5b7427..bea63314dd 100644 --- a/c/BUILD +++ b/c/BUILD @@ -22,7 +22,7 @@ load("@vaticle_dependencies//builder/rust:rules.bzl", "rust_cbindgen") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") load("@vaticle_bazel_distribution//common:rules.bzl", "assemble_targz", "assemble_zip", "checksum", "assemble_versioned") -load("@vaticle_bazel_distribution//docs:cpp/rules.bzl", "doxygen_docs") +load("@vaticle_bazel_distribution//docs:doxygen/rules.bzl", "doxygen_docs") load("@vaticle_bazel_distribution//artifact:rules.bzl", "deploy_artifact") load("@vaticle_dependencies//distribution:deployment.bzl", "deployment") load("@rules_pkg//:pkg.bzl", "pkg_tar") diff --git a/cpp/BUILD b/cpp/BUILD index 60d9bc994e..aeb7d4d782 100644 --- a/cpp/BUILD +++ b/cpp/BUILD @@ -18,7 +18,7 @@ load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") load("@vaticle_dependencies//builder/cpp:rules.bzl", "clang_format_test") load("@vaticle_bazel_distribution//common:rules.bzl", "assemble_targz", "assemble_zip", "checksum", "assemble_versioned") -load("@vaticle_bazel_distribution//docs:cpp/rules.bzl", "doxygen_docs") +load("@vaticle_bazel_distribution//docs:doxygen/rules.bzl", "doxygen_docs") load("@vaticle_bazel_distribution//artifact:rules.bzl", "deploy_artifact") load("@vaticle_dependencies//distribution:deployment.bzl", "deployment") load("@rules_pkg//:pkg.bzl", "pkg_tar") diff --git a/csharp/BUILD b/csharp/BUILD index 6329db506b..7f88c2e59c 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -16,7 +16,7 @@ # under the License. load("@rules_dotnet//dotnet:defs.bzl", "csharp_binary", "csharp_library") -load("@vaticle_bazel_distribution//docs:cpp/rules.bzl", "doxygen_docs") +load("@vaticle_bazel_distribution//docs:doxygen/rules.bzl", "doxygen_docs") load(":build_opts.bzl", "target_frameworks", "targeting_packs", "nullable_context") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") load(":rules.bzl", "swig_native_csharp_library") From c3522e45c0edf200548a39f738d556439dbc6fa6 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 20 Mar 2024 15:23:04 +0000 Subject: [PATCH 022/118] Prepare rule calls for the docs --- csharp/BUILD | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/csharp/BUILD b/csharp/BUILD index 7f88c2e59c..7a6340e3d8 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -20,7 +20,8 @@ load("@vaticle_bazel_distribution//docs:doxygen/rules.bzl", "doxygen_docs") load(":build_opts.bzl", "target_frameworks", "targeting_packs", "nullable_context") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") load(":rules.bzl", "swig_native_csharp_library") - +load("//csharp:docs_structure.bzl", "dir_mapping") +load("//tool/docs:cpp/rules.bzl", "doxygen_cpp_to_adoc") swig_native_csharp_library( name = "typedb_driver_pinvoke", @@ -75,6 +76,15 @@ doxygen_docs( ) +doxygen_cpp_to_adoc( + name = "docs_adoc", + data = [":docs_html"], + docs_dirs = dir_mapping, + output_dir = 'csharp/docs', + tags = ["manual"] +) + + checkstyle_test( name = "checkstyle", size = "small", From ca9bbd7e231e3227584d1ce7ba40da5508f70397 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 20 Mar 2024 15:47:43 +0000 Subject: [PATCH 023/118] Add template for csharp parser --- csharp/BUILD | 7 +- ...genParserCpp.kt => doxygenParserCsharp.kt} | 0 tool/docs/csharp/DoxygenParserCsharp.kt | 342 ++++++++++++++++++ tool/docs/csharp/rules.bzl | 44 +++ 4 files changed, 390 insertions(+), 3 deletions(-) rename tool/docs/cpp/{DoxygenParserCpp.kt => doxygenParserCsharp.kt} (100%) create mode 100644 tool/docs/csharp/DoxygenParserCsharp.kt create mode 100644 tool/docs/csharp/rules.bzl diff --git a/csharp/BUILD b/csharp/BUILD index 7a6340e3d8..2926106062 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -17,11 +17,12 @@ load("@rules_dotnet//dotnet:defs.bzl", "csharp_binary", "csharp_library") load("@vaticle_bazel_distribution//docs:doxygen/rules.bzl", "doxygen_docs") -load(":build_opts.bzl", "target_frameworks", "targeting_packs", "nullable_context") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") +load(":build_opts.bzl", "target_frameworks", "targeting_packs", "nullable_context") load(":rules.bzl", "swig_native_csharp_library") load("//csharp:docs_structure.bzl", "dir_mapping") -load("//tool/docs:cpp/rules.bzl", "doxygen_cpp_to_adoc") +load("//tool/docs:csharp/rules.bzl", "doxygen_csharp_to_adoc") + swig_native_csharp_library( name = "typedb_driver_pinvoke", @@ -76,7 +77,7 @@ doxygen_docs( ) -doxygen_cpp_to_adoc( +doxygen_csharp_to_adoc( name = "docs_adoc", data = [":docs_html"], docs_dirs = dir_mapping, diff --git a/tool/docs/cpp/DoxygenParserCpp.kt b/tool/docs/cpp/doxygenParserCsharp.kt similarity index 100% rename from tool/docs/cpp/DoxygenParserCpp.kt rename to tool/docs/cpp/doxygenParserCsharp.kt diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt new file mode 100644 index 0000000000..90edae4224 --- /dev/null +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -0,0 +1,342 @@ +/* + * Copyright (C) 2022 Vaticle + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package com.vaticle.typedb.driver.tool.docs.csharp + +import com.vaticle.typedb.driver.tool.docs.dataclasses.Class +import com.vaticle.typedb.driver.tool.docs.dataclasses.EnumConstant +import com.vaticle.typedb.driver.tool.docs.dataclasses.Method +import com.vaticle.typedb.driver.tool.docs.dataclasses.Variable +import com.vaticle.typedb.driver.tool.docs.util.* +import org.jsoup.Jsoup +import org.jsoup.nodes.Element +import picocli.CommandLine +import picocli.CommandLine.Parameters +import java.io.File +import java.nio.file.Files +import java.nio.file.Path +import java.nio.file.Paths +import java.util.concurrent.Callable +import kotlin.system.exitProcess + + +fun main(args: Array): Unit = exitProcess(CommandLine(DoxygenParserCsharp()).execute(*args)) + +@CommandLine.Command(name = "DoxygenParserCsharp", mixinStandardHelpOptions = true) +class DoxygenParserCsharp : Callable { + @Parameters(paramLabel = "", description = ["Input directory"]) + private lateinit var inputDirectoryNames: List + + @CommandLine.Option(names = ["--output", "-o"], required = true) + private lateinit var outputDirectoryName: String + + /** + * --dir=file=directory: put a file into the specified directory + * If no directory is specified for at least one file, an exception will be thrown. + */ + @CommandLine.Option(names = ["--dir", "-d"], required = true) + private lateinit var dirs: HashMap + + @Override + override fun call() { + val inputDirectoryName = inputDirectoryNames[0] + + val docsDir = System.getenv("BUILD_WORKSPACE_DIRECTORY")?.let { Paths.get(it).resolve(outputDirectoryName) } + ?: Paths.get(outputDirectoryName) + if (!docsDir.toFile().exists()) { + Files.createDirectory(docsDir) + } + val classes: MutableList = ArrayList() + // Namespace file for the enums & typedefs + run { + val namespacefile = File(inputDirectoryName).resolve("html/namespace_type_d_b.html") + assert(namespacefile.exists()) + val html = File(namespacefile.path).readText(Charsets.UTF_8) + val parsed = Jsoup.parse(html) + + // Typedefs + val typeDefFile = getFile(docsDir, "typedefs.adoc") + typeDefFile.writeText("") + val typeDefTBody = + parsed.select("tr.heading").first { element -> element.text().equals("Typedefs") }.parent()!! + typeDefTBody.select("tr").filter { tr -> + tr.className().startsWith("memitem") + }.map { + parseTypeDef(it!!) + }.forEach { + if (it.isNotEmpty()) typeDefFile.appendText(it.toAsciiDoc("cs")) + } + + // Enums + parsed.select("td.memname").filter { element -> + element.text().startsWith("enum") + }.map { element -> element.parents().select(".memitem").first() }.forEach { + val parsedEnum = parseEnum(it!!) + if (parsedEnum.isNotEmpty()) classes.add(parsedEnum) + } + } + + // class files + File(inputDirectoryName).walkTopDown().filter { + it.toString().startsWith("csharp/doxygen_docs/html/class_type_") && it.toString().endsWith(".html") + && !it.toString().contains("-members") + }.forEach { + val html = File(it.path).readText(Charsets.UTF_8) + val parsed = Jsoup.parse(html) + val parsedClass = parseClass(parsed) + if (parsedClass.isNotEmpty()) classes.add(parsedClass) + } + + classes.forEach { parsedClass -> + val parsedClassAsciiDoc = parsedClass.toAsciiDoc("cs") + val outputFile = getFile(docsDir, "${generateFilename(parsedClass.name)}.adoc") + outputFile.writeText(parsedClassAsciiDoc) + } + } + + private fun getFile(docsDir: Path, fileName: String): File { + val fileDir = docsDir.resolve( + dirs[fileName] + ?: throw IllegalArgumentException("Output directory for '$fileName' was not provided") + ) + if (!fileDir.toFile().exists()) { + Files.createDirectory(fileDir) + } + val outputFile = fileDir.resolve(fileName).toFile() + outputFile.createNewFile() + return outputFile + } + + private fun parseMemberDecls(document: Element): Pair>, Map> { + val missingDeclarations: MutableList = ArrayList() + val map: MutableMap> = HashMap() + val idToAnchor: MutableMap = HashMap() + document.select("table.memberdecls").forEach { table -> + val heading: String = table.selectFirst("tr.heading > td > h2 > a")!!.attr("name") + val members: MutableList = ArrayList() + table.select("tr").filter { element -> + element.className().matches(Regex("memitem:[a-f0-9]+")) + }.forEach { element -> + val id = element.className().substringAfter("memitem:") + val methodDetails = + document.selectFirst("div.contents > a#$id")?.nextElementSibling()?.nextElementSibling() + if (methodDetails == null) { + missingDeclarations.add(element.selectFirst("td.memItemRight")!!.text()) + } else { + members.add(methodDetails) + idToAnchor[id] = replaceSymbolsForAnchor(methodDetails.select("table.memname").text()) + } + } + map[heading] = members + } + if (missingDeclarations.isNotEmpty()) { + println("Missing some member declarations:\n\t-" + missingDeclarations.joinToString("\n\t-")) + } + return Pair(map, idToAnchor) + } + + private fun parseTypeDef(element: Element): Class { + val memItemLeft = element.selectFirst("td.memItemLeft") + if (memItemLeft != null) { + if (memItemLeft.text().startsWith("typedef")) { + val actual = element.selectFirst("td.memItemLeft")!!.text().substringAfter("typedef ") + val alias = element.selectFirst("td.memItemRight")!!.text() + return Class( + name = alias, + anchor = replaceSymbolsForAnchor(alias), + description = listOf("Alias for ${replaceLocalLinks(HashMap(), actual)}"), + ) + } else if (memItemLeft.text().startsWith("using")) { + val usingEquality = element.selectFirst("td.memItemRight")!! + val actual = usingEquality.text().substringAfter("=").trim() + val alias = usingEquality.text().substringBefore("=").trim() + return Class( + name = alias, + anchor = replaceSymbolsForAnchor(alias), + description = listOf("Alias for $actual") + ) + } + } + return Class("") + } + + private fun parseClass(document: Element): Class { + // If we want inherited members, consider doxygen's INLINE_INHERITED_MEMB instead of the javadoc approach + val fullyQualifiedName = document.selectFirst("div .title")!!.text() + .replace(Regex("Class(?: Template)? Reference.*"), "").trim() + val packagePath = fullyQualifiedName.substringBeforeLast("::") + val className = fullyQualifiedName.substringAfterLast("::") + val classAnchor = replaceSymbolsForAnchor(className) + val classExamples = document.select("div.textblock > pre").map { replaceSpaces(it.text()) } + val superClasses = document.select("tr.inherit_header") + .map { it.text().substringAfter("inherited from ") } + .toSet().toList() + + val (memberDecls, idToAnchor) = parseMemberDecls(document) + val classDescr: List = document.selectFirst("div.textblock") + ?.let { splitToParagraphs(it.html()) }?.map { reformatTextWithCode(it.substringBefore(" = ( + memberDecls.getOrDefault("pub-methods", listOf()) + + memberDecls.getOrDefault("pub-static-methods", listOf()) + ).map { + parseMethod(it, idToAnchor) + } + + return Class( + name = className, + anchor = classAnchor, + description = classDescr, + examples = classExamples, + fields = fields, + methods = methods, + packagePath = packagePath, + superClasses = superClasses, + ) + } + + private fun parseEnum(element: Element): Class { + val id = element.previousElementSibling()?.previousElementSibling()?.id()!! + val fullyQualifiedName = element.select("td.memname > a").text() + val className = fullyQualifiedName.substringAfterLast("::") + val classAnchor = replaceSymbolsForAnchor(className) + val classDescr: List = element.selectFirst("div.memdoc") + ?.let { splitToParagraphs(it.html()) }?.map { reformatTextWithCode(it.substringBefore(" pre").map { replaceSpaces(it.text()) } + val enumConstants = + element.parents().select("div.contents").first()!! + .select("table.memberdecls > tbody > tr[class=memitem:$id] > td.memItemRight ").first()!! + .text().substringAfter("{").substringBefore("}") + .split(",") + .map { + EnumConstant(it.trim()) + } + val packagePath = fullyQualifiedName.substringBeforeLast("::") + return Class( + name = className, + anchor = classAnchor, + description = classDescr, + enumConstants = enumConstants, + examples = classExamples, + packagePath = packagePath, + ) + } + + private fun parseMethod(element: Element, idToAnchor: Map): Method { + val id = element.previousElementSibling()?.previousElementSibling()?.id()!! + val methodAnchor = idToAnchor[id] + val methodName = element.previousElementSibling()!!.text().substringBefore("()").substringAfter(" ") + val methodSignature = enhanceSignature(element.selectFirst("table.memname")!!.text()) + val argsList = getArgsFromSignature(methodSignature) + val argsMap = argsList.toMap() + val methodReturnType = getReturnTypeFromSignature(methodSignature) + val methodDescr: List = element.selectFirst("div.memdoc") + ?.let { splitToParagraphs(it.html()) } + ?.map { replaceSpaces(reformatTextWithCode(it.substringBefore(" pre + div pre").map { replaceSpaces(it.text()) } + + val methodArgs = element.select("table.params > tbody > tr") + .map { + val argName = it.child(0).text() + assert(argsMap.contains(argName)) + Variable( + name = argName, + type = argsMap[argName], + description = reformatTextWithCode(it.child(1).html(), idToAnchor), + ) + } + + return Method( + name = methodName, + signature = methodSignature, + anchor = methodAnchor, + args = methodArgs, + description = methodDescr, + examples = methodExamples, + returnType = methodReturnType, + ) + + } + + private fun parseField(element: Element, idToAnchor: Map): Variable { + val type = element.selectFirst("td.memname")!!.text().substringBeforeLast("::") + val name = element.selectFirst("td.memname")!!.text().substringAfterLast("::") + val descr = reformatTextWithCode(element.selectFirst("div.memdoc")!!.html(), idToAnchor) + return Variable( + name = name, + description = descr, + type = type, + ) + } + + private fun getArgsFromSignature(methodSignature: String): List> { + return methodSignature + .replace("\\s+".toRegex(), " ") + .substringAfter("(").substringBefore(")") + .split(",\\s".toRegex()).map { arg -> + arg.split("\u00a0").let { it.last() to it.dropLast(1).joinToString(" ") } + }.filter { it.first.isNotEmpty() || it.second.isNotEmpty() } + .toList() + } + + private fun reformatTextWithCode(html: String, idToAnchor: Map): String { + return removeAllTags(replaceLocalLinks(idToAnchor, replaceEmTags(replacePreTags(replaceCodeTags(html))))) + } + + private fun replacePreTags(html: String): String { + return html.replace("
", "[source,java]\n----\n").replace("
", "\n----\n") + } + + private fun enhanceSignature(signature: String): String { + var enhanced = replaceSpaces(signature) + enhanced = enhanced.replace("( ", "(") + enhanced = Regex("\\s([()*&])").replace(enhanced, "$1") + return enhanced + } + + private fun getReturnTypeFromSignature(signature: String): String { + return signature.replace(", ", ",").replace("< ", "<").replace(" >", ">") + .substringBefore("(").substringBeforeLast(" ") + .replace(",", ", ").replace("<", "< ").replace(">", " >") + } + + private fun splitToParagraphs(html: String): List { + return html.replace("

", "").split("\\s*

\\s*".toRegex()).map { it.trim() } + } + + + private fun replaceLocalLinks(idToAnchor: Map, html: String): String { + // The Intellij preview messes up nested templates & The '>>' used for cross links. + return Regex("([^<]*)") + .replace(html) { + if (idToAnchor.containsKey(it.groupValues[1])) + "<<#_%s,%s>>".format(idToAnchor[it.groupValues[1]], it.groupValues[2]) + else "%s".format(it.groupValues[2]) + } + } + + private fun generateFilename(className: String): String { + return className.replace("[<> ,]".toRegex(), "_") + } +} diff --git a/tool/docs/csharp/rules.bzl b/tool/docs/csharp/rules.bzl new file mode 100644 index 0000000000..9d02f5d5da --- /dev/null +++ b/tool/docs/csharp/rules.bzl @@ -0,0 +1,44 @@ +# +# Copyright (C) 2022 Vaticle +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +load("@io_bazel_rules_kotlin//kotlin:jvm.bzl", "kt_jvm_binary") + +def doxygen_csharp_to_adoc(name, data, docs_dirs, output_dir, args = [], **kwargs): + extended_args = ["$(location %s)" % target for target in data] + [ + "--output", + output_dir, + ] + ["--dir=%s=%s" % (filename, docs_dirs[filename]) for filename in docs_dirs] + args + kt_jvm_binary( + name = name, + srcs = [ + "//tool/docs:csharp/DoxygenParserCsharp.kt", + ], + main_class = "com.vaticle.typedb.driver.tool.docs.csharp.DoxygenParserCsharpKt", + args = extended_args, + deps = [ + "//tool/docs:html_docs_to_adoc_lib", + "@maven//:org_jsoup_jsoup", + "@maven//:info_picocli_picocli", + ], + data = data, + visibility = ["//visibility:public"], + **kwargs + ) From cbc0e1f14647fe8935ae5703f23f47877b844b05 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 20 Mar 2024 16:08:27 +0000 Subject: [PATCH 024/118] Fix cpp parser --- tool/docs/cpp/{doxygenParserCsharp.kt => DoxygenParserCpp.kt} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename tool/docs/cpp/{doxygenParserCsharp.kt => DoxygenParserCpp.kt} (100%) diff --git a/tool/docs/cpp/doxygenParserCsharp.kt b/tool/docs/cpp/DoxygenParserCpp.kt similarity index 100% rename from tool/docs/cpp/doxygenParserCsharp.kt rename to tool/docs/cpp/DoxygenParserCpp.kt From d6345bf464aba694b55a3745c95c10cf53e7449c Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 20 Mar 2024 16:47:07 +0000 Subject: [PATCH 025/118] Fix parser to just get anything --- ...B.Driver.Api.IConceptMap.IExplainable.adoc | 9 + ....Driver.Api.IConceptMap.IExplainables.adoc | 142 ++++ .../answer/TypeDB.Driver.Api.IConceptMap.adoc | 72 ++ .../TypeDB.Driver.Api.IConceptMapGroup.adoc | 29 + .../TypeDB.Driver.Api.IExplanation.adoc | 55 ++ .../answer/TypeDB.Driver.Api.IValueGroup.adoc | 9 + .../TypeDB.Driver.Common.Promise__T__.adoc | 86 ++ .../TypeDB.Driver.Common.VoidPromise.adoc | 63 ++ csharp/docs/answer/typedefs.adoc | 0 .../concept/TypeDB.Driver.Api.IConcept.adoc | 426 ++++++++++ .../TypeDB.Driver.Api.IConceptManager.adoc | 264 +++++++ .../TypeDB.Driver.Api.IDatabase.IReplica.adoc | 44 ++ ...Database.IReplica_Interface_Reference.adoc | 44 ++ .../TypeDB.Driver.Api.IDatabase.adoc | 93 +++ .../TypeDB.Driver.Api.IDatabaseManager.adoc | 107 +++ .../TypeDB.Driver.Api.ITypeDBDriver.adoc | 111 +++ .../connection/TypeDB.Driver.Api.IUser.adoc | 57 ++ .../TypeDB.Driver.Api.IUserManager.adoc | 161 ++++ .../TypeDB.Driver.Api.TypeDBCredential.adoc | 118 +++ .../data/TypeDB.Driver.Api.IAttribute.adoc | 110 +++ .../docs/data/TypeDB.Driver.Api.IEntity.adoc | 55 ++ .../data/TypeDB.Driver.Api.IRelation.adoc | 190 +++++ .../docs/data/TypeDB.Driver.Api.IThing.adoc | 280 +++++++ .../docs/data/TypeDB.Driver.Api.IValue.adoc | 241 ++++++ ...B.Driver.Common.TypeDBDriverException.adoc | 93 +++ .../TypeDB.Driver.Api.ILogicManager.adoc | 83 ++ .../docs/logic/TypeDB.Driver.Api.IRule.adoc | 91 +++ .../TypeDB.Driver.Api.IAttributeType.adoc | 746 ++++++++++++++++++ .../schema/TypeDB.Driver.Api.IEntityType.adoc | 113 +++ .../TypeDB.Driver.Api.IRelationType.adoc | 369 +++++++++ .../schema/TypeDB.Driver.Api.IRoleType.adoc | 238 ++++++ ...peDB.Driver.Api.IThingType.Annotation.adoc | 139 ++++ .../schema/TypeDB.Driver.Api.IThingType.adoc | 693 ++++++++++++++++ .../docs/schema/TypeDB.Driver.Api.IType.adoc | 270 +++++++ .../TypeDB.Driver.Api.ITypeDBSession.adoc | 145 ++++ .../TypeDB.Driver.Api.TypeDBOptions.adoc | 459 +++++++++++ ...peDB.Driver.Api.IThingType.Annotation.adoc | 139 ++++ .../TypeDB.Driver.Api.IQueryManager.adoc | 573 ++++++++++++++ .../TypeDB.Driver.Api.ITypeDBTransaction.adoc | 102 +++ csharp/docs_structure.bzl | 67 ++ tool/docs/csharp/DoxygenParserCsharp.kt | 36 +- 41 files changed, 7092 insertions(+), 30 deletions(-) create mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainable.adoc create mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainables.adoc create mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc create mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IConceptMapGroup.adoc create mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc create mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IValueGroup.adoc create mode 100644 csharp/docs/answer/TypeDB.Driver.Common.Promise__T__.adoc create mode 100644 csharp/docs/answer/TypeDB.Driver.Common.VoidPromise.adoc create mode 100644 csharp/docs/answer/typedefs.adoc create mode 100644 csharp/docs/concept/TypeDB.Driver.Api.IConcept.adoc create mode 100644 csharp/docs/concept/TypeDB.Driver.Api.IConceptManager.adoc create mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc create mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica_Interface_Reference.adoc create mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IDatabase.adoc create mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IDatabaseManager.adoc create mode 100644 csharp/docs/connection/TypeDB.Driver.Api.ITypeDBDriver.adoc create mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc create mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc create mode 100644 csharp/docs/connection/TypeDB.Driver.Api.TypeDBCredential.adoc create mode 100644 csharp/docs/data/TypeDB.Driver.Api.IAttribute.adoc create mode 100644 csharp/docs/data/TypeDB.Driver.Api.IEntity.adoc create mode 100644 csharp/docs/data/TypeDB.Driver.Api.IRelation.adoc create mode 100644 csharp/docs/data/TypeDB.Driver.Api.IThing.adoc create mode 100644 csharp/docs/data/TypeDB.Driver.Api.IValue.adoc create mode 100644 csharp/docs/errors/TypeDB.Driver.Common.TypeDBDriverException.adoc create mode 100644 csharp/docs/logic/TypeDB.Driver.Api.ILogicManager.adoc create mode 100644 csharp/docs/logic/TypeDB.Driver.Api.IRule.adoc create mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IAttributeType.adoc create mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IEntityType.adoc create mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc create mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IRoleType.adoc create mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc create mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IThingType.adoc create mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IType.adoc create mode 100644 csharp/docs/session/TypeDB.Driver.Api.ITypeDBSession.adoc create mode 100644 csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc create mode 100644 csharp/docs/test/TypeDB.Driver.Api.IThingType.Annotation.adoc create mode 100644 csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc create mode 100644 csharp/docs/transaction/TypeDB.Driver.Api.ITypeDBTransaction.adoc create mode 100644 csharp/docs_structure.bzl diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainable.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainable.adoc new file mode 100644 index 0000000000..dbd5b20e24 --- /dev/null +++ b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainable.adoc @@ -0,0 +1,9 @@ +[#_TypeDB_Driver_Api_IConceptMap_IExplainable_Interface_Reference] +=== TypeDB.Driver.Api.IConceptMap.IExplainable Interface Reference + +*Package*: `TypeDB.Driver.Api.IConceptMap.IExplainable Interface Reference` + + + +Contains an explainable object. + diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainables.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainables.adoc new file mode 100644 index 0000000000..b9d88a1233 --- /dev/null +++ b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainables.adoc @@ -0,0 +1,142 @@ +[#_TypeDB_Driver_Api_IConceptMap_IExplainables_Interface_Reference] +=== TypeDB.Driver.Api.IConceptMap.IExplainables Interface Reference + +*Package*: `TypeDB.Driver.Api.IConceptMap.IExplainables Interface Reference` + + + +Contains explainable objects. + +// tag::methods[] +[#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Attribute___string_variable_] +==== Attribute + +[source,cs] +---- +IExplainable TypeDB.Driver.Api.IConceptMap.IExplainables.Attribute(string variable) +---- + + + +Retrieves the explainable attribute with the given variable name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `variable` a| The string representation of a variable a| +|=== + +[caption=""] +.Returns +`IExplainable` + +[#_IEnumerable__KeyValuePair__string__IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetAttributes___] +==== GetAttributes + +[source,cs] +---- +IEnumerable< KeyValuePair< string, IExplainable > > TypeDB.Driver.Api.IConceptMap.IExplainables.GetAttributes() +---- + + + +Retrieves all of this ``IConceptMap``’s explainable attributes. + + +[caption=""] +.Returns +`IEnumerable< KeyValuePair< string, IExplainable > >` + +[#_IEnumerable__KeyValuePair__KeyValuePair__string__string____IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetOwnerships___] +==== GetOwnerships + +[source,cs] +---- +IEnumerable< KeyValuePair< KeyValuePair< string, string >, IExplainable > > TypeDB.Driver.Api.IConceptMap.IExplainables.GetOwnerships() +---- + + + +Retrieves all of this ``IConceptMap``’s explainable ownerships. + + +[caption=""] +.Returns +`IEnumerable< KeyValuePair< KeyValuePair< string, string >, IExplainable > >` + +[#_IEnumerable__KeyValuePair__string__IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetRelations___] +==== GetRelations + +[source,cs] +---- +IEnumerable< KeyValuePair< string, IExplainable > > TypeDB.Driver.Api.IConceptMap.IExplainables.GetRelations() +---- + + + +Retrieves all of this ``IConceptMap``’s explainable relations. + + +[caption=""] +.Returns +`IEnumerable< KeyValuePair< string, IExplainable > >` + +[#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Ownership___string_owner__string_attribute_] +==== Ownership + +[source,cs] +---- +IExplainable TypeDB.Driver.Api.IConceptMap.IExplainables.Ownership(string owner, string attribute) +---- + + + +Retrieves the explainable attribute ownership with the pair of (owner, attribute) variable names. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `owner` a| The string representation of the owner variable a| +a| `attribute` a| The string representation of the attribute variable a| +|=== + +[caption=""] +.Returns +`IExplainable` + +[#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Relation___string_variable_] +==== Relation + +[source,cs] +---- +IExplainable TypeDB.Driver.Api.IConceptMap.IExplainables.Relation(string variable) +---- + + + +Retrieves the explainable relation with the given variable name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `variable` a| The string representation of a variable a| +|=== + +[caption=""] +.Returns +`IExplainable` + +// end::methods[] + diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc new file mode 100644 index 0000000000..abb01c1bb2 --- /dev/null +++ b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc @@ -0,0 +1,72 @@ +[#_TypeDB_Driver_Api_IConceptMap_Interface_Reference] +=== TypeDB.Driver.Api.IConceptMap Interface Reference + +*Package*: `TypeDB.Driver.Api.IConceptMap Interface Reference` + + + +Contains a mapping of variables to concepts. + +// tag::methods[] +[#_IConcept_TypeDB_Driver_Api_IConceptMap_Get___string_variable_] +==== Get + +[source,cs] +---- +IConcept TypeDB.Driver.Api.IConceptMap.Get(string variable) +---- + + + +Retrieves a concept for a given variable name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `variable` a| The string representation of a variable a| +|=== + +[caption=""] +.Returns +`IConcept` + +[#_Dictionary__string__IConcept___TypeDB_Driver_Api_IConceptMap_GetMap___] +==== GetMap + +[source,cs] +---- +Dictionary< string, IConcept > TypeDB.Driver.Api.IConceptMap.GetMap() +---- + + + +Returns the inner ``Dictionary`` (``Map`` as a common TypeDB term) where keys are query variables, and values are concepts. + + +[caption=""] +.Returns +`Dictionary< string, IConcept >` + +[#_IEnumerable__string___TypeDB_Driver_Api_IConceptMap_GetVariables___] +==== GetVariables + +[source,cs] +---- +IEnumerable< string > TypeDB.Driver.Api.IConceptMap.GetVariables() +---- + + + +Returns a collection of all variables in this ``IConceptMap``. + + +[caption=""] +.Returns +`IEnumerable< string >` + +// end::methods[] + diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMapGroup.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMapGroup.adoc new file mode 100644 index 0000000000..dc83706ef7 --- /dev/null +++ b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMapGroup.adoc @@ -0,0 +1,29 @@ +[#_TypeDB_Driver_Api_IConceptMapGroup_Interface_Reference] +=== TypeDB.Driver.Api.IConceptMapGroup Interface Reference + +*Package*: `TypeDB.Driver.Api.IConceptMapGroup Interface Reference` + + + +Contains an element of the group query result. + +// tag::methods[] +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IConceptMapGroup_GetConceptMaps___] +==== GetConceptMaps + +[source,cs] +---- +IEnumerable< IConceptMap > TypeDB.Driver.Api.IConceptMapGroup.GetConceptMaps() +---- + + + +Retrieves the ``IConceptMap``s of the group. + + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +// end::methods[] + diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc new file mode 100644 index 0000000000..0ac7838b7a --- /dev/null +++ b/csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc @@ -0,0 +1,55 @@ +[#_TypeDB_Driver_Api_IExplanation_Interface_Reference] +=== TypeDB.Driver.Api.IExplanation Interface Reference + +*Package*: `TypeDB.Driver.Api.IExplanation Interface Reference` + + + +An explanation of which rule was used for inferring the explained concept, the condition of the rule, the conclusion of the rule, and the mapping of variables between the query and the rule’s conclusion. + +// tag::methods[] +[#_ISet__string___TypeDB_Driver_Api_IExplanation_GetQueryVariables___] +==== GetQueryVariables + +[source,cs] +---- +ISet< string > TypeDB.Driver.Api.IExplanation.GetQueryVariables() +---- + + + +Retrieves the query variables for this ``Explanation``. + + +[caption=""] +.Returns +`ISet< string >` + +[#_ISet__string___TypeDB_Driver_Api_IExplanation_QueryVariableMapping___string_variable_] +==== QueryVariableMapping + +[source,cs] +---- +ISet< string > TypeDB.Driver.Api.IExplanation.QueryVariableMapping(string variable) +---- + + + +Retrieves the rule variables corresponding to the query variable var for this ``Explanation``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `variable` a| The query variable to map to rule variables. a| +|=== + +[caption=""] +.Returns +`ISet< string >` + +// end::methods[] + diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IValueGroup.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IValueGroup.adoc new file mode 100644 index 0000000000..78fc162e4f --- /dev/null +++ b/csharp/docs/answer/TypeDB.Driver.Api.IValueGroup.adoc @@ -0,0 +1,9 @@ +[#_TypeDB_Driver_Api_IValueGroup_Interface_Reference] +=== TypeDB.Driver.Api.IValueGroup Interface Reference + +*Package*: `TypeDB.Driver.Api.IValueGroup Interface Reference` + + + +Contains an element of the group aggregate query result. + diff --git a/csharp/docs/answer/TypeDB.Driver.Common.Promise__T__.adoc b/csharp/docs/answer/TypeDB.Driver.Common.Promise__T__.adoc new file mode 100644 index 0000000000..0d7b8cbf68 --- /dev/null +++ b/csharp/docs/answer/TypeDB.Driver.Common.Promise__T__.adoc @@ -0,0 +1,86 @@ +[#_TypeDB_Driver_Common_Promise__T_] +=== TypeDB.Driver.Common.Promise< T > + +*Package*: `TypeDB.Driver.Common.Promise< T >` + + + +A ``Promise`` represents an asynchronous network operation. + +The request it represents is performed immediately. The response is only retrieved once the ``Promise`` is ``Resolve``d. + +. + +// tag::methods[] +[#_static_Promise__TTo___TypeDB_Driver_Common_Promise__T___Map__TFrom__TTo_____Func__TFrom__resolver__Func__TFrom__TTo___selector_] +==== Map< TFrom, TTo > + +[source,cs] +---- +static Promise< TTo > TypeDB.Driver.Common.Promise< T >.Map< TFrom, TTo >(Func< TFrom?> resolver, Func< TFrom, TTo > selector) +---- + + + +Helper function to map promises. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `promise` a| The function to wrap into the promise a| +a| `fn` a| The mapping function a| +|=== + +[caption=""] +.Returns +`static Promise< TTo >` + +[#_TypeDB_Driver_Common_Promise__T___Promise___Func__T__resolver_] +==== Promise + +[source,cs] +---- +TypeDB.Driver.Common.Promise< T >.Promise(Func< T?> resolver) +---- + + + +Promise constructor + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `promise` a| The function to wrap into the promise a| +|=== + +[caption=""] +.Returns +`TypeDB.Driver.Common.Promise< T >.Promise` + +[#_T_TypeDB_Driver_Common_Promise__T___Resolve___] +==== Resolve + +[source,cs] +---- +T? TypeDB.Driver.Common.Promise< T >.Resolve() +---- + + + +Retrieves the result of the Promise. + + +[caption=""] +.Returns +`T?` + +// end::methods[] + diff --git a/csharp/docs/answer/TypeDB.Driver.Common.VoidPromise.adoc b/csharp/docs/answer/TypeDB.Driver.Common.VoidPromise.adoc new file mode 100644 index 0000000000..2ae20ce4f5 --- /dev/null +++ b/csharp/docs/answer/TypeDB.Driver.Common.VoidPromise.adoc @@ -0,0 +1,63 @@ +[#_TypeDB_Driver_Common_VoidPromise] +=== TypeDB.Driver.Common.VoidPromise + +*Package*: `TypeDB.Driver.Common.VoidPromise` + + + +A ``VoidPromise`` represents a ``Promise`` without an operation's result. + + + See also + + + Promise + + + +// tag::methods[] +[#_void_TypeDB_Driver_Common_VoidPromise_Resolve___] +==== Resolve + +[source,cs] +---- +void TypeDB.Driver.Common.VoidPromise.Resolve() +---- + + + +Retrieves the result of the Promise. + + +[caption=""] +.Returns +`void` + +[#_TypeDB_Driver_Common_VoidPromise_VoidPromise___Action_resolver_] +==== VoidPromise + +[source,cs] +---- +TypeDB.Driver.Common.VoidPromise.VoidPromise(Action resolver) +---- + + + +Promise constructor + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `promise` a| The function to wrap into the promise a| +|=== + +[caption=""] +.Returns +`TypeDB.Driver.Common.VoidPromise.VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/answer/typedefs.adoc b/csharp/docs/answer/typedefs.adoc new file mode 100644 index 0000000000..e69de29bb2 diff --git a/csharp/docs/concept/TypeDB.Driver.Api.IConcept.adoc b/csharp/docs/concept/TypeDB.Driver.Api.IConcept.adoc new file mode 100644 index 0000000000..7df5f2329e --- /dev/null +++ b/csharp/docs/concept/TypeDB.Driver.Api.IConcept.adoc @@ -0,0 +1,426 @@ +[#_TypeDB_Driver_Api_IConcept_Interface_Reference] +=== TypeDB.Driver.Api.IConcept Interface Reference + +*Package*: `TypeDB.Driver.Api.IConcept Interface Reference` + +// tag::methods[] +[#_IAttribute_TypeDB_Driver_Api_IConcept_AsAttribute___] +==== AsAttribute + +[source,cs] +---- +IAttribute TypeDB.Driver.Api.IConcept.AsAttribute() +---- + + + +Casts the concept to ``IAttribute``. + + +Implemented in TypeDB.Driver.Api.IAttribute. + +[caption=""] +.Returns +`IAttribute` + +[#_IAttributeType_TypeDB_Driver_Api_IConcept_AsAttributeType___] +==== AsAttributeType + +[source,cs] +---- +IAttributeType TypeDB.Driver.Api.IConcept.AsAttributeType() +---- + + + +Casts the concept to ``IAttributeType``. + + +Implemented in TypeDB.Driver.Api.IAttributeType. + +[caption=""] +.Returns +`IAttributeType` + +[#_IEntity_TypeDB_Driver_Api_IConcept_AsEntity___] +==== AsEntity + +[source,cs] +---- +IEntity TypeDB.Driver.Api.IConcept.AsEntity() +---- + + + +Casts the concept to ``IEntity``. + + +Implemented in TypeDB.Driver.Api.IEntity. + +[caption=""] +.Returns +`IEntity` + +[#_IEntityType_TypeDB_Driver_Api_IConcept_AsEntityType___] +==== AsEntityType + +[source,cs] +---- +IEntityType TypeDB.Driver.Api.IConcept.AsEntityType() +---- + + + +Casts the concept to ``IEntityType``. + + +Implemented in TypeDB.Driver.Api.IEntityType. + +[caption=""] +.Returns +`IEntityType` + +[#_IRelation_TypeDB_Driver_Api_IConcept_AsRelation___] +==== AsRelation + +[source,cs] +---- +IRelation TypeDB.Driver.Api.IConcept.AsRelation() +---- + + + +Casts the concept to ``IRelation``. + + +Implemented in TypeDB.Driver.Api.IRelation. + +[caption=""] +.Returns +`IRelation` + +[#_IRelationType_TypeDB_Driver_Api_IConcept_AsRelationType___] +==== AsRelationType + +[source,cs] +---- +IRelationType TypeDB.Driver.Api.IConcept.AsRelationType() +---- + + + +Casts the concept to ``IRelationType``. + + +Implemented in TypeDB.Driver.Api.IRelationType. + +[caption=""] +.Returns +`IRelationType` + +[#_IRoleType_TypeDB_Driver_Api_IConcept_AsRoleType___] +==== AsRoleType + +[source,cs] +---- +IRoleType TypeDB.Driver.Api.IConcept.AsRoleType() +---- + + + +Casts the concept to ``IRoleType``. + + +Implemented in TypeDB.Driver.Api.IRoleType. + +[caption=""] +.Returns +`IRoleType` + +[#_IThing_TypeDB_Driver_Api_IConcept_AsThing___] +==== AsThing + +[source,cs] +---- +IThing TypeDB.Driver.Api.IConcept.AsThing() +---- + + + +Casts the concept to ``IThing``. + + +Implemented in TypeDB.Driver.Api.IThing. + +[caption=""] +.Returns +`IThing` + +[#_IThingType_TypeDB_Driver_Api_IConcept_AsThingType___] +==== AsThingType + +[source,cs] +---- +IThingType TypeDB.Driver.Api.IConcept.AsThingType() +---- + + + +Casts the concept to ``IThingType``. + + +Implemented in TypeDB.Driver.Api.IThingType. + +[caption=""] +.Returns +`IThingType` + +[#_IType_TypeDB_Driver_Api_IConcept_AsType___] +==== AsType + +[source,cs] +---- +IType TypeDB.Driver.Api.IConcept.AsType() +---- + + + +Casts the concept to ``IType``. + + +Implemented in TypeDB.Driver.Api.IType. + +[caption=""] +.Returns +`IType` + +[#_IValue_TypeDB_Driver_Api_IConcept_AsValue___] +==== AsValue + +[source,cs] +---- +IValue TypeDB.Driver.Api.IConcept.AsValue() +---- + + + +Casts the concept to ``IValue``. + + +Implemented in TypeDB.Driver.Api.IValue. + +[caption=""] +.Returns +`IValue` + +[#_bool_TypeDB_Driver_Api_IConcept_IsAttribute___] +==== IsAttribute + +[source,cs] +---- +bool TypeDB.Driver.Api.IConcept.IsAttribute() +---- + + + +Checks if the concept is an ``IAttribute``. + + +Implemented in TypeDB.Driver.Api.IAttribute. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsAttributeType___] +==== IsAttributeType + +[source,cs] +---- +bool TypeDB.Driver.Api.IConcept.IsAttributeType() +---- + + + +Checks if the concept is an ``IAttributeType``. + + +Implemented in TypeDB.Driver.Api.IAttributeType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsEntity___] +==== IsEntity + +[source,cs] +---- +bool TypeDB.Driver.Api.IConcept.IsEntity() +---- + + + +Checks if the concept is an ``IEntity``. + + +Implemented in TypeDB.Driver.Api.IEntity. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsEntityType___] +==== IsEntityType + +[source,cs] +---- +bool TypeDB.Driver.Api.IConcept.IsEntityType() +---- + + + +Checks if the concept is an ``IEntityType``. + + +Implemented in TypeDB.Driver.Api.IEntityType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsRelation___] +==== IsRelation + +[source,cs] +---- +bool TypeDB.Driver.Api.IConcept.IsRelation() +---- + + + +Checks if the concept is a ``IRelation``. + + +Implemented in TypeDB.Driver.Api.IRelation. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsRelationType___] +==== IsRelationType + +[source,cs] +---- +bool TypeDB.Driver.Api.IConcept.IsRelationType() +---- + + + +Checks if the concept is a ``IRelationType``. + + +Implemented in TypeDB.Driver.Api.IRelationType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsRoleType___] +==== IsRoleType + +[source,cs] +---- +bool TypeDB.Driver.Api.IConcept.IsRoleType() +---- + + + +Checks if the concept is a ``IRoleType``. + + +Implemented in TypeDB.Driver.Api.IRoleType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsThing___] +==== IsThing + +[source,cs] +---- +bool TypeDB.Driver.Api.IConcept.IsThing() +---- + + + +Checks if the concept is a ``IThing``. + + +Implemented in TypeDB.Driver.Api.IThing. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsThingType___] +==== IsThingType + +[source,cs] +---- +bool TypeDB.Driver.Api.IConcept.IsThingType() +---- + + + +Checks if the concept is a ``IThingType``. + + +Implemented in TypeDB.Driver.Api.IThingType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsType___] +==== IsType + +[source,cs] +---- +bool TypeDB.Driver.Api.IConcept.IsType() +---- + + + +Checks if the concept is a ``IType``. + + +Implemented in TypeDB.Driver.Api.IType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsValue___] +==== IsValue + +[source,cs] +---- +bool TypeDB.Driver.Api.IConcept.IsValue() +---- + + + +Checks if the concept is a ``IValue``. + + +Implemented in TypeDB.Driver.Api.IValue. + +[caption=""] +.Returns +`bool` + +// end::methods[] + diff --git a/csharp/docs/concept/TypeDB.Driver.Api.IConceptManager.adoc b/csharp/docs/concept/TypeDB.Driver.Api.IConceptManager.adoc new file mode 100644 index 0000000000..e6e8128d07 --- /dev/null +++ b/csharp/docs/concept/TypeDB.Driver.Api.IConceptManager.adoc @@ -0,0 +1,264 @@ +[#_TypeDB_Driver_Api_IConceptManager_Interface_Reference] +=== TypeDB.Driver.Api.IConceptManager Interface Reference + +*Package*: `TypeDB.Driver.Api.IConceptManager Interface Reference` + + + +Provides access for all Concept API methods. + +// tag::methods[] +[#_Promise__IAttribute___TypeDB_Driver_Api_IConceptManager_GetAttribute___string_iid_] +==== GetAttribute + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IConceptManager.GetAttribute(string iid) +---- + + + +Retrieves an ``IAttribute`` by its iid. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `iid` a| The iid of the ``Attribute`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttributeType___TypeDB_Driver_Api_IConceptManager_GetAttributeType___string_label_] +==== GetAttributeType + +[source,cs] +---- +Promise< IAttributeType > TypeDB.Driver.Api.IConceptManager.GetAttributeType(string label) +---- + + + +Retrieves an ``IAttributeType`` by its label. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``AttributeType`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IAttributeType >` + +[#_Promise__IEntity___TypeDB_Driver_Api_IConceptManager_GetEntity___string_iid_] +==== GetEntity + +[source,cs] +---- +Promise< IEntity > TypeDB.Driver.Api.IConceptManager.GetEntity(string iid) +---- + + + +Retrieves an ``IEntity`` by its iid. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `iid` a| The iid of the ``Entity`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IEntity >` + +[#_Promise__IEntityType___TypeDB_Driver_Api_IConceptManager_GetEntityType___string_label_] +==== GetEntityType + +[source,cs] +---- +Promise< IEntityType > TypeDB.Driver.Api.IConceptManager.GetEntityType(string label) +---- + + + +Retrieves an ``IEntityType`` by its label. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``IEntityType`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IEntityType >` + +[#_Promise__IRelation___TypeDB_Driver_Api_IConceptManager_GetRelation___string_iid_] +==== GetRelation + +[source,cs] +---- +Promise< IRelation > TypeDB.Driver.Api.IConceptManager.GetRelation(string iid) +---- + + + +Retrieves a ``IRelation`` by its iid. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `iid` a| The iid of the ``Relation`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IRelation >` + +[#_Promise__IRelationType___TypeDB_Driver_Api_IConceptManager_GetRelationType___string_label_] +==== GetRelationType + +[source,cs] +---- +Promise< IRelationType > TypeDB.Driver.Api.IConceptManager.GetRelationType(string label) +---- + + + +Retrieves a ``IRelationType`` by its label. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``IRelationType`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IRelationType >` + +[#_IList__TypeDBException___TypeDB_Driver_Api_IConceptManager_GetSchemaExceptions___] +==== GetSchemaExceptions + +[source,cs] +---- +IList< TypeDBException > TypeDB.Driver.Api.IConceptManager.GetSchemaExceptions() +---- + + + +A list of all schema exceptions for the current transaction. + + +[caption=""] +.Returns +`IList< TypeDBException >` + +[#_Promise__IAttributeType___TypeDB_Driver_Api_IConceptManager_PutAttributeType___string_label__IValue_ValueType_valueType_] +==== PutAttributeType + +[source,cs] +---- +Promise< IAttributeType > TypeDB.Driver.Api.IConceptManager.PutAttributeType(string label, IValue.ValueType valueType) +---- + + + +Creates a new ``IAttributeType`` if none exists with the given label, or retrieves the existing one. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``IAttributeType`` to create or retrieve. a| +a| `valueType` a| The value type of the ``IAttributeType`` to create. a| +|=== + +[caption=""] +.Returns +`Promise< IAttributeType >` + +[#_Promise__IEntityType___TypeDB_Driver_Api_IConceptManager_PutEntityType___string_label_] +==== PutEntityType + +[source,cs] +---- +Promise< IEntityType > TypeDB.Driver.Api.IConceptManager.PutEntityType(string label) +---- + + + +Creates a new ``IEntityType`` if none exists with the given label, otherwise retrieves the existing one. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``IEntityType`` to create or retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IEntityType >` + +[#_Promise__IRelationType___TypeDB_Driver_Api_IConceptManager_PutRelationType___string_label_] +==== PutRelationType + +[source,cs] +---- +Promise< IRelationType > TypeDB.Driver.Api.IConceptManager.PutRelationType(string label) +---- + + + +Creates a new ``IRelationType`` if none exists with the given label, otherwise retrieves the existing one. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``IRelationType`` to create or retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IRelationType >` + +// end::methods[] + diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc new file mode 100644 index 0000000000..9d955bb393 --- /dev/null +++ b/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc @@ -0,0 +1,44 @@ +[#_TypeDB_Driver_Api_IDatabase_IReplica_Interface_Reference] +=== TypeDB.Driver.Api.IDatabase.IReplica Interface Reference + +*Package*: `TypeDB.Driver.Api.IDatabase.IReplica Interface Reference` + + + +The metadata and state of an individual raft replica of a database. + +// tag::methods[] +[#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPreferred___] +==== IsPreferred + +[source,cs] +---- +bool TypeDB.Driver.Api.IDatabase.IReplica.IsPreferred() +---- + + + +Checks whether this is the preferred replica of the raft cluster. If true, Operations which can be run on any replica will prefer to use this replica. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPrimary___] +==== IsPrimary + +[source,cs] +---- +bool TypeDB.Driver.Api.IDatabase.IReplica.IsPrimary() +---- + + + +Checks whether this is the primary replica of the raft cluster. + +[caption=""] +.Returns +`bool` + +// end::methods[] + diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica_Interface_Reference.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica_Interface_Reference.adoc new file mode 100644 index 0000000000..9d955bb393 --- /dev/null +++ b/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica_Interface_Reference.adoc @@ -0,0 +1,44 @@ +[#_TypeDB_Driver_Api_IDatabase_IReplica_Interface_Reference] +=== TypeDB.Driver.Api.IDatabase.IReplica Interface Reference + +*Package*: `TypeDB.Driver.Api.IDatabase.IReplica Interface Reference` + + + +The metadata and state of an individual raft replica of a database. + +// tag::methods[] +[#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPreferred___] +==== IsPreferred + +[source,cs] +---- +bool TypeDB.Driver.Api.IDatabase.IReplica.IsPreferred() +---- + + + +Checks whether this is the preferred replica of the raft cluster. If true, Operations which can be run on any replica will prefer to use this replica. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPrimary___] +==== IsPrimary + +[source,cs] +---- +bool TypeDB.Driver.Api.IDatabase.IReplica.IsPrimary() +---- + + + +Checks whether this is the primary replica of the raft cluster. + +[caption=""] +.Returns +`bool` + +// end::methods[] + diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.adoc new file mode 100644 index 0000000000..b2aebc4241 --- /dev/null +++ b/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.adoc @@ -0,0 +1,93 @@ +[#_TypeDB_Driver_Api_IDatabase_Interface_Reference] +=== TypeDB.Driver.Api.IDatabase Interface Reference + +*Package*: `TypeDB.Driver.Api.IDatabase Interface Reference` + +// tag::methods[] +[#_void_TypeDB_Driver_Api_IDatabase_Delete___] +==== Delete + +[source,cs] +---- +void TypeDB.Driver.Api.IDatabase.Delete() +---- + + + +Deletes this database. + + +[caption=""] +.Returns +`void` + +[#_ISet__IReplica___TypeDB_Driver_Api_IDatabase_GetReplicas___] +==== GetReplicas + +[source,cs] +---- +ISet< IReplica > TypeDB.Driver.Api.IDatabase.GetReplicas() +---- + + + +Set of ``Replica`` instances for this database. Only works in TypeDB Cloud + + +[caption=""] +.Returns +`ISet< IReplica >` + +[#_string_TypeDB_Driver_Api_IDatabase_GetRuleSchema___] +==== GetRuleSchema + +[source,cs] +---- +string TypeDB.Driver.Api.IDatabase.GetRuleSchema() +---- + + + +The rules in the schema as a valid TypeQL define query string. + + +[caption=""] +.Returns +`string` + +[#_string_TypeDB_Driver_Api_IDatabase_GetSchema___] +==== GetSchema + +[source,cs] +---- +string TypeDB.Driver.Api.IDatabase.GetSchema() +---- + + + +A full schema text as a valid TypeQL define query string. + + +[caption=""] +.Returns +`string` + +[#_string_TypeDB_Driver_Api_IDatabase_GetTypeSchema___] +==== GetTypeSchema + +[source,cs] +---- +string TypeDB.Driver.Api.IDatabase.GetTypeSchema() +---- + + + +The types in the schema as a valid TypeQL define query string. + + +[caption=""] +.Returns +`string` + +// end::methods[] + diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IDatabaseManager.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IDatabaseManager.adoc new file mode 100644 index 0000000000..6628ce084a --- /dev/null +++ b/csharp/docs/connection/TypeDB.Driver.Api.IDatabaseManager.adoc @@ -0,0 +1,107 @@ +[#_TypeDB_Driver_Api_IDatabaseManager_Interface_Reference] +=== TypeDB.Driver.Api.IDatabaseManager Interface Reference + +*Package*: `TypeDB.Driver.Api.IDatabaseManager Interface Reference` + + + +Provides access to all database management methods. + +// tag::methods[] +[#_bool_TypeDB_Driver_Api_IDatabaseManager_Contains___string_name_] +==== Contains + +[source,cs] +---- +bool TypeDB.Driver.Api.IDatabaseManager.Contains(string name) +---- + + + +Checks if a database with the given name exists. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `name` a| The database name to be checked a| +|=== + +[caption=""] +.Returns +`bool` + +[#_void_TypeDB_Driver_Api_IDatabaseManager_Create___string_name_] +==== Create + +[source,cs] +---- +void TypeDB.Driver.Api.IDatabaseManager.Create(string name) +---- + + + +Create a database with the given name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `name` a| The name of the database to be created a| +|=== + +[caption=""] +.Returns +`void` + +[#_IDatabase_TypeDB_Driver_Api_IDatabaseManager_Get___string_name_] +==== Get + +[source,cs] +---- +IDatabase TypeDB.Driver.Api.IDatabaseManager.Get(string name) +---- + + + +Retrieve the database with the given name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `name` a| The name of the database to retrieve a| +|=== + +[caption=""] +.Returns +`IDatabase` + +[#_IList__IDatabase___TypeDB_Driver_Api_IDatabaseManager_GetAll___] +==== GetAll + +[source,cs] +---- +IList< IDatabase > TypeDB.Driver.Api.IDatabaseManager.GetAll() +---- + + + +Retrieves all databases present on the TypeDB server. + + +[caption=""] +.Returns +`IList< IDatabase >` + +// end::methods[] + diff --git a/csharp/docs/connection/TypeDB.Driver.Api.ITypeDBDriver.adoc b/csharp/docs/connection/TypeDB.Driver.Api.ITypeDBDriver.adoc new file mode 100644 index 0000000000..0a90e8225c --- /dev/null +++ b/csharp/docs/connection/TypeDB.Driver.Api.ITypeDBDriver.adoc @@ -0,0 +1,111 @@ +[#_TypeDB_Driver_Api_ITypeDBDriver_Interface_Reference] +=== TypeDB.Driver.Api.ITypeDBDriver Interface Reference + +*Package*: `TypeDB.Driver.Api.ITypeDBDriver Interface Reference` + +// tag::methods[] +[#_void_TypeDB_Driver_Api_ITypeDBDriver_Close___] +==== Close + +[source,cs] +---- +void TypeDB.Driver.Api.ITypeDBDriver.Close() +---- + + + +Closes the driver. Before instantiating a new driver, the driver that’s currently open should first be closed. + + +[caption=""] +.Returns +`void` + +[#_IUser_TypeDB_Driver_Api_ITypeDBDriver_GetCurrentUser___] +==== GetCurrentUser + +[source,cs] +---- +IUser TypeDB.Driver.Api.ITypeDBDriver.GetCurrentUser() +---- + + + +Returns the logged-in user for the connection. Only for TypeDB Cloud. + + +[caption=""] +.Returns +`IUser` + +[#_bool_TypeDB_Driver_Api_ITypeDBDriver_IsOpen___] +==== IsOpen + +[source,cs] +---- +bool TypeDB.Driver.Api.ITypeDBDriver.IsOpen() +---- + + + +Checks whether this connection is presently open. + + +[caption=""] +.Returns +`bool` + +[#_ITypeDBSession_TypeDB_Driver_Api_ITypeDBDriver_Session___string_database__SessionType_type_] +==== Session + +[source,cs] +---- +ITypeDBSession TypeDB.Driver.Api.ITypeDBDriver.Session(string database, SessionType type) +---- + + + +Opens a session to the given database with default options. + + + See also + + + TypeDBDriver::Session(string, SessionType, TypeDBOptions); + + + +[caption=""] +.Returns +`ITypeDBSession` + +[#_ITypeDBSession_TypeDB_Driver_Api_ITypeDBDriver_Session___string_database__SessionType_type__TypeDBOptions_options_] +==== Session + +[source,cs] +---- +ITypeDBSession TypeDB.Driver.Api.ITypeDBDriver.Session(string database, SessionType type, TypeDBOptions options) +---- + + + +Opens a communication tunnel (session) to the given database on the running TypeDB server. For more information on the methods, available with sessions, see the ``ITypeDBSession`` section. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `database` a| The name of the database with which the session connects a| +a| `type` a| The type of session to be created (Data or Schema) a| +a| `options` a| ``TypeDBOptions`` for the session a| +|=== + +[caption=""] +.Returns +`ITypeDBSession` + +// end::methods[] + diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc new file mode 100644 index 0000000000..5774723dd8 --- /dev/null +++ b/csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc @@ -0,0 +1,57 @@ +[#_TypeDB_Driver_Api_IUser_Interface_Reference] +=== TypeDB.Driver.Api.IUser Interface Reference + +*Package*: `TypeDB.Driver.Api.IUser Interface Reference` + + + +TypeDB user information + +// tag::methods[] +[#_void_TypeDB_Driver_Api_IUser_UpdatePassword___string_passwordOld__string_passwordNew_] +==== UpdatePassword + +[source,cs] +---- +void TypeDB.Driver.Api.IUser.UpdatePassword(string passwordOld, string passwordNew) +---- + + + +Updates the password for this user. + + + Parameters + + + + + + passwordOld + The current password of this user + + + passwordNew + The new password + + + + + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `passwordOld` a| The current password of this user a| +a| `passwordNew` a| The new password a| +|=== + +[caption=""] +.Returns +`void` + +// end::methods[] + diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc new file mode 100644 index 0000000000..a80a52fe56 --- /dev/null +++ b/csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc @@ -0,0 +1,161 @@ +[#_TypeDB_Driver_Api_IUserManager_Interface_Reference] +=== TypeDB.Driver.Api.IUserManager Interface Reference + +*Package*: `TypeDB.Driver.Api.IUserManager Interface Reference` + + + +Provides access to all user management methods. + +// tag::methods[] +[#_bool_TypeDB_Driver_Api_IUserManager_Contains___string_username_] +==== Contains + +[source,cs] +---- +bool TypeDB.Driver.Api.IUserManager.Contains(string username) +---- + + + +Checks if a user with the given name exists. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The user name to be checked a| +|=== + +[caption=""] +.Returns +`bool` + +[#_void_TypeDB_Driver_Api_IUserManager_Create___string_username__string_password_] +==== Create + +[source,cs] +---- +void TypeDB.Driver.Api.IUserManager.Create(string username, string password) +---- + + + +Creates a user with the given name & password. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to be created a| +a| `password` a| The password of the user to be created a| +|=== + +[caption=""] +.Returns +`void` + +[#_void_TypeDB_Driver_Api_IUserManager_Delete___string_username_] +==== Delete + +[source,cs] +---- +void TypeDB.Driver.Api.IUserManager.Delete(string username) +---- + + + +Deletes a user with the given name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to be deleted a| +|=== + +[caption=""] +.Returns +`void` + +[#_IUser_TypeDB_Driver_Api_IUserManager_Get___string_username_] +==== Get + +[source,cs] +---- +IUser? TypeDB.Driver.Api.IUserManager.Get(string username) +---- + + + +Retrieves a user with the given name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to retrieve a| +|=== + +[caption=""] +.Returns +`IUser?` + +[#_ISet__IUser___TypeDB_Driver_Api_IUserManager_GetAll___] +==== GetAll + +[source,cs] +---- +ISet< IUser > TypeDB.Driver.Api.IUserManager.GetAll() +---- + + + +Retrieves all users which exist on the TypeDB server. + + +[caption=""] +.Returns +`ISet< IUser >` + +[#_void_TypeDB_Driver_Api_IUserManager_SetPassword___string_username__string_password_] +==== SetPassword + +[source,cs] +---- +void TypeDB.Driver.Api.IUserManager.SetPassword(string username, string password) +---- + + + +Sets a new password for a user. This operation can only be performed by administrators. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to set the password of a| +a| `password` a| The new password a| +|=== + +[caption=""] +.Returns +`void` + +// end::methods[] + diff --git a/csharp/docs/connection/TypeDB.Driver.Api.TypeDBCredential.adoc b/csharp/docs/connection/TypeDB.Driver.Api.TypeDBCredential.adoc new file mode 100644 index 0000000000..c976925f4a --- /dev/null +++ b/csharp/docs/connection/TypeDB.Driver.Api.TypeDBCredential.adoc @@ -0,0 +1,118 @@ +[#_TypeDB_Driver_Api_TypeDBCredential] +=== TypeDB.Driver.Api.TypeDBCredential + +*Package*: `TypeDB.Driver.Api.TypeDBCredential` + + + +User credentials and TLS encryption settings for connecting to TypeDB Cloud. + + +[caption=""] +.Examples +[source,cs] +---- +// Creates a credential as above, but the connection will be made over TLS. +TypeDBCredential credential = new TypeDBCredential(username, password, true); + +// Creates a credential as above, but TLS will use the specified CA to authenticate server certificates. +TypeDBCredential credential = new TypeDBCredential(username, password, Path.of("path/to/ca-certificate.pem")); +---- + +// tag::methods[] +[#_TypeDB_Driver_Api_TypeDBCredential_TypeDBCredential___string_username__string_password__bool_tlsEnabled_] +==== TypeDBCredential + +[source,cs] +---- +TypeDB.Driver.Api.TypeDBCredential.TypeDBCredential(string username, string password, bool tlsEnabled) +---- + + + + Parameters + + + + + + username + The name of the user to connect as + + + password + The password for the user + + + tlsEnabled + Specify whether the connection to TypeDB Cloud must be done over TLS + + + + + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to connect as a| +a| `password` a| The password for the user a| +a| `tlsEnabled` a| Specify whether the connection to TypeDB Cloud must be done over TLS a| +|=== + +[caption=""] +.Returns +`TypeDB.Driver.Api.TypeDBCredential.TypeDBCredential` + +[#_TypeDB_Driver_Api_TypeDBCredential_TypeDBCredential___string_username__string_password__string_tlsRootCAPath_] +==== TypeDBCredential + +[source,cs] +---- +TypeDB.Driver.Api.TypeDBCredential.TypeDBCredential(string username, string password, string? tlsRootCAPath) +---- + + + + Parameters + + + + + + username + The name of the user to connect as + + + password + The password for the user + + + tlsRootCAPath + Path to the CA certificate to use for authenticating server certificates + + + + + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to connect as a| +a| `password` a| The password for the user a| +a| `tlsRootCAPath` a| Path to the CA certificate to use for authenticating server certificates a| +|=== + +[caption=""] +.Returns +`TypeDB.Driver.Api.TypeDBCredential.TypeDBCredential` + +// end::methods[] + diff --git a/csharp/docs/data/TypeDB.Driver.Api.IAttribute.adoc b/csharp/docs/data/TypeDB.Driver.Api.IAttribute.adoc new file mode 100644 index 0000000000..8d8a866307 --- /dev/null +++ b/csharp/docs/data/TypeDB.Driver.Api.IAttribute.adoc @@ -0,0 +1,110 @@ +[#_TypeDB_Driver_Api_IAttribute_Interface_Reference] +=== TypeDB.Driver.Api.IAttribute Interface Reference + +*Package*: `TypeDB.Driver.Api.IAttribute Interface Reference` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThing` +* `TypeDB.Driver.Api.IConcept` + + + +Attribute is an instance of the attribute type and has a value. This value is fixed and unique for every given instance of the attribute type. + +Attributes can be uniquely addressed by their type and value. + +// tag::methods[] +[#_IAttribute_IConcept__TypeDB_Driver_Api_IAttribute_AsAttribute___] +==== AsAttribute + +[source,cs] +---- +IAttribute IConcept. TypeDB.Driver.Api.IAttribute.AsAttribute() +---- + + + +Casts the concept to ``IAttribute``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IAttribute IConcept.` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IAttribute_GetOwners___ITypeDBTransaction_transaction_] +==== GetOwners + +[source,cs] +---- +IEnumerable< IThing > TypeDB.Driver.Api.IAttribute.GetOwners(ITypeDBTransaction transaction) +---- + + + +Retrieves the instances that own this ``IAttribute``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IAttribute_GetOwners___ITypeDBTransaction_transaction__IThingType_ownerType_] +==== GetOwners + +[source,cs] +---- +IEnumerable< IThing > TypeDB.Driver.Api.IAttribute.GetOwners(ITypeDBTransaction transaction, IThingType ownerType) +---- + + + +Retrieves the instances that own this ``IAttribute``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `ownerType` a| Filter results for only owners of the given type a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_bool_IConcept__TypeDB_Driver_Api_IAttribute_IsAttribute___] +==== IsAttribute + +[source,cs] +---- +bool IConcept. TypeDB.Driver.Api.IAttribute.IsAttribute() +---- + + + +Checks if the concept is an ``IAttribute``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +// end::methods[] + diff --git a/csharp/docs/data/TypeDB.Driver.Api.IEntity.adoc b/csharp/docs/data/TypeDB.Driver.Api.IEntity.adoc new file mode 100644 index 0000000000..7f69f70b20 --- /dev/null +++ b/csharp/docs/data/TypeDB.Driver.Api.IEntity.adoc @@ -0,0 +1,55 @@ +[#_TypeDB_Driver_Api_IEntity_Interface_Reference] +=== TypeDB.Driver.Api.IEntity Interface Reference + +*Package*: `TypeDB.Driver.Api.IEntity Interface Reference` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThing` +* `TypeDB.Driver.Api.IConcept` + + + +Instance of data of an entity type, representing a standalone object that exists in the data model independently. Entity does not have a value. It is usually addressed by its ownership over attribute instances and/or roles played in relation instances. + +// tag::methods[] +[#_IEntity_IConcept__TypeDB_Driver_Api_IEntity_AsEntity___] +==== AsEntity + +[source,cs] +---- +IEntity IConcept. TypeDB.Driver.Api.IEntity.AsEntity() +---- + + + +Casts the concept to ``IEntity``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IEntity IConcept.` + +[#_bool_IConcept__TypeDB_Driver_Api_IEntity_IsEntity___] +==== IsEntity + +[source,cs] +---- +bool IConcept. TypeDB.Driver.Api.IEntity.IsEntity() +---- + + + +Checks if the concept is an ``IEntity``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +// end::methods[] + diff --git a/csharp/docs/data/TypeDB.Driver.Api.IRelation.adoc b/csharp/docs/data/TypeDB.Driver.Api.IRelation.adoc new file mode 100644 index 0000000000..f9f2145d6a --- /dev/null +++ b/csharp/docs/data/TypeDB.Driver.Api.IRelation.adoc @@ -0,0 +1,190 @@ +[#_TypeDB_Driver_Api_IRelation_Interface_Reference] +=== TypeDB.Driver.Api.IRelation Interface Reference + +*Package*: `TypeDB.Driver.Api.IRelation Interface Reference` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThing` +* `TypeDB.Driver.Api.IConcept` + + + +Relation is an instance of a relation type and can be uniquely addressed by a combination of its type, owned attributes and role players. + +// tag::methods[] +[#_VoidPromise_TypeDB_Driver_Api_IRelation_AddPlayer___ITypeDBTransaction_transaction__IRoleType_roleType__IThing_player_] +==== AddPlayer + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IRelation.AddPlayer(ITypeDBTransaction transaction, IRoleType roleType, IThing player) +---- + + + +Adds a new role player to play the given role in this ``IRelation``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleType` a| The role to be played by the ``player`` a| +a| `player` a| The thing to play the role a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_IRelation_IConcept__TypeDB_Driver_Api_IRelation_AsRelation___] +==== AsRelation + +[source,cs] +---- +IRelation IConcept. TypeDB.Driver.Api.IRelation.AsRelation() +---- + + + +Casts the concept to ``IRelation``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IRelation IConcept.` + +[#_Dictionary__IRoleType__ICollection__IThing_____TypeDB_Driver_Api_IRelation_GetPlayers___ITypeDBTransaction_transaction_] +==== GetPlayers + +[source,cs] +---- +Dictionary< IRoleType, ICollection< IThing > > TypeDB.Driver.Api.IRelation.GetPlayers(ITypeDBTransaction transaction) +---- + + + +Retrieves a mapping of all instances involved in the ``IRelation`` and the role each play. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Dictionary< IRoleType, ICollection< IThing > >` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IRelation_GetPlayersByRoleType___ITypeDBTransaction_transaction__params_IRoleType___roleTypes_] +==== GetPlayersByRoleType + +[source,cs] +---- +IEnumerable< IThing > TypeDB.Driver.Api.IRelation.GetPlayersByRoleType(ITypeDBTransaction transaction, params IRoleType[] roleTypes) +---- + + + +Retrieves all role players of this ``IRelation``, optionally filtered by given role types. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleTypes` a| 0 or more role types a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelation_GetRelating___ITypeDBTransaction_transaction_] +==== GetRelating + +[source,cs] +---- +IEnumerable< IRoleType > TypeDB.Driver.Api.IRelation.GetRelating(ITypeDBTransaction transaction) +---- + + + +Retrieves all role types currently played in this ``IRelation``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_bool_IConcept__TypeDB_Driver_Api_IRelation_IsRelation___] +==== IsRelation + +[source,cs] +---- +bool IConcept. TypeDB.Driver.Api.IRelation.IsRelation() +---- + + + +Checks if the concept is a ``IRelation``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IRelation_RemovePlayer___ITypeDBTransaction_transaction__IRoleType_roleType__IThing_player_] +==== RemovePlayer + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IRelation.RemovePlayer(ITypeDBTransaction transaction, IRoleType roleType, IThing player) +---- + + + +Removes the association of the given instance that plays the given role in this ``IRelation``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleType` a| The role to no longer be played by the thing in this ``IRelation`` a| +a| `player` a| The instance to no longer play the role in this ``IRelation`` a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/data/TypeDB.Driver.Api.IThing.adoc b/csharp/docs/data/TypeDB.Driver.Api.IThing.adoc new file mode 100644 index 0000000000..5e0ec9436f --- /dev/null +++ b/csharp/docs/data/TypeDB.Driver.Api.IThing.adoc @@ -0,0 +1,280 @@ +[#_TypeDB_Driver_Api_IThing_Interface_Reference] +=== TypeDB.Driver.Api.IThing Interface Reference + +*Package*: `TypeDB.Driver.Api.IThing Interface Reference` + +*Supertypes:* + +* `TypeDB.Driver.Api.IConcept` + +// tag::methods[] +[#_IThing_IConcept__TypeDB_Driver_Api_IThing_AsThing___] +==== AsThing + +[source,cs] +---- +IThing IConcept. TypeDB.Driver.Api.IThing.AsThing() +---- + + + +Casts the concept to ``IThing``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IThing IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IThing_Delete___ITypeDBTransaction_transaction_] +==== Delete + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThing.Delete(ITypeDBTransaction transaction) +---- + + + +Deletes this ``IThing``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_IEnumerable__IAttribute___TypeDB_Driver_Api_IThing_GetHas___ITypeDBTransaction_transaction__params_IAttributeType___attributeTypes_] +==== GetHas + +[source,cs] +---- +IEnumerable< IAttribute > TypeDB.Driver.Api.IThing.GetHas(ITypeDBTransaction transaction, params IAttributeType[] attributeTypes) +---- + + + +Retrieves the ``IAttribute``s that this ``IThing`` owns, optionally filtered by ``IAttributeType``s. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attributeTypes` a| The ``IAttributeType``s to filter the attributes by a| +|=== + +[caption=""] +.Returns +`IEnumerable< IAttribute >` + +[#_IEnumerable__IAttribute___TypeDB_Driver_Api_IThing_GetHas___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] +==== GetHas + +[source,cs] +---- +IEnumerable< IAttribute > TypeDB.Driver.Api.IThing.GetHas(ITypeDBTransaction transaction, ICollection< Annotation > annotations) +---- + + + +Retrieves the ``IAttribute``s that this ``IThing`` owns, filtered by ``Annotation``s. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `annotations` a| Only retrieve attributes with all given ``Annotation``s a| +|=== + +[caption=""] +.Returns +`IEnumerable< IAttribute >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThing_GetPlaying___ITypeDBTransaction_transaction_] +==== GetPlaying + +[source,cs] +---- +IEnumerable< IRoleType > TypeDB.Driver.Api.IThing.GetPlaying(ITypeDBTransaction transaction) +---- + + + +Retrieves the roles that this ``IThing`` is currently playing. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_IEnumerable__IRelation___TypeDB_Driver_Api_IThing_GetRelations___ITypeDBTransaction_transaction__params_IRoleType___roleTypes_] +==== GetRelations + +[source,cs] +---- +IEnumerable< IRelation > TypeDB.Driver.Api.IThing.GetRelations(ITypeDBTransaction transaction, params IRoleType[] roleTypes) +---- + + + +Retrieves all the ``Relations`` which this ``IThing`` plays a role in, optionally filtered by one or more given roles. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleTypes` a| The array of roles to filter the relations by. a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRelation >` + +[#_Promise__bool___TypeDB_Driver_Api_IThing_IsDeleted___ITypeDBTransaction_transaction_] +==== IsDeleted + +[source,cs] +---- +Promise< bool > TypeDB.Driver.Api.IThing.IsDeleted(ITypeDBTransaction transaction) +---- + + + +Checks if this ``IThing`` is deleted. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< bool >` + +[#_bool_TypeDB_Driver_Api_IThing_IsInferred___] +==== IsInferred + +[source,cs] +---- +bool TypeDB.Driver.Api.IThing.IsInferred() +---- + + + +Checks if this ``IThing`` is inferred by a [Reasoning Rule]. + + +[caption=""] +.Returns +`bool` + +[#_bool_IConcept__TypeDB_Driver_Api_IThing_IsThing___] +==== IsThing + +[source,cs] +---- +bool IConcept. TypeDB.Driver.Api.IThing.IsThing() +---- + + + +Checks if the concept is a ``IThing``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IThing_SetHas___ITypeDBTransaction_transaction__IAttribute_attribute_] +==== SetHas + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThing.SetHas(ITypeDBTransaction transaction, IAttribute attribute) +---- + + + +Assigns an ``IAttribute`` to be owned by this ``IThing``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attribute` a| The ``IAttribute`` to be owned by this ``IThing``. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThing_UnsetHas___ITypeDBTransaction_transaction__IAttribute_attribute_] +==== UnsetHas + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThing.UnsetHas(ITypeDBTransaction transaction, IAttribute attribute) +---- + + + +Unassigns an ``IAttribute`` from this ``IThing``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attribute` a| The ``IAttribute`` to be disowned from this ``IThing``. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/data/TypeDB.Driver.Api.IValue.adoc b/csharp/docs/data/TypeDB.Driver.Api.IValue.adoc new file mode 100644 index 0000000000..ea660f4037 --- /dev/null +++ b/csharp/docs/data/TypeDB.Driver.Api.IValue.adoc @@ -0,0 +1,241 @@ +[#_TypeDB_Driver_Api_IValue_Interface_Reference] +=== TypeDB.Driver.Api.IValue Interface Reference + +*Package*: `TypeDB.Driver.Api.IValue Interface Reference` + +*Supertypes:* + +* `TypeDB.Driver.Api.IConcept` + +// tag::methods[] +[#_bool_TypeDB_Driver_Api_IValue_AsBool___] +==== AsBool + +[source,cs] +---- +bool TypeDB.Driver.Api.IValue.AsBool() +---- + + + +Returns a ``bool`` value of this value concept. If the value has another type, raises an exception. + + +[caption=""] +.Returns +`bool` + +[#_System_DateTime_TypeDB_Driver_Api_IValue_AsDateTime___] +==== AsDateTime + +[source,cs] +---- +System.DateTime TypeDB.Driver.Api.IValue.AsDateTime() +---- + + + +Returns a ``datetime`` value of this value concept. This value contains raw date and time without considering your time zone (Kind = Unspecified). If the value has another type, raises an exception. + + +[caption=""] +.Returns +`System.DateTime` + +[#_double_TypeDB_Driver_Api_IValue_AsDouble___] +==== AsDouble + +[source,cs] +---- +double TypeDB.Driver.Api.IValue.AsDouble() +---- + + + +Returns a ``double`` value of this value concept. If the value has another type, raises an exception. + + +[caption=""] +.Returns +`double` + +[#_long_TypeDB_Driver_Api_IValue_AsLong___] +==== AsLong + +[source,cs] +---- +long TypeDB.Driver.Api.IValue.AsLong() +---- + + + +Returns a ``long`` value of this value concept. If the value has another type, raises an exception. + + +[caption=""] +.Returns +`long` + +[#_string_TypeDB_Driver_Api_IValue_AsString___] +==== AsString + +[source,cs] +---- +string TypeDB.Driver.Api.IValue.AsString() +---- + + + +Returns a ``string`` value of this value concept. If the value has another type, raises an exception. + + +[caption=""] +.Returns +`string` + +[#_object_TypeDB_Driver_Api_IValue_AsUntyped___] +==== AsUntyped + +[source,cs] +---- +object TypeDB.Driver.Api.IValue.AsUntyped() +---- + + + +Returns an untyped ``object`` value of this value concept. This is useful for value equality or printing without having to switch on the actual contained value. + + +[caption=""] +.Returns +`object` + +[#_IValue_IConcept__TypeDB_Driver_Api_IValue_AsValue___] +==== AsValue + +[source,cs] +---- +IValue IConcept. TypeDB.Driver.Api.IValue.AsValue() +---- + + + +Casts the concept to ``IValue``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IValue IConcept.` + +[#_bool_TypeDB_Driver_Api_IValue_IsBool___] +==== IsBool + +[source,cs] +---- +bool TypeDB.Driver.Api.IValue.IsBool() +---- + + + +Returns ``True`` if the value which this value concept holds is of type ``bool``. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IValue_IsDateTime___] +==== IsDateTime + +[source,cs] +---- +bool TypeDB.Driver.Api.IValue.IsDateTime() +---- + + + +Returns ``True`` if the value which this value concept holds is of type ``datetime``. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IValue_IsDouble___] +==== IsDouble + +[source,cs] +---- +bool TypeDB.Driver.Api.IValue.IsDouble() +---- + + + +Returns ``True`` if the value which this value concept holds is of type ``double``. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IValue_IsLong___] +==== IsLong + +[source,cs] +---- +bool TypeDB.Driver.Api.IValue.IsLong() +---- + + + +Returns ``True`` if the value which this value concept holds is of type ``long``. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IValue_IsString___] +==== IsString + +[source,cs] +---- +bool TypeDB.Driver.Api.IValue.IsString() +---- + + + +Returns ``True`` if the value which this value concept holds is of type ``string``. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`bool` + +[#_bool_IConcept__TypeDB_Driver_Api_IValue_IsValue___] +==== IsValue + +[source,cs] +---- +bool IConcept. TypeDB.Driver.Api.IValue.IsValue() +---- + + + +Checks if the concept is a ``IValue``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +// end::methods[] + diff --git a/csharp/docs/errors/TypeDB.Driver.Common.TypeDBDriverException.adoc b/csharp/docs/errors/TypeDB.Driver.Common.TypeDBDriverException.adoc new file mode 100644 index 0000000000..0dcd5862b8 --- /dev/null +++ b/csharp/docs/errors/TypeDB.Driver.Common.TypeDBDriverException.adoc @@ -0,0 +1,93 @@ +[#_TypeDB_Driver_Common_TypeDBDriverException] +=== TypeDB.Driver.Common.TypeDBDriverException + +*Package*: `TypeDB.Driver.Common.TypeDBDriverException` + + + +Exceptions raised by the driver. + +// tag::methods[] +[#_bool_TypeDB_Driver_Common_TypeDBDriverException_Contains___string_subString_] +==== Contains + +[source,cs] +---- +bool TypeDB.Driver.Common.TypeDBDriverException.Contains(string subString) +---- + + + +Checks whether a substring is a part of this exception's message. + + +[caption=""] +.Returns +`bool` + +[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___ErrorMessage_error__params_object___errorParams_] +==== TypeDBDriverException + +[source,cs] +---- +TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException(ErrorMessage error, params object?[] errorParams) +---- + + + +@hidden + +[caption=""] +.Returns +`TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException` + +[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___string_message_] +==== TypeDBDriverException + +[source,cs] +---- +TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException(string message) +---- + + + +@hidden + +[caption=""] +.Returns +`TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException` + +[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___SystemException_error_] +==== TypeDBDriverException + +[source,cs] +---- +TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException(System::Exception error) +---- + + + +@hidden + +[caption=""] +.Returns +`TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException` + +[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___PinvokeError_nativeError_] +==== TypeDBDriverException + +[source,cs] +---- +TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException(Pinvoke::Error nativeError) +---- + + + +@hidden + +[caption=""] +.Returns +`TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException` + +// end::methods[] + diff --git a/csharp/docs/logic/TypeDB.Driver.Api.ILogicManager.adoc b/csharp/docs/logic/TypeDB.Driver.Api.ILogicManager.adoc new file mode 100644 index 0000000000..7a1a92f5e0 --- /dev/null +++ b/csharp/docs/logic/TypeDB.Driver.Api.ILogicManager.adoc @@ -0,0 +1,83 @@ +[#_TypeDB_Driver_Api_ILogicManager_Interface_Reference] +=== TypeDB.Driver.Api.ILogicManager Interface Reference + +*Package*: `TypeDB.Driver.Api.ILogicManager Interface Reference` + + + +Provides methods for manipulating rules in the database. + +// tag::methods[] +[#_Promise__IRule___TypeDB_Driver_Api_ILogicManager_GetRule___string_label_] +==== GetRule + +[source,cs] +---- +Promise< IRule > TypeDB.Driver.Api.ILogicManager.GetRule(string label) +---- + + + +Retrieves the Rule that has the given label. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the Rule to create or retrieve a| +|=== + +[caption=""] +.Returns +`Promise< IRule >` + +[#_IEnumerable__IRule___TypeDB_Driver_Api_ILogicManager_GetRules___] +==== GetRules + +[source,cs] +---- +IEnumerable< IRule > TypeDB.Driver.Api.ILogicManager.GetRules() +---- + + + +Retrieves all rules. + + +[caption=""] +.Returns +`IEnumerable< IRule >` + +[#_Promise__IRule___TypeDB_Driver_Api_ILogicManager_PutRule___string_label__string_when__string_then_] +==== PutRule + +[source,cs] +---- +Promise< IRule > TypeDB.Driver.Api.ILogicManager.PutRule(string label, string when, string then) +---- + + + +Creates a new Rule if none exists with the given label, or replaces the existing one. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the IRule to create or replace a| +a| `when` a| The when body of the rule to create a| +a| `then` a| The then body of the rule to create a| +|=== + +[caption=""] +.Returns +`Promise< IRule >` + +// end::methods[] + diff --git a/csharp/docs/logic/TypeDB.Driver.Api.IRule.adoc b/csharp/docs/logic/TypeDB.Driver.Api.IRule.adoc new file mode 100644 index 0000000000..b48af8a78b --- /dev/null +++ b/csharp/docs/logic/TypeDB.Driver.Api.IRule.adoc @@ -0,0 +1,91 @@ +[#_TypeDB_Driver_Api_IRule_Interface_Reference] +=== TypeDB.Driver.Api.IRule Interface Reference + +*Package*: `TypeDB.Driver.Api.IRule Interface Reference` + + + +Rules are a part of schema and define embedded logic. The reasoning engine uses rules as a set of logic to infer new data. A rule consists of a condition and a conclusion, and is uniquely identified by a label. + +// tag::methods[] +[#_VoidPromise_TypeDB_Driver_Api_IRule_Delete___ITypeDBTransaction_transaction_] +==== Delete + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IRule.Delete(ITypeDBTransaction transaction) +---- + + + +Deletes this rule. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current ``Transaction`` a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_Promise__bool___TypeDB_Driver_Api_IRule_IsDeleted___ITypeDBTransaction_transaction_] +==== IsDeleted + +[source,cs] +---- +Promise< bool > TypeDB.Driver.Api.IRule.IsDeleted(ITypeDBTransaction transaction) +---- + + + +Check if this rule has been deleted. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current ``Transaction`` a| +|=== + +[caption=""] +.Returns +`Promise< bool >` + +[#_VoidPromise_TypeDB_Driver_Api_IRule_SetLabel___ITypeDBTransaction_transaction__string_label_] +==== SetLabel + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IRule.SetLabel(ITypeDBTransaction transaction, string label) +---- + + + +Renames the label of the rule. The new label must remain unique. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current ``Transaction`` a| +a| `label` a| The new label to be given to the rule a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IAttributeType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IAttributeType.adoc new file mode 100644 index 0000000000..1947d7967e --- /dev/null +++ b/csharp/docs/schema/TypeDB.Driver.Api.IAttributeType.adoc @@ -0,0 +1,746 @@ +[#_TypeDB_Driver_Api_IAttributeType_Interface_Reference] +=== TypeDB.Driver.Api.IAttributeType Interface Reference + +*Package*: `TypeDB.Driver.Api.IAttributeType Interface Reference` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThingType` +* `TypeDB.Driver.Api.IType` +* `TypeDB.Driver.Api.IConcept` + + + +Attribute types represent properties that other types can own. + +IAttribute types have a value type. This value type is fixed and unique for every given instance of the attribute type. + +Other types can own an attribute type. That means that instances of these other types can own an instance of this attribute type. This usually means that an object in our domain has a property with the matching value. + +Multiple types can own the same attribute type, and different instances of the same type or different types can share ownership of the same attribute instance. + +// tag::methods[] +[#_IAttributeType_IConcept__TypeDB_Driver_Api_IAttributeType_AsAttributeType___] +==== AsAttributeType + +[source,cs] +---- +IAttributeType IConcept. TypeDB.Driver.Api.IAttributeType.AsAttributeType() +---- + + + +Casts the concept to ``IAttributeType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IAttributeType IConcept.` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__IValue_value_] +==== Get + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, IValue value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__string_value_] +==== Get + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, string value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__long_value_] +==== Get + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, long value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__double_value_] +==== Get + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, double value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__bool_value_] +==== Get + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, bool value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__System_DateTime_value_] +==== Get + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, System.DateTime value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction_] +==== GetOwners + +[source,cs] +---- +IEnumerable< IThingType > TypeDB.Driver.Api.IAttributeType.GetOwners(ITypeDBTransaction transaction) +---- + + + +Retrieve all ``Things`` that own an attribute of this ``IAttributeType`` directly or through inheritance. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] +==== GetOwners + +[source,cs] +---- +IEnumerable< IThingType > TypeDB.Driver.Api.IAttributeType.GetOwners(ITypeDBTransaction transaction, ICollection< Annotation > annotations) +---- + + + +Retrieve all ``Things`` that own an attribute of this ``IAttributeType``, filtered by ``Annotation``s, directly or through inheritance. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``IAttributeType`` with all given ``Annotation``s a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetOwners + +[source,cs] +---- +IEnumerable< IThingType > TypeDB.Driver.Api.IAttributeType.GetOwners(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieve all ``Things`` that own an attribute of this ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] +==== GetOwners + +[source,cs] +---- +IEnumerable< IThingType > TypeDB.Driver.Api.IAttributeType.GetOwners(ITypeDBTransaction transaction, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) +---- + + + +Retrieve all ``Things`` that own an attribute of this ``IAttributeType``, filtered by ``Annotation``s. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``IAttributeType`` with all given ``Annotation``s a| +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_Promise__string___TypeDB_Driver_Api_IAttributeType_GetRegex___ITypeDBTransaction_transaction_] +==== GetRegex + +[source,cs] +---- +Promise< string > TypeDB.Driver.Api.IAttributeType.GetRegex(ITypeDBTransaction transaction) +---- + + + +Retrieves the regular expression that is defined for this ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< string >` + +[#_IEnumerable__IType___TypeDB_Driver_Api_IAttributeType_GetSubtypes___ITypeDBTransaction_transaction__IValue_ValueType_valueType_] +==== GetSubtypes + +[source,cs] +---- +IEnumerable< IType > TypeDB.Driver.Api.IAttributeType.GetSubtypes(ITypeDBTransaction transaction, IValue.ValueType valueType) +---- + + + +Retrieves all direct and indirect subtypes of this ``IAttributeType`` with given ``IValue.ValueType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| +|=== + +[caption=""] +.Returns +`IEnumerable< IType >` + +[#_IEnumerable__IType___TypeDB_Driver_Api_IAttributeType_GetSubtypes___ITypeDBTransaction_transaction__IValue_ValueType_valueType__IConcept_Transitivity_transitivity_] +==== GetSubtypes + +[source,cs] +---- +IEnumerable< IType > TypeDB.Driver.Api.IAttributeType.GetSubtypes(ITypeDBTransaction transaction, IValue.ValueType valueType, IConcept.Transitivity transitivity) +---- + + + +Retrieves all direct and indirect (or direct only) subtypes of this ``IAttributeType`` with given ``IValue.ValueType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| +a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IType >` + +[#_bool_IConcept__TypeDB_Driver_Api_IAttributeType_IsAttributeType___] +==== IsAttributeType + +[source,cs] +---- +bool IConcept. TypeDB.Driver.Api.IAttributeType.IsAttributeType() +---- + + + +Checks if the concept is an ``IAttributeType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_bool_TypeDB_Driver_Api_IAttributeType_IsBool___] +==== IsBool + +[source,cs] +---- +bool TypeDB.Driver.Api.IAttributeType.IsBool() +---- + + + +Returns ``True`` if the value for attributes of this type is of type ``bool``. Otherwise, returns ``False``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IAttributeType_IsDateTime___] +==== IsDateTime + +[source,cs] +---- +bool TypeDB.Driver.Api.IAttributeType.IsDateTime() +---- + + + +Returns ``True`` if the value for attributes of this type is of type ``datetime``. Otherwise, returns ``False``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IAttributeType_IsDouble___] +==== IsDouble + +[source,cs] +---- +bool TypeDB.Driver.Api.IAttributeType.IsDouble() +---- + + + +Returns ``True`` if the value for attributes of this type is of type ``double``. Otherwise, returns ``False``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IAttributeType_IsLong___] +==== IsLong + +[source,cs] +---- +bool TypeDB.Driver.Api.IAttributeType.IsLong() +---- + + + +Returns ``True`` if the value for attributes of this type is of type ``long``. Otherwise, returns ``False``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IAttributeType_IsString___] +==== IsString + +[source,cs] +---- +bool TypeDB.Driver.Api.IAttributeType.IsString() +---- + + + +Returns ``True`` if the value for attributes of this type is of type ``string``. Otherwise, returns ``False``. + + +[caption=""] +.Returns +`bool` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__IValue_value_] +==== Put + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, IValue value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given value. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__string_value_] +==== Put + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, string value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``string`` value. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__long_value_] +==== Put + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, long value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``long`` value. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__double_value_] +==== Put + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, double value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``double`` value. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__bool_value_] +==== Put + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, bool value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``bool`` value. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__System_DateTime_value_] +==== Put + +[source,cs] +---- +Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, System.DateTime value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``DateTime`` value. The input DateTime value is treated as timezone naive, with DateTimeKind being ignored. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_VoidPromise_TypeDB_Driver_Api_IAttributeType_SetRegex___ITypeDBTransaction_transaction__string_regex_] +==== SetRegex + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IAttributeType.SetRegex(ITypeDBTransaction transaction, string regex) +---- + + + +Sets a regular expression as a constraint for this ``IAttributeType``. ``Values`` of all ``IAttribute``s of this type (inserted earlier or later) should match this regex. + +Can only be applied for ``IAttributeType``s with a ``string`` value type. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `regex` a| Regular expression a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IAttributeType_SetSupertype___ITypeDBTransaction_transaction__IAttributeType_attributeType_] +==== SetSupertype + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IAttributeType.SetSupertype(ITypeDBTransaction transaction, IAttributeType attributeType) +---- + + + +Sets the supplied ``IAttributeType`` as the supertype of the current ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attributeType` a| The ``IAttributeType`` to set as the supertype of this ``IAttributeType`` a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IAttributeType_UnsetRegex___ITypeDBTransaction_transaction_] +==== UnsetRegex + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IAttributeType.UnsetRegex(ITypeDBTransaction transaction) +---- + + + +Removes the regular expression that is defined for this ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IEntityType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IEntityType.adoc new file mode 100644 index 0000000000..1998c4e2ce --- /dev/null +++ b/csharp/docs/schema/TypeDB.Driver.Api.IEntityType.adoc @@ -0,0 +1,113 @@ +[#_TypeDB_Driver_Api_IEntityType_Interface_Reference] +=== TypeDB.Driver.Api.IEntityType Interface Reference + +*Package*: `TypeDB.Driver.Api.IEntityType Interface Reference` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThingType` +* `TypeDB.Driver.Api.IType` +* `TypeDB.Driver.Api.IConcept` + + + +Entity types represent the classification of independent objects in the data model of the business domain. + +// tag::methods[] +[#_IEntityType_IConcept__TypeDB_Driver_Api_IEntityType_AsEntityType___] +==== AsEntityType + +[source,cs] +---- +IEntityType IConcept. TypeDB.Driver.Api.IEntityType.AsEntityType() +---- + + + +Casts the concept to ``IEntityType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IEntityType IConcept.` + +[#_Promise__IEntity___TypeDB_Driver_Api_IEntityType_Create___ITypeDBTransaction_transaction_] +==== Create + +[source,cs] +---- +Promise< IEntity > TypeDB.Driver.Api.IEntityType.Create(ITypeDBTransaction transaction) +---- + + + +Creates and returns a new instance of this ``IEntityType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< IEntity >` + +[#_bool_IConcept__TypeDB_Driver_Api_IEntityType_IsEntityType___] +==== IsEntityType + +[source,cs] +---- +bool IConcept. TypeDB.Driver.Api.IEntityType.IsEntityType() +---- + + + +Checks if the concept is an ``IEntityType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IEntityType_SetSupertype___ITypeDBTransaction_transaction__IEntityType_superEntityType_] +==== SetSupertype + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IEntityType.SetSupertype(ITypeDBTransaction transaction, IEntityType superEntityType) +---- + + + +Sets the supplied ``IEntityType`` as the supertype of the current ``IEntityType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `superEntityType` a| The ``IEntityType`` to set as the supertype of this ``IEntityType`` a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc new file mode 100644 index 0000000000..437150f777 --- /dev/null +++ b/csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc @@ -0,0 +1,369 @@ +[#_TypeDB_Driver_Api_IRelationType_Interface_Reference] +=== TypeDB.Driver.Api.IRelationType Interface Reference + +*Package*: `TypeDB.Driver.Api.IRelationType Interface Reference` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThingType` +* `TypeDB.Driver.Api.IType` +* `TypeDB.Driver.Api.IConcept` + + + +Relation types (or subtypes of the relation root type) represent relationships between types. Relation types have roles. Other types can play roles in relations if it’s mentioned in their definition. A relation type must specify at least one role. + +// tag::methods[] +[#_IRelationType_IConcept__TypeDB_Driver_Api_IRelationType_AsRelationType___] +==== AsRelationType + +[source,cs] +---- +IRelationType IConcept. TypeDB.Driver.Api.IRelationType.AsRelationType() +---- + + + +Casts the concept to ``IRelationType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IRelationType IConcept.` + +[#_Promise__IRelation___TypeDB_Driver_Api_IRelationType_Create___ITypeDBTransaction_transaction_] +==== Create + +[source,cs] +---- +Promise< IRelation > TypeDB.Driver.Api.IRelationType.Create(ITypeDBTransaction transaction) +---- + + + +Creates and returns an instance of this ``IRelationType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< IRelation >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction_] +==== GetRelates + +[source,cs] +---- +IEnumerable< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelates(ITypeDBTransaction transaction) +---- + + + +Retrieves roles that this ``IRelationType`` relates to directly or via inheritance. + + + See also + + + IRelationType::getRelates(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetRelates + +[source,cs] +---- +IEnumerable< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelates(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves roles that this ``IRelationType`` relates to directly or via inheritance. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and inherited relates, ``Explicit`` for direct relates only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction__string_roleLabel_] +==== GetRelates + +[source,cs] +---- +Promise< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelates(ITypeDBTransaction transaction, string roleLabel) +---- + + + +Retrieves roles that this ``IRelationType`` relates to directly or via inheritance. If ``role_label`` is given, returns a corresponding ``IRoleType`` or ``null``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleLabel` a| Label of the role we wish to retrieve a| +|=== + +[caption=""] +.Returns +`Promise< IRoleType >` + +[#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__IRoleType_roleType_] +==== GetRelatesOverridden + +[source,cs] +---- +Promise< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelatesOverridden(ITypeDBTransaction transaction, IRoleType roleType) +---- + + + +Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label``. + + + See also + + + <<#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__string_roleLabel_,IRelationType::GetRelatesOverridden(ITypeDBTransaction, string)>> + + + +[caption=""] +.Returns +`Promise< IRoleType >` + +[#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__string_roleLabel_] +==== GetRelatesOverridden + +[source,cs] +---- +Promise< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelatesOverridden(ITypeDBTransaction transaction, string roleLabel) +---- + + + +Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleLabel` a| Label of the role that overrides an inherited role a| +|=== + +[caption=""] +.Returns +`Promise< IRoleType >` + +[#_bool_IConcept__TypeDB_Driver_Api_IRelationType_IsRelationType___] +==== IsRelationType + +[source,cs] +---- +bool IConcept. TypeDB.Driver.Api.IRelationType.IsRelationType() +---- + + + +Checks if the concept is a ``IRelationType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel_] +==== SetRelates + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IRelationType.SetRelates(ITypeDBTransaction transaction, string roleLabel) +---- + + + +Sets the new role that this ``IRelationType`` relates to. + + + See also + + + IRelationType::SetRelates(ITypeDBTransaction, string, string) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel__IRoleType_overriddenType_] +==== SetRelates + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IRelationType.SetRelates(ITypeDBTransaction transaction, string roleLabel, IRoleType overriddenType) +---- + + + +Sets the new role that this ``IRelationType`` relates to. + + + See also + + + IRelationType::SetRelates(ITypeDBTransaction, string, string) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel__string_overriddenLabel_] +==== SetRelates + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IRelationType.SetRelates(ITypeDBTransaction transaction, string roleLabel, string? overriddenLabel) +---- + + + +Sets the new role that this ``IRelationType`` relates to. If we are setting an overriding type this way, we have to also pass the overridden type as a second argument. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleLabel` a| The new role for the ``IRelationType`` to relate to a| +a| `overriddenLabel` a| The label being overridden, if applicable a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetSupertype___ITypeDBTransaction_transaction__IRelationType_superRelationType_] +==== SetSupertype + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IRelationType.SetSupertype(ITypeDBTransaction transaction, IRelationType superRelationType) +---- + + + +Sets the supplied ``IRelationType`` as the supertype of the current ``IRelationType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `superRelationType` a| The ``IRelationType`` to set as the supertype of this ``IRelationType`` a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__IRoleType_roleType_] +==== UnsetRelates + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IRelationType.UnsetRelates(ITypeDBTransaction transaction, IRoleType roleType) +---- + + + +Disallows this ``IRelationType`` from relating to the given role. + + + See also + + + <<#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__string_roleLabel_,IRelationType::UnsetRelates(ITypeDBTransaction, string)>> + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__string_roleLabel_] +==== UnsetRelates + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IRelationType.UnsetRelates(ITypeDBTransaction transaction, string roleLabel) +---- + + + +Disallows this ``IRelationType`` from relating to the given role. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleLabel` a| The role to not relate to the relation type. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IRoleType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IRoleType.adoc new file mode 100644 index 0000000000..3480e7c75f --- /dev/null +++ b/csharp/docs/schema/TypeDB.Driver.Api.IRoleType.adoc @@ -0,0 +1,238 @@ +[#_TypeDB_Driver_Api_IRoleType_Interface_Reference] +=== TypeDB.Driver.Api.IRoleType Interface Reference + +*Package*: `TypeDB.Driver.Api.IRoleType Interface Reference` + +*Supertypes:* + +* `TypeDB.Driver.Api.IType` +* `TypeDB.Driver.Api.IConcept` + + + +Roles are special internal types used by relations. We can not create an instance of a role in a database. But we can set an instance of another type (role player) to play a role in a particular instance of a relation type. Roles allow a schema to enforce logical constraints on types of role players. + +// tag::methods[] +[#_IRoleType_IConcept__TypeDB_Driver_Api_IRoleType_AsRoleType___] +==== AsRoleType + +[source,cs] +---- +IRoleType IConcept. TypeDB.Driver.Api.IRoleType.AsRoleType() +---- + + + +Casts the concept to ``IRoleType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IRoleType IConcept.` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction_] +==== GetPlayerInstances + +[source,cs] +---- +IEnumerable< IThing > TypeDB.Driver.Api.IRoleType.GetPlayerInstances(ITypeDBTransaction transaction) +---- + + + +Retrieves the ``Thing`` instances that play this role. + + + See also + + + <<#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction_,IRoleType::GetPlayerInstances>>(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetPlayerInstances + +[source,cs] +---- +IEnumerable< IThing > TypeDB.Driver.Api.IRoleType.GetPlayerInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves the ``Thing`` instances that play this role. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction_] +==== GetPlayerTypes + +[source,cs] +---- +IEnumerable< IThingType > TypeDB.Driver.Api.IRoleType.GetPlayerTypes(ITypeDBTransaction transaction) +---- + + + +Retrieves the ``ThingType``s whose instances play this role. Equivalent to ``GetPlayerTypes(transaction, Transitive)``. + + + See also + + + <<#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction_,IRoleType::GetPlayerTypes>>(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetPlayerTypes + +[source,cs] +---- +IEnumerable< IThingType > TypeDB.Driver.Api.IRoleType.GetPlayerTypes(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves the ``ThingType``s whose instances play this role. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction_] +==== GetRelationInstances + +[source,cs] +---- +IEnumerable< IRelation > TypeDB.Driver.Api.IRoleType.GetRelationInstances(ITypeDBTransaction transaction) +---- + + + +Retrieves the ``Relation`` instances that this role is related to. Equivalent to ``GetRelationInstances(transaction, Transitive)`` + + + See also + + + <<#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction_,IRoleType::GetRelationInstances>>(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IRelation >` + +[#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetRelationInstances + +[source,cs] +---- +IEnumerable< IRelation > TypeDB.Driver.Api.IRoleType.GetRelationInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves the ``Relation`` instances that this role is related to. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and indirect relation, ``Explicit`` for direct relation only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRelation >` + +[#_IEnumerable__IRelationType___TypeDB_Driver_Api_IRoleType_GetRelationTypes___ITypeDBTransaction_transaction_] +==== GetRelationTypes + +[source,cs] +---- +IEnumerable< IRelationType > TypeDB.Driver.Api.IRoleType.GetRelationTypes(ITypeDBTransaction transaction) +---- + + + +Retrieves ``RelationType``s that this role is related to (directly or indirectly). + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRelationType >` + +[#_bool_IConcept__TypeDB_Driver_Api_IRoleType_IsRoleType___] +==== IsRoleType + +[source,cs] +---- +bool IConcept. TypeDB.Driver.Api.IRoleType.IsRoleType() +---- + + + +Checks if the concept is a ``IRoleType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +// end::methods[] + diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc new file mode 100644 index 0000000000..a614a307c9 --- /dev/null +++ b/csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc @@ -0,0 +1,139 @@ +[#_TypeDB_Driver_Api_IThingType_Annotation] +=== TypeDB.Driver.Api.IThingType.Annotation + +*Package*: `TypeDB.Driver.Api.IThingType.Annotation` + + + +Annotation + +// tag::methods[] +[#_override_bool_TypeDB_Driver_Api_IThingType_Annotation_Equals___object_obj_] +==== Equals + +[source,cs] +---- +override bool TypeDB.Driver.Api.IThingType.Annotation.Equals(object? obj) +---- + + + +Checks if this ``Annotation`` is equal to another object. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `obj` a| Object to compare with a| +|=== + +[caption=""] +.Returns +`override bool` + +[#_override_int_TypeDB_Driver_Api_IThingType_Annotation_GetHashCode___] +==== GetHashCode + +[source,cs] +---- +override int TypeDB.Driver.Api.IThingType.Annotation.GetHashCode() +---- + + + +@hidden + +[caption=""] +.Returns +`override int` + +[#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsKey___] +==== IsKey + +[source,cs] +---- +bool TypeDB.Driver.Api.IThingType.Annotation.IsKey() +---- + + + +Checks if this ``Annotation`` is a ``@key`` annotation. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsUnique___] +==== IsUnique + +[source,cs] +---- +bool TypeDB.Driver.Api.IThingType.Annotation.IsUnique() +---- + + + +Checks if this ``Annotation`` is a ``@unique`` annotation. + + +[caption=""] +.Returns +`bool` + +[#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewKey___] +==== NewKey + +[source,cs] +---- +static Annotation TypeDB.Driver.Api.IThingType.Annotation.NewKey() +---- + + + +Produces a ``@key`` annotation. + + +[caption=""] +.Returns +`static Annotation` + +[#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewUnique___] +==== NewUnique + +[source,cs] +---- +static Annotation TypeDB.Driver.Api.IThingType.Annotation.NewUnique() +---- + + + +Produces a ``@unique`` annotation. + + +[caption=""] +.Returns +`static Annotation` + +[#_override_string_TypeDB_Driver_Api_IThingType_Annotation_ToString___] +==== ToString + +[source,cs] +---- +override string TypeDB.Driver.Api.IThingType.Annotation.ToString() +---- + + + +Retrieves a string representation of this ``Annotation``. + + +[caption=""] +.Returns +`override string` + +// end::methods[] + diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IThingType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IThingType.adoc new file mode 100644 index 0000000000..36cfa75164 --- /dev/null +++ b/csharp/docs/schema/TypeDB.Driver.Api.IThingType.adoc @@ -0,0 +1,693 @@ +[#_TypeDB_Driver_Api_IThingType_Interface_Reference] +=== TypeDB.Driver.Api.IThingType Interface Reference + +*Package*: `TypeDB.Driver.Api.IThingType Interface Reference` + +*Supertypes:* + +* `TypeDB.Driver.Api.IType` +* `TypeDB.Driver.Api.IConcept` + +// tag::methods[] +[#_IThingType_IConcept__TypeDB_Driver_Api_IThingType_AsThingType___] +==== AsThingType + +[source,cs] +---- +IThingType IConcept. TypeDB.Driver.Api.IThingType.AsThingType() +---- + + + +Casts the concept to ``IThingType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IThingType IConcept.` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IThingType_GetInstances___ITypeDBTransaction_transaction_] +==== GetInstances + +[source,cs] +---- +IEnumerable< IThing > TypeDB.Driver.Api.IThingType.GetInstances(ITypeDBTransaction transaction) +---- + + + +Retrieves all ``IThing`` objects that are instances of this ``IThingType`` or its subtypes. Equivalent to ``GetInstances(transaction, Transitive)`` + + + See also + + + ThingType::GetInstances(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IThingType_GetInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetInstances + +[source,cs] +---- +IEnumerable< IThing > TypeDB.Driver.Api.IThingType.GetInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves ``IThing`` objects that are instances of this exact ``IThingType``, OR this ``IThingType`` and any of its subtypes + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Explicit`` for direct instances only, ``Transitive`` to include instances of subtypes a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction_] +==== GetOwns + +[source,cs] +---- +IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType_] +==== GetOwns + +[source,cs] +---- +IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, IValue.ValueType valueType) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] +==== GetOwns + +[source,cs] +---- +IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, ICollection< Annotation > annotations) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__ICollection__Annotation___annotations_] +==== GetOwns + +[source,cs] +---- +IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, ICollection< Annotation > annotations) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetOwns + +[source,cs] +---- +IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__IConcept_Transitivity_transitivity_] +==== GetOwns + +[source,cs] +---- +IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, IConcept.Transitivity transitivity) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] +==== GetOwns + +[source,cs] +---- +IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] +==== GetOwns + +[source,cs] +---- +IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `valueType` a| If specified, only attribute types of this ``ValueType`` will be retrieved. a| +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| +a| `annotations` a| Only retrieve attribute types owned with annotations. a| +|=== + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_Promise__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwnsOverridden___ITypeDBTransaction_transaction__IAttributeType_attributeType_] +==== GetOwnsOverridden + +[source,cs] +---- +Promise< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwnsOverridden(ITypeDBTransaction transaction, IAttributeType attributeType) +---- + + + +Retrieves an ``IAttributeType``, ownership of which is overridden for this ``IThingType`` by a given ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attributeType` a| The ``IAttributeType`` that overrides requested ``IAttributeType`` a| +|=== + +[caption=""] +.Returns +`Promise< IAttributeType >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThingType_GetPlays___ITypeDBTransaction_transaction_] +==== GetPlays + +[source,cs] +---- +IEnumerable< IRoleType > TypeDB.Driver.Api.IThingType.GetPlays(ITypeDBTransaction transaction) +---- + + + +Retrieves all direct and inherited roles that are allowed to be played by the instances of this ``IThingType``. + + + See also + + + ThingType::GetPlays(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThingType_GetPlays___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetPlays + +[source,cs] +---- +IEnumerable< IRoleType > TypeDB.Driver.Api.IThingType.GetPlays(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves all direct and inherited (or direct only) roles that are allowed to be played by the instances of this ``IThingType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| transitivity: ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_Promise__IRoleType___TypeDB_Driver_Api_IThingType_GetPlaysOverridden___ITypeDBTransaction_transaction__IRoleType_roleType_] +==== GetPlaysOverridden + +[source,cs] +---- +Promise< IRoleType > TypeDB.Driver.Api.IThingType.GetPlaysOverridden(ITypeDBTransaction transaction, IRoleType roleType) +---- + + + +Retrieves a ``IRoleType`` that is overridden by the given ``role_type`` for this ``IThingType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleType` a| The ``IRoleType`` that overrides an inherited role a| +|=== + +[caption=""] +.Returns +`Promise< IRoleType >` + +[#_Promise__string___TypeDB_Driver_Api_IThingType_GetSyntax___ITypeDBTransaction_transaction_] +==== GetSyntax + +[source,cs] +---- +Promise< string > TypeDB.Driver.Api.IThingType.GetSyntax(ITypeDBTransaction transaction) +---- + + + +Produces a pattern for creating this ``IThingType`` in a ``define`` query. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< string >` + +[#_bool_IConcept__TypeDB_Driver_Api_IThingType_IsThingType___] +==== IsThingType + +[source,cs] +---- +bool IConcept. TypeDB.Driver.Api.IThingType.IsThingType() +---- + + + +Checks if the concept is a ``IThingType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetAbstract___ITypeDBTransaction_transaction_] +==== SetAbstract + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThingType.SetAbstract(ITypeDBTransaction transaction) +---- + + + +Set a ``IThingType`` to be abstract, meaning it cannot have instances. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__IAttributeType_overriddenType__ICollection__Annotation___annotations_] +==== SetOwns + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThingType.SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, IAttributeType? overriddenType, ICollection< Annotation > annotations) +---- + + + +Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. Optionally, overriding a previously declared ownership. Optionally, adds annotations to the ownership. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attributeType` a| The ``IAttributeType`` to be owned by the instances of this type. a| +a| `overriddenType` a| The ``IAttributeType`` that this attribute ownership overrides, if applicable. a| +a| `annotations` a| Adds annotations to the ownership. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__IAttributeType_overriddenType_] +==== SetOwns + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThingType.SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, IAttributeType overriddenType) +---- + + + +Allows the instances of this ``IThingType`` to own the given ``IAttributeType``, + + + See also + + + ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__ICollection__Annotation___annotations_] +==== SetOwns + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThingType.SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, ICollection< Annotation > annotations) +---- + + + +Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. + + + See also + + + ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType_] +==== SetOwns + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThingType.SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType) +---- + + + +Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. + + + See also + + + ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetPlays___ITypeDBTransaction_transaction__IRoleType_roleType_] +==== SetPlays + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThingType.SetPlays(ITypeDBTransaction transaction, IRoleType roleType) +---- + + + +Allows the instances of this ``IThingType`` to play the given role. + + + See also + + + ThingType::SetPlays(ITypeDBTransaction, IRoleType, IRoleType) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetPlays___ITypeDBTransaction_transaction__IRoleType_roleType__IRoleType_overriddenType_] +==== SetPlays + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThingType.SetPlays(ITypeDBTransaction transaction, IRoleType roleType, IRoleType overriddenType) +---- + + + +Allows the instances of this ``IThingType`` to play the given role. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleType` a| The role to be played by the instances of this type a| +a| `overriddenType` a| The role type that this role overrides, if applicable a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetAbstract___ITypeDBTransaction_transaction_] +==== UnsetAbstract + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThingType.UnsetAbstract(ITypeDBTransaction transaction) +---- + + + +Set a ``IThingType`` to be non-abstract, meaning it can have instances. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType_] +==== UnsetOwns + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThingType.UnsetOwns(ITypeDBTransaction transaction, IAttributeType attributeType) +---- + + + +Disallows the instances of this ``IThingType`` from owning the given ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attributeType` a| The ``IAttributeType`` to not be owned by the type. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetPlays___ITypeDBTransaction_transaction__IRoleType_roleType_] +==== UnsetPlays + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IThingType.UnsetPlays(ITypeDBTransaction transaction, IRoleType roleType) +---- + + + +Disallows the instances of this ``IThingType`` from playing the given role. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleType` a| The role to not be played by the instances of this type. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IType.adoc new file mode 100644 index 0000000000..f4f49607d9 --- /dev/null +++ b/csharp/docs/schema/TypeDB.Driver.Api.IType.adoc @@ -0,0 +1,270 @@ +[#_TypeDB_Driver_Api_IType_Interface_Reference] +=== TypeDB.Driver.Api.IType Interface Reference + +*Package*: `TypeDB.Driver.Api.IType Interface Reference` + +*Supertypes:* + +* `TypeDB.Driver.Api.IConcept` + +// tag::methods[] +[#_IType_IConcept__TypeDB_Driver_Api_IType_AsType___] +==== AsType + +[source,cs] +---- +IType IConcept. TypeDB.Driver.Api.IType.AsType() +---- + + + +Casts the concept to ``IType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IType IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IType_Delete___ITypeDBTransaction_transaction_] +==== Delete + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IType.Delete(ITypeDBTransaction transaction) +---- + + + +Deletes this type from the database. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSubtypes___ITypeDBTransaction_transaction_] +==== GetSubtypes + +[source,cs] +---- +IEnumerable< IType > TypeDB.Driver.Api.IType.GetSubtypes(ITypeDBTransaction transaction) +---- + + + +Retrieves all direct and indirect subtypes of the type. Equivalent to ``GetSubtypes(transaction, Transitive)`` + + + See also + + + Type::GetSubtypes(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IType >` + +[#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSubtypes___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetSubtypes + +[source,cs] +---- +IEnumerable< IType > TypeDB.Driver.Api.IType.GetSubtypes(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves all direct and indirect (or direct only) subtypes of the type. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IType >` + +[#_Promise__IType___TypeDB_Driver_Api_IType_GetSupertype___ITypeDBTransaction_transaction_] +==== GetSupertype + +[source,cs] +---- +Promise< IType > TypeDB.Driver.Api.IType.GetSupertype(ITypeDBTransaction transaction) +---- + + + +Retrieves the most immediate supertype of the type. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< IType >` + +[#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSupertypes___ITypeDBTransaction_transaction_] +==== GetSupertypes + +[source,cs] +---- +IEnumerable< IType > TypeDB.Driver.Api.IType.GetSupertypes(ITypeDBTransaction transaction) +---- + + + +Retrieves all supertypes of the type. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IType >` + +[#_bool_TypeDB_Driver_Api_IType_IsAbstract___] +==== IsAbstract + +[source,cs] +---- +bool TypeDB.Driver.Api.IType.IsAbstract() +---- + + + +Checks if the type is prevented from having data instances (i.e., ``abstract``). + + +[caption=""] +.Returns +`bool` + +[#_Promise__bool___TypeDB_Driver_Api_IType_IsDeleted___ITypeDBTransaction_transaction_] +==== IsDeleted + +[source,cs] +---- +Promise< bool > TypeDB.Driver.Api.IType.IsDeleted(ITypeDBTransaction transaction) +---- + + + +Check if the concept has been deleted. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< bool >` + +[#_bool_TypeDB_Driver_Api_IType_IsRoot___] +==== IsRoot + +[source,cs] +---- +bool TypeDB.Driver.Api.IType.IsRoot() +---- + + + +Checks if the type is a root type. + + +[caption=""] +.Returns +`bool` + +[#_bool_IConcept__TypeDB_Driver_Api_IType_IsType___] +==== IsType + +[source,cs] +---- +bool IConcept. TypeDB.Driver.Api.IType.IsType() +---- + + + +Checks if the concept is a ``IType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IType_SetLabel___ITypeDBTransaction_transaction__string_label_] +==== SetLabel + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IType.SetLabel(ITypeDBTransaction transaction, string label) +---- + + + +Renames the label of the type. The new label must remain unique. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `label` a| The new ``Label`` to be given to the type. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/session/TypeDB.Driver.Api.ITypeDBSession.adoc b/csharp/docs/session/TypeDB.Driver.Api.ITypeDBSession.adoc new file mode 100644 index 0000000000..6dd0dd4349 --- /dev/null +++ b/csharp/docs/session/TypeDB.Driver.Api.ITypeDBSession.adoc @@ -0,0 +1,145 @@ +[#_TypeDB_Driver_Api_ITypeDBSession_Interface_Reference] +=== TypeDB.Driver.Api.ITypeDBSession Interface Reference + +*Package*: `TypeDB.Driver.Api.ITypeDBSession Interface Reference` + +// tag::methods[] +[#_void_TypeDB_Driver_Api_ITypeDBSession_Close___] +==== Close + +[source,cs] +---- +void TypeDB.Driver.Api.ITypeDBSession.Close() +---- + + + +Closes the session. Before opening a new session, the session currently open should first be closed. + + +[caption=""] +.Returns +`void` + +[#_bool_TypeDB_Driver_Api_ITypeDBSession_IsOpen___] +==== IsOpen + +[source,cs] +---- +bool TypeDB.Driver.Api.ITypeDBSession.IsOpen() +---- + + + +Checks whether this session is open. + + +[caption=""] +.Returns +`bool` + +[#_void_TypeDB_Driver_Api_ITypeDBSession_OnClose___Action_function_] +==== OnClose + +[source,cs] +---- +void TypeDB.Driver.Api.ITypeDBSession.OnClose(Action function) +---- + + + +Registers a callback function which will be executed when this session is closed. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `function` a| The callback function. a| +|=== + +[caption=""] +.Returns +`void` + +[#_void_TypeDB_Driver_Api_ITypeDBSession_OnReopen___Action_function_] +==== OnReopen + +[source,cs] +---- +void TypeDB.Driver.Api.ITypeDBSession.OnReopen(Action function) +---- + + + +Registers a callback function which will be executed when this session is reopened. A session may be closed if it times out, or loses the connection to the database. In such situations, the session is reopened automatically when opening a new transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `function` a| The callback function. a| +|=== + +[caption=""] +.Returns +`void` + +[#_ITypeDBTransaction_TypeDB_Driver_Api_ITypeDBSession_Transaction___TransactionType_type_] +==== Transaction + +[source,cs] +---- +ITypeDBTransaction TypeDB.Driver.Api.ITypeDBSession.Transaction(TransactionType type) +---- + + + +Opens a transaction on the database connected to the session with default options. + + + See also + + + ITypeDBSession::Transaction(TransactionType, TypeDBOptions) + + + +[caption=""] +.Returns +`ITypeDBTransaction` + +[#_ITypeDBTransaction_TypeDB_Driver_Api_ITypeDBSession_Transaction___TransactionType_type__TypeDBOptions_options_] +==== Transaction + +[source,cs] +---- +ITypeDBTransaction TypeDB.Driver.Api.ITypeDBSession.Transaction(TransactionType type, TypeDBOptions options) +---- + + + +Opens a transaction to perform read or write queries on the database connected to the session. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `type` a| The type of transaction to be created (Read or Write) a| +a| `options` a| Options for the session a| +|=== + +[caption=""] +.Returns +`ITypeDBTransaction` + +// end::methods[] + diff --git a/csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc b/csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc new file mode 100644 index 0000000000..f67a93bcaf --- /dev/null +++ b/csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc @@ -0,0 +1,459 @@ +[#_TypeDB_Driver_Api_TypeDBOptions] +=== TypeDB.Driver.Api.TypeDBOptions + +*Package*: `TypeDB.Driver.Api.TypeDBOptions` + + + +TypeDB session and transaction options. ``TypeDBOptions`` object can be used to override the default server behaviour. + +// tag::methods[] +[#_bool_TypeDB_Driver_Api_TypeDBOptions_Explain___] +==== Explain + +[source,cs] +---- +bool? TypeDB.Driver.Api.TypeDBOptions.Explain() +---- + + + +Returns the value set for the explanation in this ``TypeDBOptions`` object. If set to ``true``, explanations for queries are enabled. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Explain___bool_explain_] +==== Explain + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Explain(bool explain) +---- + + + +Explicitly enables or disables explanations. If set to ``true``, enables explanations for queries. Only affects read transactions. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `explain` a| Explicitly enable or disable explanations a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_bool_TypeDB_Driver_Api_TypeDBOptions_Infer___] +==== Infer + +[source,cs] +---- +bool? TypeDB.Driver.Api.TypeDBOptions.Infer() +---- + + + +Returns the value set for the inference in this ``TypeDBOptions`` object. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Infer___bool_infer_] +==== Infer + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Infer(bool infer) +---- + + + +Explicitly enables or disables inference. Only settable at transaction level and above. Only affects read transactions. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `infer` a| Explicitly enable or disable inference a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_bool_TypeDB_Driver_Api_TypeDBOptions_Parallel___] +==== Parallel + +[source,cs] +---- +bool? TypeDB.Driver.Api.TypeDBOptions.Parallel() +---- + + + +Returns the value set for the parallel execution in this ``TypeDBOptions`` object. If set to ``true``, the server uses parallel instead of single-threaded execution. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Parallel___bool_parallel_] +==== Parallel + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Parallel(bool parallel) +---- + + + +Explicitly enables or disables parallel execution. If set to ``true``, the server uses parallel instead of single-threaded execution. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `parallel` a| Explicitly enable or disable parallel execution a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_bool_TypeDB_Driver_Api_TypeDBOptions_Prefetch___] +==== Prefetch + +[source,cs] +---- +bool? TypeDB.Driver.Api.TypeDBOptions.Prefetch() +---- + + + +Returns the value set for the prefetching in this ``TypeDBOptions`` object. If set to ``true``, the first batch of answers is streamed to the driver even without an explicit request for it. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Prefetch___bool_prefetch_] +==== Prefetch + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Prefetch(bool prefetch) +---- + + + +Explicitly enables or disables prefetching. If set to ``true``, the first batch of answers is streamed to the driver even without an explicit request for it. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `prefetch` a| Explicitly enable or disable prefetching a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_int_TypeDB_Driver_Api_TypeDBOptions_PrefetchSize___] +==== PrefetchSize + +[source,cs] +---- +int? TypeDB.Driver.Api.TypeDBOptions.PrefetchSize() +---- + + + +Returns the value set for the prefetch size in this ``TypeDBOptions`` object. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request. + + +[caption=""] +.Returns +`int?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_PrefetchSize___int_prefetchSize_] +==== PrefetchSize + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.PrefetchSize(int prefetchSize) +---- + + + +Explicitly sets a prefetch size. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `prefetchSize` a| Number of answers that the server should send before the driver issues a fresh request a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_bool_TypeDB_Driver_Api_TypeDBOptions_ReadAnyReplica___] +==== ReadAnyReplica + +[source,cs] +---- +bool? TypeDB.Driver.Api.TypeDBOptions.ReadAnyReplica() +---- + + + +Returns the value set for reading data from any replica in this ``TypeDBOptions`` object. If set to ``True``, enables reading data from any replica, potentially boosting read throughput. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_ReadAnyReplica___bool_readAnyReplica_] +==== ReadAnyReplica + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.ReadAnyReplica(bool readAnyReplica) +---- + + + +Explicitly enables or disables reading data from any replica. If set to ``True``, enables reading data from any replica, potentially boosting read throughput. Only settable in TypeDB Cloud. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `readAnyReplica` a| Explicitly enable or disable reading data from any replica a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_int_TypeDB_Driver_Api_TypeDBOptions_SchemaLockAcquireTimeoutMillis___] +==== SchemaLockAcquireTimeoutMillis + +[source,cs] +---- +int? TypeDB.Driver.Api.TypeDBOptions.SchemaLockAcquireTimeoutMillis() +---- + + + +Returns the value set for the schema lock acquire timeout in this ``TypeDBOptions`` object. If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock. + + +[caption=""] +.Returns +`int?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_SchemaLockAcquireTimeoutMillis___int_schemaLockAcquireTimeoutMillis_] +==== SchemaLockAcquireTimeoutMillis + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.SchemaLockAcquireTimeoutMillis(int schemaLockAcquireTimeoutMillis) +---- + + + +Explicitly sets schema lock acquire timeout. If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `schemaLockAcquireTimeoutMillis` a| How long the driver should wait if opening a session or transaction is blocked by a schema write lock. a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_int_TypeDB_Driver_Api_TypeDBOptions_SessionIdleTimeoutMillis___] +==== SessionIdleTimeoutMillis + +[source,cs] +---- +int? TypeDB.Driver.Api.TypeDBOptions.SessionIdleTimeoutMillis() +---- + + + +Returns the value set for the session idle timeout in this ``TypeDBOptions`` object. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. + + +[caption=""] +.Returns +`int?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_SessionIdleTimeoutMillis___int_sessionIdleTimeoutMillis_] +==== SessionIdleTimeoutMillis + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.SessionIdleTimeoutMillis(int sessionIdleTimeoutMillis) +---- + + + +Explicitly sets a session idle timeout. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `sessionIdleTimeoutMillis` a| timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_bool_TypeDB_Driver_Api_TypeDBOptions_TraceInference___] +==== TraceInference + +[source,cs] +---- +bool? TypeDB.Driver.Api.TypeDBOptions.TraceInference() +---- + + + +Returns the value set for reasoning tracing in this ``TypeDBOptions`` object. If set to ``true``, reasoning tracing graphs are output in the logging directory. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_TraceInference___bool_traceInference_] +==== TraceInference + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.TraceInference(bool traceInference) +---- + + + +Explicitly enables or disables reasoning tracing. If set to ``true``, reasoning tracing graphs are output in the logging directory. Should be used with ``parallel = False``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `traceInference` a| Explicitly enable or disable reasoning tracing a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_int_TypeDB_Driver_Api_TypeDBOptions_TransactionTimeoutMillis___] +==== TransactionTimeoutMillis + +[source,cs] +---- +int? TypeDB.Driver.Api.TypeDBOptions.TransactionTimeoutMillis() +---- + + + +Returns the value set for the transaction timeout in this ``TypeDBOptions`` object. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions. + + +[caption=""] +.Returns +`int?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_TransactionTimeoutMillis___int_transactionTimeoutMillis_] +==== TransactionTimeoutMillis + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.TransactionTimeoutMillis(int transactionTimeoutMillis) +---- + + + +Explicitly set a transaction timeout. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transactionTimeoutMillis` a| Timeout for killing transactions automatically. a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_TypeDB_Driver_Api_TypeDBOptions_TypeDBOptions___] +==== TypeDBOptions + +[source,cs] +---- +TypeDB.Driver.Api.TypeDBOptions.TypeDBOptions() +---- + + + +Produces a new ``TypeDBOptions`` object. + + +[caption=""] +.Returns +`TypeDB.Driver.Api.TypeDBOptions.TypeDBOptions` + +// end::methods[] + diff --git a/csharp/docs/test/TypeDB.Driver.Api.IThingType.Annotation.adoc b/csharp/docs/test/TypeDB.Driver.Api.IThingType.Annotation.adoc new file mode 100644 index 0000000000..a614a307c9 --- /dev/null +++ b/csharp/docs/test/TypeDB.Driver.Api.IThingType.Annotation.adoc @@ -0,0 +1,139 @@ +[#_TypeDB_Driver_Api_IThingType_Annotation] +=== TypeDB.Driver.Api.IThingType.Annotation + +*Package*: `TypeDB.Driver.Api.IThingType.Annotation` + + + +Annotation + +// tag::methods[] +[#_override_bool_TypeDB_Driver_Api_IThingType_Annotation_Equals___object_obj_] +==== Equals + +[source,cs] +---- +override bool TypeDB.Driver.Api.IThingType.Annotation.Equals(object? obj) +---- + + + +Checks if this ``Annotation`` is equal to another object. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `obj` a| Object to compare with a| +|=== + +[caption=""] +.Returns +`override bool` + +[#_override_int_TypeDB_Driver_Api_IThingType_Annotation_GetHashCode___] +==== GetHashCode + +[source,cs] +---- +override int TypeDB.Driver.Api.IThingType.Annotation.GetHashCode() +---- + + + +@hidden + +[caption=""] +.Returns +`override int` + +[#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsKey___] +==== IsKey + +[source,cs] +---- +bool TypeDB.Driver.Api.IThingType.Annotation.IsKey() +---- + + + +Checks if this ``Annotation`` is a ``@key`` annotation. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsUnique___] +==== IsUnique + +[source,cs] +---- +bool TypeDB.Driver.Api.IThingType.Annotation.IsUnique() +---- + + + +Checks if this ``Annotation`` is a ``@unique`` annotation. + + +[caption=""] +.Returns +`bool` + +[#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewKey___] +==== NewKey + +[source,cs] +---- +static Annotation TypeDB.Driver.Api.IThingType.Annotation.NewKey() +---- + + + +Produces a ``@key`` annotation. + + +[caption=""] +.Returns +`static Annotation` + +[#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewUnique___] +==== NewUnique + +[source,cs] +---- +static Annotation TypeDB.Driver.Api.IThingType.Annotation.NewUnique() +---- + + + +Produces a ``@unique`` annotation. + + +[caption=""] +.Returns +`static Annotation` + +[#_override_string_TypeDB_Driver_Api_IThingType_Annotation_ToString___] +==== ToString + +[source,cs] +---- +override string TypeDB.Driver.Api.IThingType.Annotation.ToString() +---- + + + +Retrieves a string representation of this ``Annotation``. + + +[caption=""] +.Returns +`override string` + +// end::methods[] + diff --git a/csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc b/csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc new file mode 100644 index 0000000000..12e40f0a1a --- /dev/null +++ b/csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc @@ -0,0 +1,573 @@ +[#_TypeDB_Driver_Api_IQueryManager_Interface_Reference] +=== TypeDB.Driver.Api.IQueryManager Interface Reference + +*Package*: `TypeDB.Driver.Api.IQueryManager Interface Reference` + + + +Provides methods for executing TypeQL queries in the transaction. + +// tag::methods[] +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query_] +==== Define + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IQueryManager.Define(string query) +---- + + + +Performs a TypeQL Define query with default options. + + + See also + + + <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query__TypeDBOptions_options_,IQueryManager::Define(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query__TypeDBOptions_options_] +==== Define + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IQueryManager.Define(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Define query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Define query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query_] +==== Delete + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IQueryManager.Delete(string query) +---- + + + +Performs a TypeQL Delete query with default options. + + + See also + + + <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query__TypeDBOptions_options_,IQueryManager::Delete(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query__TypeDBOptions_options_] +==== Delete + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IQueryManager.Delete(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Delete query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Delete query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable_] +==== Explain + +[source,cs] +---- +IEnumerable< IExplanation > TypeDB.Driver.Api.IQueryManager.Explain(IConceptMap.IExplainable explainable) +---- + + + +Performs a TypeQL Explain query with default options. + + + See also + + + <<#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable_,IQueryManager::Explain>>(IConceptMap.IExplainable, TypeDBOptions) + + + +[caption=""] +.Returns +`IEnumerable< IExplanation >` + +[#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable__TypeDBOptions_options_] +==== Explain + +[source,cs] +---- +IEnumerable< IExplanation > TypeDB.Driver.Api.IQueryManager.Explain(IConceptMap.IExplainable explainable, TypeDBOptions options) +---- + + + +Performs a TypeQL Explain query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `explainable` a| The IExplainable to be explained a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IExplanation >` + +[#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query_] +==== Fetch + +[source,cs] +---- +IEnumerable< JObject > TypeDB.Driver.Api.IQueryManager.Fetch(string query) +---- + + + +Performs a TypeQL Fetch (Fetch) with default options. + + + See also + + + <<#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query__TypeDBOptions_options_,IQueryManager::Fetch(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< JObject >` + +[#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query__TypeDBOptions_options_] +==== Fetch + +[source,cs] +---- +IEnumerable< JObject > TypeDB.Driver.Api.IQueryManager.Fetch(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Fetch (Fetch) query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Fetch (Fetch) query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< JObject >` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query_] +==== Get + +[source,cs] +---- +IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Get(string query) +---- + + + +Performs a TypeQL Get (Get) with default options. + + + See also + + + <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query__TypeDBOptions_options_,IQueryManager::Get(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query__TypeDBOptions_options_] +==== Get + +[source,cs] +---- +IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Get(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Get (Get) query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Get (Get) query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +[#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query_] +==== GetAggregate + +[source,cs] +---- +Promise< IValue > TypeDB.Driver.Api.IQueryManager.GetAggregate(string query) +---- + + + +Performs a TypeQL Get Aggregate query with default options. + + + See also + + + <<#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query__TypeDBOptions_options_,IQueryManager::GetAggregate(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`Promise< IValue >` + +[#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query__TypeDBOptions_options_] +==== GetAggregate + +[source,cs] +---- +Promise< IValue > TypeDB.Driver.Api.IQueryManager.GetAggregate(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Get Aggregate query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Get Aggregate query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`Promise< IValue >` + +[#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query_] +==== GetGroup + +[source,cs] +---- +IEnumerable< IConceptMapGroup > TypeDB.Driver.Api.IQueryManager.GetGroup(string query) +---- + + + +Performs a TypeQL Get Group query with default options. + + + See also + + + <<#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query__TypeDBOptions_options_,IQueryManager::GetGroup(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< IConceptMapGroup >` + +[#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query__TypeDBOptions_options_] +==== GetGroup + +[source,cs] +---- +IEnumerable< IConceptMapGroup > TypeDB.Driver.Api.IQueryManager.GetGroup(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Get Group query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Get Group query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IConceptMapGroup >` + +[#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query_] +==== GetGroupAggregate + +[source,cs] +---- +IEnumerable< IValueGroup > TypeDB.Driver.Api.IQueryManager.GetGroupAggregate(string query) +---- + + + +Performs a TypeQL Get Group Aggregate query with default options. + + + See also + + + <<#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query__TypeDBOptions_options_,IQueryManager::GetGroupAggregate(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< IValueGroup >` + +[#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query__TypeDBOptions_options_] +==== GetGroupAggregate + +[source,cs] +---- +IEnumerable< IValueGroup > TypeDB.Driver.Api.IQueryManager.GetGroupAggregate(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Get Group Aggregate query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Get Group Aggregate query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IValueGroup >` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query_] +==== Insert + +[source,cs] +---- +IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Insert(string query) +---- + + + +Performs a TypeQL Insert query with default options. + + + See also + + + <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query__TypeDBOptions_options_,IQueryManager::Insert(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query__TypeDBOptions_options_] +==== Insert + +[source,cs] +---- +IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Insert(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Insert query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Insert query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query_] +==== Undefine + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IQueryManager.Undefine(string query) +---- + + + +Performs a TypeQL Undefine query with default options. + + + See also + + + <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query__TypeDBOptions_options_,IQueryManager::Undefine(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query__TypeDBOptions_options_] +==== Undefine + +[source,cs] +---- +VoidPromise TypeDB.Driver.Api.IQueryManager.Undefine(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Undefine query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Undefine query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query_] +==== Update + +[source,cs] +---- +IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Update(string query) +---- + + + +Performs a TypeQL Update query with default options. + + + See also + + + <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query__TypeDBOptions_options_,IQueryManager::Update(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query__TypeDBOptions_options_] +==== Update + +[source,cs] +---- +IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Update(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Update query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Update query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +// end::methods[] + diff --git a/csharp/docs/transaction/TypeDB.Driver.Api.ITypeDBTransaction.adoc b/csharp/docs/transaction/TypeDB.Driver.Api.ITypeDBTransaction.adoc new file mode 100644 index 0000000000..35abef37d7 --- /dev/null +++ b/csharp/docs/transaction/TypeDB.Driver.Api.ITypeDBTransaction.adoc @@ -0,0 +1,102 @@ +[#_TypeDB_Driver_Api_ITypeDBTransaction_Interface_Reference] +=== TypeDB.Driver.Api.ITypeDBTransaction Interface Reference + +*Package*: `TypeDB.Driver.Api.ITypeDBTransaction Interface Reference` + +// tag::methods[] +[#_void_TypeDB_Driver_Api_ITypeDBTransaction_Close___] +==== Close + +[source,cs] +---- +void TypeDB.Driver.Api.ITypeDBTransaction.Close() +---- + + + +Closes the transaction. + + +[caption=""] +.Returns +`void` + +[#_void_TypeDB_Driver_Api_ITypeDBTransaction_Commit___] +==== Commit + +[source,cs] +---- +void TypeDB.Driver.Api.ITypeDBTransaction.Commit() +---- + + + +Commits the changes made via this transaction to the TypeDB database. Whether or not the transaction is committed successfully, it gets closed after the commit call. + + +[caption=""] +.Returns +`void` + +[#_bool_TypeDB_Driver_Api_ITypeDBTransaction_IsOpen___] +==== IsOpen + +[source,cs] +---- +bool TypeDB.Driver.Api.ITypeDBTransaction.IsOpen() +---- + + + +Checks whether this transaction is open. + + +[caption=""] +.Returns +`bool` + +[#_void_TypeDB_Driver_Api_ITypeDBTransaction_OnClose___Action__Exception___function_] +==== OnClose + +[source,cs] +---- +void TypeDB.Driver.Api.ITypeDBTransaction.OnClose(Action< Exception > function) +---- + + + +Registers a callback function which will be executed when this transaction is closed. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `function` a| The callback function. a| +|=== + +[caption=""] +.Returns +`void` + +[#_void_TypeDB_Driver_Api_ITypeDBTransaction_Rollback___] +==== Rollback + +[source,cs] +---- +void TypeDB.Driver.Api.ITypeDBTransaction.Rollback() +---- + + + +Rolls back the uncommitted changes made via this transaction. + + +[caption=""] +.Returns +`void` + +// end::methods[] + diff --git a/csharp/docs_structure.bzl b/csharp/docs_structure.bzl new file mode 100644 index 0000000000..51103fde49 --- /dev/null +++ b/csharp/docs_structure.bzl @@ -0,0 +1,67 @@ +# +# Copyright (C) 2022 Vaticle +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +dir_mapping = { + "TypeDB.Driver.Api.ITypeDBTransaction.adoc": "transaction", + "TypeDB.Driver.Api.TransactionType.adoc": "transaction", + "TypeDB.Driver.Api.IQueryManager.adoc": "transaction", + "TypeDB.Driver.Api.IExplanation.adoc": "answer", + "TypeDB.Driver.Api.IConceptMap.Explainable.adoc": "answer", + "TypeDB.Driver.Api.IConceptMap.Explainables.adoc": "answer", + "TypeDB.Driver.Api.IConceptMap.adoc": "answer", + "TypeDB.Driver.Api.IConceptMap.IExplainable.adoc": "answer", + "TypeDB.Driver.Api.IConceptMap.IExplainables.adoc": "answer", + "TypeDB.Driver.Api.IConceptMapGroup.adoc": "answer", + "TypeDB.Driver.Api.IValueGroup.adoc": "answer", + "TypeDB.Driver.Common.Promise__T__.adoc": "answer", + "TypeDB.Driver.Common.VoidPromise.adoc": "answer", + "TypeDB.Driver.TypeDB.adoc": "connection", + "TypeDB.Driver.Api.ITypeDBDriver.adoc": "connection", + "TypeDB.Driver.Api.TypeDBCredential.adoc": "connection", + "TypeDB.Driver.Api.IUserManager.adoc": "connection", + "TypeDB.Driver.Api.IDatabase.IReplica.adoc": "connection", + "TypeDB.Driver.Api.IUser.adoc": "connection", + "TypeDB.Driver.Api.IDatabase.adoc": "connection", + "TypeDB.Driver.Api.IDatabaseManager.adoc": "connection", + "TypeDB.Driver.Api.IRule.adoc": "logic", + "TypeDB.Driver.Api.ILogicManager.adoc": "logic", + "TypeDB.Driver.Api.IValue.Type.adoc": "schema", + "TypeDB.Driver.Api.IRelationType.adoc": "schema", + "TypeDB.Driver.Api.IAttributeType.adoc": "schema", + "TypeDB.Driver.Api.IRoleType.adoc": "schema", + "TypeDB.Driver.Api.IEntityType.adoc": "schema", + "TypeDB.Driver.Api.IThingType.Annotation.adoc": "schema", + "TypeDB.Driver.Api.IThingType.adoc": "schema", + "TypeDB.Driver.Api.IConcept.Transitivity.adoc": "schema", + "TypeDB.Driver.Api.IType.adoc": "schema", + "TypeDB.Driver.Api.Label.adoc": "schema", + "TypeDB.Driver.Api.IConcept.adoc": "concept", + "TypeDB.Driver.Api.IConceptManager.adoc": "concept", + "TypeDB.Driver.Api.IRelation.adoc": "data", + "TypeDB.Driver.Api.IEntity.adoc": "data", + "TypeDB.Driver.Api.IAttribute.adoc": "data", + "TypeDB.Driver.Api.IValue.adoc": "data", + "TypeDB.Driver.Api.IThing.adoc": "data", + "TypeDB.Driver.Api.ITypeDBSession.adoc": "session", + "TypeDB.Driver.Api.SessionType.adoc": "session", + "TypeDB.Driver.Api.TypeDBOptions.adoc": "session", + "TypeDB.Driver.Common.TypeDBDriverException.adoc": "errors", +} diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index 90edae4224..c664ace7af 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -65,39 +65,15 @@ class DoxygenParserCsharp : Callable { Files.createDirectory(docsDir) } val classes: MutableList = ArrayList() - // Namespace file for the enums & typedefs - run { - val namespacefile = File(inputDirectoryName).resolve("html/namespace_type_d_b.html") - assert(namespacefile.exists()) - val html = File(namespacefile.path).readText(Charsets.UTF_8) - val parsed = Jsoup.parse(html) - - // Typedefs - val typeDefFile = getFile(docsDir, "typedefs.adoc") - typeDefFile.writeText("") - val typeDefTBody = - parsed.select("tr.heading").first { element -> element.text().equals("Typedefs") }.parent()!! - typeDefTBody.select("tr").filter { tr -> - tr.className().startsWith("memitem") - }.map { - parseTypeDef(it!!) - }.forEach { - if (it.isNotEmpty()) typeDefFile.appendText(it.toAsciiDoc("cs")) - } - // Enums - parsed.select("td.memname").filter { element -> - element.text().startsWith("enum") - }.map { element -> element.parents().select(".memitem").first() }.forEach { - val parsedEnum = parseEnum(it!!) - if (parsedEnum.isNotEmpty()) classes.add(parsedEnum) - } - } + // TODO: Parse enums? // class files File(inputDirectoryName).walkTopDown().filter { - it.toString().startsWith("csharp/doxygen_docs/html/class_type_") && it.toString().endsWith(".html") - && !it.toString().contains("-members") + (it.toString().startsWith("csharp/doxygen_docs/html/class_type_") + || it.toString().startsWith("csharp/doxygen_docs/html/interface_type_")) + && it.toString().endsWith(".html") + && !it.toString().contains("-members") }.forEach { val html = File(it.path).readText(Charsets.UTF_8) val parsed = Jsoup.parse(html) @@ -337,6 +313,6 @@ class DoxygenParserCsharp : Callable { } private fun generateFilename(className: String): String { - return className.replace("[<> ,]".toRegex(), "_") + return className.replace("[<> ,]".toRegex(), "_").replace("_Interface_Reference", "") } } From 0debecb7f0d7ef391ab3e4f497c1cce1fdc2b72f Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 21 Mar 2024 09:03:59 +0000 Subject: [PATCH 026/118] Add structs to generation --- tool/docs/csharp/DoxygenParserCsharp.kt | 28 ++----------------------- 1 file changed, 2 insertions(+), 26 deletions(-) diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index c664ace7af..ede6050c53 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -71,7 +71,8 @@ class DoxygenParserCsharp : Callable { // class files File(inputDirectoryName).walkTopDown().filter { (it.toString().startsWith("csharp/doxygen_docs/html/class_type_") - || it.toString().startsWith("csharp/doxygen_docs/html/interface_type_")) + || it.toString().startsWith("csharp/doxygen_docs/html/interface_type_") + || it.toString().startsWith("csharp/doxygen_docs/html/struct_type_")) && it.toString().endsWith(".html") && !it.toString().contains("-members") }.forEach { @@ -129,31 +130,6 @@ class DoxygenParserCsharp : Callable { return Pair(map, idToAnchor) } - private fun parseTypeDef(element: Element): Class { - val memItemLeft = element.selectFirst("td.memItemLeft") - if (memItemLeft != null) { - if (memItemLeft.text().startsWith("typedef")) { - val actual = element.selectFirst("td.memItemLeft")!!.text().substringAfter("typedef ") - val alias = element.selectFirst("td.memItemRight")!!.text() - return Class( - name = alias, - anchor = replaceSymbolsForAnchor(alias), - description = listOf("Alias for ${replaceLocalLinks(HashMap(), actual)}"), - ) - } else if (memItemLeft.text().startsWith("using")) { - val usingEquality = element.selectFirst("td.memItemRight")!! - val actual = usingEquality.text().substringAfter("=").trim() - val alias = usingEquality.text().substringBefore("=").trim() - return Class( - name = alias, - anchor = replaceSymbolsForAnchor(alias), - description = listOf("Alias for $actual") - ) - } - } - return Class("") - } - private fun parseClass(document: Element): Class { // If we want inherited members, consider doxygen's INLINE_INHERITED_MEMB instead of the javadoc approach val fullyQualifiedName = document.selectFirst("div .title")!!.text() From fe064106ee048c648dd2d4900b543563545b6a17 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 21 Mar 2024 09:49:20 +0000 Subject: [PATCH 027/118] Add test logs --- tool/docs/csharp/DoxygenParserCsharp.kt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index ede6050c53..c8876fc869 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -123,10 +123,13 @@ class DoxygenParserCsharp : Callable { } } map[heading] = members + print("Result for now: $map") } + if (missingDeclarations.isNotEmpty()) { println("Missing some member declarations:\n\t-" + missingDeclarations.joinToString("\n\t-")) } + return Pair(map, idToAnchor) } From 2f9c7af259614821c2574e776df16539cd948798 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 21 Mar 2024 14:12:58 +0000 Subject: [PATCH 028/118] Progress with c# docs --- csharp/Api/Concept/Value/IValue.cs | 16 +++++++ .../Test/Integration/Examples/ExamplesTest.cs | 2 +- .../answer/TypeDB.Driver.Api.IConceptMap.adoc | 23 ++++++++-- .../TypeDB.Driver.Api.IExplanation.adoc | 4 +- .../TypeDB.Driver.Api.IDatabase.IReplica.adoc | 4 +- .../connection/TypeDB.Driver.Api.IUser.adoc | 2 +- .../TypeDB.Driver.Api.IUserManager.adoc | 12 ++--- .../docs/data/TypeDB.Driver.Api.IValue.adoc | 26 +++++------ .../TypeDB.Driver.Api.IRelationType.adoc | 28 ++++++------ ...peDB.Driver.Api.IThingType.Annotation.adoc | 14 +++--- .../TypeDB.Driver.Api.TypeDBOptions.adoc | 42 +++++++++--------- .../TypeDB.Driver.Api.IQueryManager.adoc | 44 +++++++++---------- tool/docs/csharp/DoxygenParserCsharp.kt | 27 +++++++++--- 13 files changed, 146 insertions(+), 98 deletions(-) diff --git a/csharp/Api/Concept/Value/IValue.cs b/csharp/Api/Concept/Value/IValue.cs index e2e58e5ac4..1c23d11525 100644 --- a/csharp/Api/Concept/Value/IValue.cs +++ b/csharp/Api/Concept/Value/IValue.cs @@ -176,6 +176,14 @@ IValue IConcept.AsValue() */ System.DateTime AsDateTime(); + /** + * chefkjlawlfawawfafawf + * + *

Examples

+ * 
+         * value.vafjwfflw();
+         *
+ */ public enum ValueType { Object = Pinvoke.ValueType.Object, @@ -187,6 +195,14 @@ public enum ValueType } } + /** + * !!!! + * + *

Examples

+ * 
+         * value.??FAWL:F
+         *
+ */ public static class ValueTypeExtensions { /** diff --git a/csharp/Test/Integration/Examples/ExamplesTest.cs b/csharp/Test/Integration/Examples/ExamplesTest.cs index fd7548595c..b366a153c1 100644 --- a/csharp/Test/Integration/Examples/ExamplesTest.cs +++ b/csharp/Test/Integration/Examples/ExamplesTest.cs @@ -40,7 +40,7 @@ private void ProcessPersonInsertResult( var result = results[0]; Assert.AreEqual(2, result.GetVariables().Count()); - Assert.AreEqual(2, result.Concepts.Count()); + Assert.AreEqual(2, result.GetConcepts().Count()); var entity = result.Get(variableName); Assert.IsNotNull(entity); diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc index abb01c1bb2..57dfbdd536 100644 --- a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc +++ b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc @@ -11,7 +11,7 @@ Contains a mapping of variables to concepts. [#_IConcept_TypeDB_Driver_Api_IConceptMap_Get___string_variable_] ==== Get -[source,cs] +[source,csharp] ---- IConcept TypeDB.Driver.Api.IConceptMap.Get(string variable) ---- @@ -34,10 +34,27 @@ a| `variable` a| The string representation of a variable a| .Returns `IConcept` +[#_IEnumerable__IConcept___TypeDB_Driver_Api_IConceptMap_GetConcepts___] +==== GetConcepts + +[source,csharp] +---- +IEnumerable< IConcept > TypeDB.Driver.Api.IConceptMap.GetConcepts() +---- + + + +Returns a collection of all concepts in this ``IConceptMap``. + + +[caption=""] +.Returns +`IEnumerable< IConcept >` + [#_Dictionary__string__IConcept___TypeDB_Driver_Api_IConceptMap_GetMap___] ==== GetMap -[source,cs] +[source,csharp] ---- Dictionary< string, IConcept > TypeDB.Driver.Api.IConceptMap.GetMap() ---- @@ -54,7 +71,7 @@ Returns the inner ``Dictionary`` (``Map`` as a common TypeDB term) where keys ar [#_IEnumerable__string___TypeDB_Driver_Api_IConceptMap_GetVariables___] ==== GetVariables -[source,cs] +[source,csharp] ---- IEnumerable< string > TypeDB.Driver.Api.IConceptMap.GetVariables() ---- diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc index 0ac7838b7a..2229ff5eee 100644 --- a/csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc +++ b/csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc @@ -11,7 +11,7 @@ An explanation of which rule was used for inferring the explained concept, the c [#_ISet__string___TypeDB_Driver_Api_IExplanation_GetQueryVariables___] ==== GetQueryVariables -[source,cs] +[source,csharp] ---- ISet< string > TypeDB.Driver.Api.IExplanation.GetQueryVariables() ---- @@ -28,7 +28,7 @@ Retrieves the query variables for this ``Explanation``. [#_ISet__string___TypeDB_Driver_Api_IExplanation_QueryVariableMapping___string_variable_] ==== QueryVariableMapping -[source,cs] +[source,csharp] ---- ISet< string > TypeDB.Driver.Api.IExplanation.QueryVariableMapping(string variable) ---- diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc index 9d955bb393..160227f9bc 100644 --- a/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc +++ b/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc @@ -11,7 +11,7 @@ The metadata and state of an individual raft replica of a database. [#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPreferred___] ==== IsPreferred -[source,cs] +[source,csharp] ---- bool TypeDB.Driver.Api.IDatabase.IReplica.IsPreferred() ---- @@ -27,7 +27,7 @@ Checks whether this is the preferred replica of the raft cluster. If true, Opera [#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPrimary___] ==== IsPrimary -[source,cs] +[source,csharp] ---- bool TypeDB.Driver.Api.IDatabase.IReplica.IsPrimary() ---- diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc index 5774723dd8..3ecf0d66f0 100644 --- a/csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc +++ b/csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc @@ -11,7 +11,7 @@ TypeDB user information [#_void_TypeDB_Driver_Api_IUser_UpdatePassword___string_passwordOld__string_passwordNew_] ==== UpdatePassword -[source,cs] +[source,csharp] ---- void TypeDB.Driver.Api.IUser.UpdatePassword(string passwordOld, string passwordNew) ---- diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc index a80a52fe56..bc37e4a1b7 100644 --- a/csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc +++ b/csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc @@ -11,7 +11,7 @@ Provides access to all user management methods. [#_bool_TypeDB_Driver_Api_IUserManager_Contains___string_username_] ==== Contains -[source,cs] +[source,csharp] ---- bool TypeDB.Driver.Api.IUserManager.Contains(string username) ---- @@ -37,7 +37,7 @@ a| `username` a| The user name to be checked a| [#_void_TypeDB_Driver_Api_IUserManager_Create___string_username__string_password_] ==== Create -[source,cs] +[source,csharp] ---- void TypeDB.Driver.Api.IUserManager.Create(string username, string password) ---- @@ -64,7 +64,7 @@ a| `password` a| The password of the user to be created a| [#_void_TypeDB_Driver_Api_IUserManager_Delete___string_username_] ==== Delete -[source,cs] +[source,csharp] ---- void TypeDB.Driver.Api.IUserManager.Delete(string username) ---- @@ -90,7 +90,7 @@ a| `username` a| The name of the user to be deleted a| [#_IUser_TypeDB_Driver_Api_IUserManager_Get___string_username_] ==== Get -[source,cs] +[source,csharp] ---- IUser? TypeDB.Driver.Api.IUserManager.Get(string username) ---- @@ -116,7 +116,7 @@ a| `username` a| The name of the user to retrieve a| [#_ISet__IUser___TypeDB_Driver_Api_IUserManager_GetAll___] ==== GetAll -[source,cs] +[source,csharp] ---- ISet< IUser > TypeDB.Driver.Api.IUserManager.GetAll() ---- @@ -133,7 +133,7 @@ Retrieves all users which exist on the TypeDB server. [#_void_TypeDB_Driver_Api_IUserManager_SetPassword___string_username__string_password_] ==== SetPassword -[source,cs] +[source,csharp] ---- void TypeDB.Driver.Api.IUserManager.SetPassword(string username, string password) ---- diff --git a/csharp/docs/data/TypeDB.Driver.Api.IValue.adoc b/csharp/docs/data/TypeDB.Driver.Api.IValue.adoc index ea660f4037..6268af77c2 100644 --- a/csharp/docs/data/TypeDB.Driver.Api.IValue.adoc +++ b/csharp/docs/data/TypeDB.Driver.Api.IValue.adoc @@ -11,7 +11,7 @@ [#_bool_TypeDB_Driver_Api_IValue_AsBool___] ==== AsBool -[source,cs] +[source,csharp] ---- bool TypeDB.Driver.Api.IValue.AsBool() ---- @@ -28,7 +28,7 @@ Returns a ``bool`` value of this value concept. If the value has another type, r [#_System_DateTime_TypeDB_Driver_Api_IValue_AsDateTime___] ==== AsDateTime -[source,cs] +[source,csharp] ---- System.DateTime TypeDB.Driver.Api.IValue.AsDateTime() ---- @@ -45,7 +45,7 @@ Returns a ``datetime`` value of this value concept. This value contains raw date [#_double_TypeDB_Driver_Api_IValue_AsDouble___] ==== AsDouble -[source,cs] +[source,csharp] ---- double TypeDB.Driver.Api.IValue.AsDouble() ---- @@ -62,7 +62,7 @@ Returns a ``double`` value of this value concept. If the value has another type, [#_long_TypeDB_Driver_Api_IValue_AsLong___] ==== AsLong -[source,cs] +[source,csharp] ---- long TypeDB.Driver.Api.IValue.AsLong() ---- @@ -79,7 +79,7 @@ Returns a ``long`` value of this value concept. If the value has another type, r [#_string_TypeDB_Driver_Api_IValue_AsString___] ==== AsString -[source,cs] +[source,csharp] ---- string TypeDB.Driver.Api.IValue.AsString() ---- @@ -96,7 +96,7 @@ Returns a ``string`` value of this value concept. If the value has another type, [#_object_TypeDB_Driver_Api_IValue_AsUntyped___] ==== AsUntyped -[source,cs] +[source,csharp] ---- object TypeDB.Driver.Api.IValue.AsUntyped() ---- @@ -113,7 +113,7 @@ Returns an untyped ``object`` value of this value concept. This is useful for va [#_IValue_IConcept__TypeDB_Driver_Api_IValue_AsValue___] ==== AsValue -[source,cs] +[source,csharp] ---- IValue IConcept. TypeDB.Driver.Api.IValue.AsValue() ---- @@ -134,7 +134,7 @@ Implements TypeDB.Driver.Api.IConcept. [#_bool_TypeDB_Driver_Api_IValue_IsBool___] ==== IsBool -[source,cs] +[source,csharp] ---- bool TypeDB.Driver.Api.IValue.IsBool() ---- @@ -151,7 +151,7 @@ Returns ``True`` if the value which this value concept holds is of type ``bool`` [#_bool_TypeDB_Driver_Api_IValue_IsDateTime___] ==== IsDateTime -[source,cs] +[source,csharp] ---- bool TypeDB.Driver.Api.IValue.IsDateTime() ---- @@ -168,7 +168,7 @@ Returns ``True`` if the value which this value concept holds is of type ``dateti [#_bool_TypeDB_Driver_Api_IValue_IsDouble___] ==== IsDouble -[source,cs] +[source,csharp] ---- bool TypeDB.Driver.Api.IValue.IsDouble() ---- @@ -185,7 +185,7 @@ Returns ``True`` if the value which this value concept holds is of type ``double [#_bool_TypeDB_Driver_Api_IValue_IsLong___] ==== IsLong -[source,cs] +[source,csharp] ---- bool TypeDB.Driver.Api.IValue.IsLong() ---- @@ -202,7 +202,7 @@ Returns ``True`` if the value which this value concept holds is of type ``long`` [#_bool_TypeDB_Driver_Api_IValue_IsString___] ==== IsString -[source,cs] +[source,csharp] ---- bool TypeDB.Driver.Api.IValue.IsString() ---- @@ -219,7 +219,7 @@ Returns ``True`` if the value which this value concept holds is of type ``string [#_bool_IConcept__TypeDB_Driver_Api_IValue_IsValue___] ==== IsValue -[source,cs] +[source,csharp] ---- bool IConcept. TypeDB.Driver.Api.IValue.IsValue() ---- diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc index 437150f777..242f9c1a10 100644 --- a/csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc +++ b/csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc @@ -17,7 +17,7 @@ Relation types (or subtypes of the relation root type) represent relationships b [#_IRelationType_IConcept__TypeDB_Driver_Api_IRelationType_AsRelationType___] ==== AsRelationType -[source,cs] +[source,csharp] ---- IRelationType IConcept. TypeDB.Driver.Api.IRelationType.AsRelationType() ---- @@ -38,7 +38,7 @@ Implements TypeDB.Driver.Api.IConcept. [#_Promise__IRelation___TypeDB_Driver_Api_IRelationType_Create___ITypeDBTransaction_transaction_] ==== Create -[source,cs] +[source,csharp] ---- Promise< IRelation > TypeDB.Driver.Api.IRelationType.Create(ITypeDBTransaction transaction) ---- @@ -64,7 +64,7 @@ a| `transaction` a| The current transaction a| [#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction_] ==== GetRelates -[source,cs] +[source,csharp] ---- IEnumerable< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelates(ITypeDBTransaction transaction) ---- @@ -88,7 +88,7 @@ Retrieves roles that this ``IRelationType`` relates to directly or via inheritan [#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] ==== GetRelates -[source,cs] +[source,csharp] ---- IEnumerable< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelates(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ---- @@ -115,7 +115,7 @@ a| `transitivity` a| ``Transitive`` for direct and inherited relates, ``Explicit [#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction__string_roleLabel_] ==== GetRelates -[source,cs] +[source,csharp] ---- Promise< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelates(ITypeDBTransaction transaction, string roleLabel) ---- @@ -142,7 +142,7 @@ a| `roleLabel` a| Label of the role we wish to retrieve a| [#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__IRoleType_roleType_] ==== GetRelatesOverridden -[source,cs] +[source,csharp] ---- Promise< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelatesOverridden(ITypeDBTransaction transaction, IRoleType roleType) ---- @@ -166,7 +166,7 @@ Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label`` [#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__string_roleLabel_] ==== GetRelatesOverridden -[source,cs] +[source,csharp] ---- Promise< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelatesOverridden(ITypeDBTransaction transaction, string roleLabel) ---- @@ -193,7 +193,7 @@ a| `roleLabel` a| Label of the role that overrides an inherited role a| [#_bool_IConcept__TypeDB_Driver_Api_IRelationType_IsRelationType___] ==== IsRelationType -[source,cs] +[source,csharp] ---- bool IConcept. TypeDB.Driver.Api.IRelationType.IsRelationType() ---- @@ -214,7 +214,7 @@ Implements TypeDB.Driver.Api.IConcept. [#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel_] ==== SetRelates -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IRelationType.SetRelates(ITypeDBTransaction transaction, string roleLabel) ---- @@ -238,7 +238,7 @@ Sets the new role that this ``IRelationType`` relates to. [#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel__IRoleType_overriddenType_] ==== SetRelates -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IRelationType.SetRelates(ITypeDBTransaction transaction, string roleLabel, IRoleType overriddenType) ---- @@ -262,7 +262,7 @@ Sets the new role that this ``IRelationType`` relates to. [#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel__string_overriddenLabel_] ==== SetRelates -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IRelationType.SetRelates(ITypeDBTransaction transaction, string roleLabel, string? overriddenLabel) ---- @@ -290,7 +290,7 @@ a| `overriddenLabel` a| The label being overridden, if applicable a| [#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetSupertype___ITypeDBTransaction_transaction__IRelationType_superRelationType_] ==== SetSupertype -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IRelationType.SetSupertype(ITypeDBTransaction transaction, IRelationType superRelationType) ---- @@ -317,7 +317,7 @@ a| `superRelationType` a| The ``IRelationType`` to set as the supertype of this [#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__IRoleType_roleType_] ==== UnsetRelates -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IRelationType.UnsetRelates(ITypeDBTransaction transaction, IRoleType roleType) ---- @@ -341,7 +341,7 @@ Disallows this ``IRelationType`` from relating to the given role. [#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__string_roleLabel_] ==== UnsetRelates -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IRelationType.UnsetRelates(ITypeDBTransaction transaction, string roleLabel) ---- diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc index a614a307c9..0544922cdc 100644 --- a/csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc +++ b/csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc @@ -11,7 +11,7 @@ Annotation [#_override_bool_TypeDB_Driver_Api_IThingType_Annotation_Equals___object_obj_] ==== Equals -[source,cs] +[source,csharp] ---- override bool TypeDB.Driver.Api.IThingType.Annotation.Equals(object? obj) ---- @@ -37,7 +37,7 @@ a| `obj` a| Object to compare with a| [#_override_int_TypeDB_Driver_Api_IThingType_Annotation_GetHashCode___] ==== GetHashCode -[source,cs] +[source,csharp] ---- override int TypeDB.Driver.Api.IThingType.Annotation.GetHashCode() ---- @@ -53,7 +53,7 @@ override int TypeDB.Driver.Api.IThingType.Annotation.GetHashCode() [#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsKey___] ==== IsKey -[source,cs] +[source,csharp] ---- bool TypeDB.Driver.Api.IThingType.Annotation.IsKey() ---- @@ -70,7 +70,7 @@ Checks if this ``Annotation`` is a ``@key`` annotation. [#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsUnique___] ==== IsUnique -[source,cs] +[source,csharp] ---- bool TypeDB.Driver.Api.IThingType.Annotation.IsUnique() ---- @@ -87,7 +87,7 @@ Checks if this ``Annotation`` is a ``@unique`` annotation. [#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewKey___] ==== NewKey -[source,cs] +[source,csharp] ---- static Annotation TypeDB.Driver.Api.IThingType.Annotation.NewKey() ---- @@ -104,7 +104,7 @@ Produces a ``@key`` annotation. [#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewUnique___] ==== NewUnique -[source,cs] +[source,csharp] ---- static Annotation TypeDB.Driver.Api.IThingType.Annotation.NewUnique() ---- @@ -121,7 +121,7 @@ Produces a ``@unique`` annotation. [#_override_string_TypeDB_Driver_Api_IThingType_Annotation_ToString___] ==== ToString -[source,cs] +[source,csharp] ---- override string TypeDB.Driver.Api.IThingType.Annotation.ToString() ---- diff --git a/csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc b/csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc index f67a93bcaf..c4ae66f554 100644 --- a/csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc +++ b/csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc @@ -11,7 +11,7 @@ TypeDB session and transaction options. ``TypeDBOptions`` object can be used to [#_bool_TypeDB_Driver_Api_TypeDBOptions_Explain___] ==== Explain -[source,cs] +[source,csharp] ---- bool? TypeDB.Driver.Api.TypeDBOptions.Explain() ---- @@ -28,7 +28,7 @@ Returns the value set for the explanation in this ``TypeDBOptions`` object. If s [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Explain___bool_explain_] ==== Explain -[source,cs] +[source,csharp] ---- TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Explain(bool explain) ---- @@ -54,7 +54,7 @@ a| `explain` a| Explicitly enable or disable explanations a| [#_bool_TypeDB_Driver_Api_TypeDBOptions_Infer___] ==== Infer -[source,cs] +[source,csharp] ---- bool? TypeDB.Driver.Api.TypeDBOptions.Infer() ---- @@ -71,7 +71,7 @@ Returns the value set for the inference in this ``TypeDBOptions`` object. [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Infer___bool_infer_] ==== Infer -[source,cs] +[source,csharp] ---- TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Infer(bool infer) ---- @@ -97,7 +97,7 @@ a| `infer` a| Explicitly enable or disable inference a| [#_bool_TypeDB_Driver_Api_TypeDBOptions_Parallel___] ==== Parallel -[source,cs] +[source,csharp] ---- bool? TypeDB.Driver.Api.TypeDBOptions.Parallel() ---- @@ -114,7 +114,7 @@ Returns the value set for the parallel execution in this ``TypeDBOptions`` objec [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Parallel___bool_parallel_] ==== Parallel -[source,cs] +[source,csharp] ---- TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Parallel(bool parallel) ---- @@ -140,7 +140,7 @@ a| `parallel` a| Explicitly enable or disable parallel execution a| [#_bool_TypeDB_Driver_Api_TypeDBOptions_Prefetch___] ==== Prefetch -[source,cs] +[source,csharp] ---- bool? TypeDB.Driver.Api.TypeDBOptions.Prefetch() ---- @@ -157,7 +157,7 @@ Returns the value set for the prefetching in this ``TypeDBOptions`` object. If s [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Prefetch___bool_prefetch_] ==== Prefetch -[source,cs] +[source,csharp] ---- TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Prefetch(bool prefetch) ---- @@ -183,7 +183,7 @@ a| `prefetch` a| Explicitly enable or disable prefetching a| [#_int_TypeDB_Driver_Api_TypeDBOptions_PrefetchSize___] ==== PrefetchSize -[source,cs] +[source,csharp] ---- int? TypeDB.Driver.Api.TypeDBOptions.PrefetchSize() ---- @@ -200,7 +200,7 @@ Returns the value set for the prefetch size in this ``TypeDBOptions`` object. If [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_PrefetchSize___int_prefetchSize_] ==== PrefetchSize -[source,cs] +[source,csharp] ---- TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.PrefetchSize(int prefetchSize) ---- @@ -226,7 +226,7 @@ a| `prefetchSize` a| Number of answers that the server should send before the dr [#_bool_TypeDB_Driver_Api_TypeDBOptions_ReadAnyReplica___] ==== ReadAnyReplica -[source,cs] +[source,csharp] ---- bool? TypeDB.Driver.Api.TypeDBOptions.ReadAnyReplica() ---- @@ -243,7 +243,7 @@ Returns the value set for reading data from any replica in this ``TypeDBOptions` [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_ReadAnyReplica___bool_readAnyReplica_] ==== ReadAnyReplica -[source,cs] +[source,csharp] ---- TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.ReadAnyReplica(bool readAnyReplica) ---- @@ -269,7 +269,7 @@ a| `readAnyReplica` a| Explicitly enable or disable reading data from any replic [#_int_TypeDB_Driver_Api_TypeDBOptions_SchemaLockAcquireTimeoutMillis___] ==== SchemaLockAcquireTimeoutMillis -[source,cs] +[source,csharp] ---- int? TypeDB.Driver.Api.TypeDBOptions.SchemaLockAcquireTimeoutMillis() ---- @@ -286,7 +286,7 @@ Returns the value set for the schema lock acquire timeout in this ``TypeDBOption [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_SchemaLockAcquireTimeoutMillis___int_schemaLockAcquireTimeoutMillis_] ==== SchemaLockAcquireTimeoutMillis -[source,cs] +[source,csharp] ---- TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.SchemaLockAcquireTimeoutMillis(int schemaLockAcquireTimeoutMillis) ---- @@ -312,7 +312,7 @@ a| `schemaLockAcquireTimeoutMillis` a| How long the driver should wait if openin [#_int_TypeDB_Driver_Api_TypeDBOptions_SessionIdleTimeoutMillis___] ==== SessionIdleTimeoutMillis -[source,cs] +[source,csharp] ---- int? TypeDB.Driver.Api.TypeDBOptions.SessionIdleTimeoutMillis() ---- @@ -329,7 +329,7 @@ Returns the value set for the session idle timeout in this ``TypeDBOptions`` obj [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_SessionIdleTimeoutMillis___int_sessionIdleTimeoutMillis_] ==== SessionIdleTimeoutMillis -[source,cs] +[source,csharp] ---- TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.SessionIdleTimeoutMillis(int sessionIdleTimeoutMillis) ---- @@ -355,7 +355,7 @@ a| `sessionIdleTimeoutMillis` a| timeout that allows the server to close session [#_bool_TypeDB_Driver_Api_TypeDBOptions_TraceInference___] ==== TraceInference -[source,cs] +[source,csharp] ---- bool? TypeDB.Driver.Api.TypeDBOptions.TraceInference() ---- @@ -372,7 +372,7 @@ Returns the value set for reasoning tracing in this ``TypeDBOptions`` object. If [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_TraceInference___bool_traceInference_] ==== TraceInference -[source,cs] +[source,csharp] ---- TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.TraceInference(bool traceInference) ---- @@ -398,7 +398,7 @@ a| `traceInference` a| Explicitly enable or disable reasoning tracing a| [#_int_TypeDB_Driver_Api_TypeDBOptions_TransactionTimeoutMillis___] ==== TransactionTimeoutMillis -[source,cs] +[source,csharp] ---- int? TypeDB.Driver.Api.TypeDBOptions.TransactionTimeoutMillis() ---- @@ -415,7 +415,7 @@ Returns the value set for the transaction timeout in this ``TypeDBOptions`` obje [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_TransactionTimeoutMillis___int_transactionTimeoutMillis_] ==== TransactionTimeoutMillis -[source,cs] +[source,csharp] ---- TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.TransactionTimeoutMillis(int transactionTimeoutMillis) ---- @@ -441,7 +441,7 @@ a| `transactionTimeoutMillis` a| Timeout for killing transactions automatically. [#_TypeDB_Driver_Api_TypeDBOptions_TypeDBOptions___] ==== TypeDBOptions -[source,cs] +[source,csharp] ---- TypeDB.Driver.Api.TypeDBOptions.TypeDBOptions() ---- diff --git a/csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc b/csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc index 12e40f0a1a..797bbf965b 100644 --- a/csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc +++ b/csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc @@ -11,7 +11,7 @@ Provides methods for executing TypeQL queries in the transaction. [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query_] ==== Define -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IQueryManager.Define(string query) ---- @@ -35,7 +35,7 @@ Performs a TypeQL Define query with default options. [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query__TypeDBOptions_options_] ==== Define -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IQueryManager.Define(string query, TypeDBOptions options) ---- @@ -62,7 +62,7 @@ a| `options` a| Specify query options a| [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query_] ==== Delete -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IQueryManager.Delete(string query) ---- @@ -86,7 +86,7 @@ Performs a TypeQL Delete query with default options. [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query__TypeDBOptions_options_] ==== Delete -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IQueryManager.Delete(string query, TypeDBOptions options) ---- @@ -113,7 +113,7 @@ a| `options` a| Specify query options a| [#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable_] ==== Explain -[source,cs] +[source,csharp] ---- IEnumerable< IExplanation > TypeDB.Driver.Api.IQueryManager.Explain(IConceptMap.IExplainable explainable) ---- @@ -137,7 +137,7 @@ Performs a TypeQL Explain query with default options. [#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable__TypeDBOptions_options_] ==== Explain -[source,cs] +[source,csharp] ---- IEnumerable< IExplanation > TypeDB.Driver.Api.IQueryManager.Explain(IConceptMap.IExplainable explainable, TypeDBOptions options) ---- @@ -164,7 +164,7 @@ a| `options` a| Specify query options a| [#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query_] ==== Fetch -[source,cs] +[source,csharp] ---- IEnumerable< JObject > TypeDB.Driver.Api.IQueryManager.Fetch(string query) ---- @@ -188,7 +188,7 @@ Performs a TypeQL Fetch (Fetch) with default options. [#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query__TypeDBOptions_options_] ==== Fetch -[source,cs] +[source,csharp] ---- IEnumerable< JObject > TypeDB.Driver.Api.IQueryManager.Fetch(string query, TypeDBOptions options) ---- @@ -215,7 +215,7 @@ a| `options` a| Specify query options a| [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query_] ==== Get -[source,cs] +[source,csharp] ---- IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Get(string query) ---- @@ -239,7 +239,7 @@ Performs a TypeQL Get (Get) with default options. [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query__TypeDBOptions_options_] ==== Get -[source,cs] +[source,csharp] ---- IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Get(string query, TypeDBOptions options) ---- @@ -266,7 +266,7 @@ a| `options` a| Specify query options a| [#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query_] ==== GetAggregate -[source,cs] +[source,csharp] ---- Promise< IValue > TypeDB.Driver.Api.IQueryManager.GetAggregate(string query) ---- @@ -290,7 +290,7 @@ Performs a TypeQL Get Aggregate query with default options. [#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query__TypeDBOptions_options_] ==== GetAggregate -[source,cs] +[source,csharp] ---- Promise< IValue > TypeDB.Driver.Api.IQueryManager.GetAggregate(string query, TypeDBOptions options) ---- @@ -317,7 +317,7 @@ a| `options` a| Specify query options a| [#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query_] ==== GetGroup -[source,cs] +[source,csharp] ---- IEnumerable< IConceptMapGroup > TypeDB.Driver.Api.IQueryManager.GetGroup(string query) ---- @@ -341,7 +341,7 @@ Performs a TypeQL Get Group query with default options. [#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query__TypeDBOptions_options_] ==== GetGroup -[source,cs] +[source,csharp] ---- IEnumerable< IConceptMapGroup > TypeDB.Driver.Api.IQueryManager.GetGroup(string query, TypeDBOptions options) ---- @@ -368,7 +368,7 @@ a| `options` a| Specify query options a| [#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query_] ==== GetGroupAggregate -[source,cs] +[source,csharp] ---- IEnumerable< IValueGroup > TypeDB.Driver.Api.IQueryManager.GetGroupAggregate(string query) ---- @@ -392,7 +392,7 @@ Performs a TypeQL Get Group Aggregate query with default options. [#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query__TypeDBOptions_options_] ==== GetGroupAggregate -[source,cs] +[source,csharp] ---- IEnumerable< IValueGroup > TypeDB.Driver.Api.IQueryManager.GetGroupAggregate(string query, TypeDBOptions options) ---- @@ -419,7 +419,7 @@ a| `options` a| Specify query options a| [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query_] ==== Insert -[source,cs] +[source,csharp] ---- IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Insert(string query) ---- @@ -443,7 +443,7 @@ Performs a TypeQL Insert query with default options. [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query__TypeDBOptions_options_] ==== Insert -[source,cs] +[source,csharp] ---- IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Insert(string query, TypeDBOptions options) ---- @@ -470,7 +470,7 @@ a| `options` a| Specify query options a| [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query_] ==== Undefine -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IQueryManager.Undefine(string query) ---- @@ -494,7 +494,7 @@ Performs a TypeQL Undefine query with default options. [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query__TypeDBOptions_options_] ==== Undefine -[source,cs] +[source,csharp] ---- VoidPromise TypeDB.Driver.Api.IQueryManager.Undefine(string query, TypeDBOptions options) ---- @@ -521,7 +521,7 @@ a| `options` a| Specify query options a| [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query_] ==== Update -[source,cs] +[source,csharp] ---- IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Update(string query) ---- @@ -545,7 +545,7 @@ Performs a TypeQL Update query with default options. [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query__TypeDBOptions_options_] ==== Update -[source,cs] +[source,csharp] ---- IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Update(string query, TypeDBOptions options) ---- diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index c8876fc869..4a709eca43 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -83,7 +83,7 @@ class DoxygenParserCsharp : Callable { } classes.forEach { parsedClass -> - val parsedClassAsciiDoc = parsedClass.toAsciiDoc("cs") + val parsedClassAsciiDoc = parsedClass.toAsciiDoc("csharp") val outputFile = getFile(docsDir, "${generateFilename(parsedClass.name)}.adoc") outputFile.writeText(parsedClassAsciiDoc) } @@ -108,22 +108,36 @@ class DoxygenParserCsharp : Callable { val idToAnchor: MutableMap = HashMap() document.select("table.memberdecls").forEach { table -> val heading: String = table.selectFirst("tr.heading > td > h2 > a")!!.attr("name") + println(heading) val members: MutableList = ArrayList() table.select("tr").filter { element -> element.className().matches(Regex("memitem:[a-f0-9]+")) }.forEach { element -> val id = element.className().substringAfter("memitem:") - val methodDetails = + val type = element.selectFirst("td.memItemLeft")?.text() + if (type == "enum") { + println("ENUM! $element") + val memberDetails = + document.selectFirst("div.contents > a#$id")?.nextElementSibling()?.nextElementSibling() + + val typeAndName = memberDetails?.selectFirst("div.memitem > div.memproto > table.memname > tbody > tr > td.memname")?.text()?.split(" ") + if (typeAndName != null && typeAndName.size > 1 && typeAndName[0] == "enum") { // ENUM! + println("Details: $memberDetails, typeAndName: ${typeAndName}") + } + } + + val memberDetails = document.selectFirst("div.contents > a#$id")?.nextElementSibling()?.nextElementSibling() - if (methodDetails == null) { + + if (memberDetails == null) { missingDeclarations.add(element.selectFirst("td.memItemRight")!!.text()) } else { - members.add(methodDetails) - idToAnchor[id] = replaceSymbolsForAnchor(methodDetails.select("table.memname").text()) + members.add(memberDetails) + idToAnchor[id] = replaceSymbolsForAnchor(memberDetails.select("table.memname").text()) } } map[heading] = members - print("Result for now: $map") +// print("Result for now: $map") } if (missingDeclarations.isNotEmpty()) { @@ -139,6 +153,7 @@ class DoxygenParserCsharp : Callable { .replace(Regex("Class(?: Template)? Reference.*"), "").trim() val packagePath = fullyQualifiedName.substringBeforeLast("::") val className = fullyQualifiedName.substringAfterLast("::") +// println(packagePath, className) val classAnchor = replaceSymbolsForAnchor(className) val classExamples = document.select("div.textblock > pre").map { replaceSpaces(it.text()) } val superClasses = document.select("tr.inherit_header") From 893240b75e1eb8957b97dbd323a0df5df1d54145 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 21 Mar 2024 19:21:44 +0000 Subject: [PATCH 029/118] Temporarily comment out factory builds --- .factory/automation.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/.factory/automation.yml b/.factory/automation.yml index ab09b243ac..ddb09aa7f5 100644 --- a/.factory/automation.yml +++ b/.factory/automation.yml @@ -291,6 +291,24 @@ build: # tool/test/stop-core-server.sh # exit $TEST_SUCCESS # +## test-python-integration-cloud-failover: +## machine: 4-core-16-gb +## image: vaticle-ubuntu-22.04 +## dependencies: +## - build +## type: foreground +## command: | +## export PATH="$HOME/.local/bin:$PATH" +## sudo apt-get update +## sudo apt install python3-pip -y +## python3 -m pip install -U pip +## python3 -m pip install -r python/requirements_dev.txt +## export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +## export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +## bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +## bazel run @vaticle_dependencies//distribution/artifact:create-netrc +## bazel test //python/tests/integration:test_cloud_failover --test_output=errors +# # test-nodejs-integration: # image: vaticle-ubuntu-22.04 # dependencies: From 7083f63350200dbeff46929d70604340ebec5077 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Fri, 22 Mar 2024 11:53:26 +0000 Subject: [PATCH 030/118] Add enums without examples to the parser, fix some generations and names --- csharp/Api/Concept/Value/IValue.cs | 15 +- ...B.Driver.Api.IConceptMap.IExplainable.adoc | 9 - ....Driver.Api.IConceptMap.IExplainables.adoc | 142 ---- .../answer/TypeDB.Driver.Api.IConceptMap.adoc | 89 --- .../TypeDB.Driver.Api.IConceptMapGroup.adoc | 29 - .../TypeDB.Driver.Api.IExplanation.adoc | 55 -- .../answer/TypeDB.Driver.Api.IValueGroup.adoc | 9 - .../TypeDB.Driver.Common.Promise__T__.adoc | 86 -- .../TypeDB.Driver.Common.VoidPromise.adoc | 63 -- csharp/docs/answer/typedefs.adoc | 0 .../concept/TypeDB.Driver.Api.IConcept.adoc | 426 ---------- .../TypeDB.Driver.Api.IConceptManager.adoc | 264 ------- .../TypeDB.Driver.Api.IDatabase.IReplica.adoc | 44 -- ...Database.IReplica_Interface_Reference.adoc | 44 -- .../TypeDB.Driver.Api.IDatabase.adoc | 93 --- .../TypeDB.Driver.Api.IDatabaseManager.adoc | 107 --- .../TypeDB.Driver.Api.ITypeDBDriver.adoc | 111 --- .../connection/TypeDB.Driver.Api.IUser.adoc | 57 -- .../TypeDB.Driver.Api.IUserManager.adoc | 161 ---- .../TypeDB.Driver.Api.TypeDBCredential.adoc | 118 --- .../data/TypeDB.Driver.Api.IAttribute.adoc | 110 --- .../docs/data/TypeDB.Driver.Api.IEntity.adoc | 55 -- .../data/TypeDB.Driver.Api.IRelation.adoc | 190 ----- .../docs/data/TypeDB.Driver.Api.IThing.adoc | 280 ------- .../docs/data/TypeDB.Driver.Api.IValue.adoc | 241 ------ ...B.Driver.Common.TypeDBDriverException.adoc | 93 --- .../TypeDB.Driver.Api.ILogicManager.adoc | 83 -- .../docs/logic/TypeDB.Driver.Api.IRule.adoc | 91 --- .../TypeDB.Driver.Api.IAttributeType.adoc | 746 ------------------ .../schema/TypeDB.Driver.Api.IEntityType.adoc | 113 --- .../TypeDB.Driver.Api.IRelationType.adoc | 369 --------- .../schema/TypeDB.Driver.Api.IRoleType.adoc | 238 ------ ...peDB.Driver.Api.IThingType.Annotation.adoc | 139 ---- .../schema/TypeDB.Driver.Api.IThingType.adoc | 693 ---------------- .../docs/schema/TypeDB.Driver.Api.IType.adoc | 270 ------- .../TypeDB.Driver.Api.ITypeDBSession.adoc | 145 ---- .../TypeDB.Driver.Api.TypeDBOptions.adoc | 459 ----------- ...peDB.Driver.Api.IThingType.Annotation.adoc | 139 ---- .../TypeDB.Driver.Api.IQueryManager.adoc | 573 -------------- .../TypeDB.Driver.Api.ITypeDBTransaction.adoc | 102 --- csharp/docs_structure.bzl | 87 +- java/api/concept/value/Value.java | 8 + java/docs/schema/Value.Type.adoc | 10 + 43 files changed, 66 insertions(+), 7090 deletions(-) delete mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainable.adoc delete mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainables.adoc delete mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc delete mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IConceptMapGroup.adoc delete mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc delete mode 100644 csharp/docs/answer/TypeDB.Driver.Api.IValueGroup.adoc delete mode 100644 csharp/docs/answer/TypeDB.Driver.Common.Promise__T__.adoc delete mode 100644 csharp/docs/answer/TypeDB.Driver.Common.VoidPromise.adoc delete mode 100644 csharp/docs/answer/typedefs.adoc delete mode 100644 csharp/docs/concept/TypeDB.Driver.Api.IConcept.adoc delete mode 100644 csharp/docs/concept/TypeDB.Driver.Api.IConceptManager.adoc delete mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc delete mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica_Interface_Reference.adoc delete mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IDatabase.adoc delete mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IDatabaseManager.adoc delete mode 100644 csharp/docs/connection/TypeDB.Driver.Api.ITypeDBDriver.adoc delete mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc delete mode 100644 csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc delete mode 100644 csharp/docs/connection/TypeDB.Driver.Api.TypeDBCredential.adoc delete mode 100644 csharp/docs/data/TypeDB.Driver.Api.IAttribute.adoc delete mode 100644 csharp/docs/data/TypeDB.Driver.Api.IEntity.adoc delete mode 100644 csharp/docs/data/TypeDB.Driver.Api.IRelation.adoc delete mode 100644 csharp/docs/data/TypeDB.Driver.Api.IThing.adoc delete mode 100644 csharp/docs/data/TypeDB.Driver.Api.IValue.adoc delete mode 100644 csharp/docs/errors/TypeDB.Driver.Common.TypeDBDriverException.adoc delete mode 100644 csharp/docs/logic/TypeDB.Driver.Api.ILogicManager.adoc delete mode 100644 csharp/docs/logic/TypeDB.Driver.Api.IRule.adoc delete mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IAttributeType.adoc delete mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IEntityType.adoc delete mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc delete mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IRoleType.adoc delete mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc delete mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IThingType.adoc delete mode 100644 csharp/docs/schema/TypeDB.Driver.Api.IType.adoc delete mode 100644 csharp/docs/session/TypeDB.Driver.Api.ITypeDBSession.adoc delete mode 100644 csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc delete mode 100644 csharp/docs/test/TypeDB.Driver.Api.IThingType.Annotation.adoc delete mode 100644 csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc delete mode 100644 csharp/docs/transaction/TypeDB.Driver.Api.ITypeDBTransaction.adoc diff --git a/csharp/Api/Concept/Value/IValue.cs b/csharp/Api/Concept/Value/IValue.cs index 1c23d11525..c2afcc47bb 100644 --- a/csharp/Api/Concept/Value/IValue.cs +++ b/csharp/Api/Concept/Value/IValue.cs @@ -177,11 +177,11 @@ IValue IConcept.AsValue() System.DateTime AsDateTime(); /** - * chefkjlawlfawawfafawf + * Used to specify the type of the value. * *

Examples

* 
-         * value.vafjwfflw();
+         * thingType.GetOwns(transaction, IValue.ValueType.String);
          *
*/ public enum ValueType @@ -195,14 +195,9 @@ public enum ValueType } } - /** - * !!!! - * - *

Examples

- * 
-         * value.??FAWL:F
-         *
- */ + /** + * Extension class with additional methods describing characteristics of ValueType enum values. // TODO: Is not generated in doxygen + */ public static class ValueTypeExtensions { /** diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainable.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainable.adoc deleted file mode 100644 index dbd5b20e24..0000000000 --- a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainable.adoc +++ /dev/null @@ -1,9 +0,0 @@ -[#_TypeDB_Driver_Api_IConceptMap_IExplainable_Interface_Reference] -=== TypeDB.Driver.Api.IConceptMap.IExplainable Interface Reference - -*Package*: `TypeDB.Driver.Api.IConceptMap.IExplainable Interface Reference` - - - -Contains an explainable object. - diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainables.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainables.adoc deleted file mode 100644 index b9d88a1233..0000000000 --- a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.IExplainables.adoc +++ /dev/null @@ -1,142 +0,0 @@ -[#_TypeDB_Driver_Api_IConceptMap_IExplainables_Interface_Reference] -=== TypeDB.Driver.Api.IConceptMap.IExplainables Interface Reference - -*Package*: `TypeDB.Driver.Api.IConceptMap.IExplainables Interface Reference` - - - -Contains explainable objects. - -// tag::methods[] -[#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Attribute___string_variable_] -==== Attribute - -[source,cs] ----- -IExplainable TypeDB.Driver.Api.IConceptMap.IExplainables.Attribute(string variable) ----- - - - -Retrieves the explainable attribute with the given variable name. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `variable` a| The string representation of a variable a| -|=== - -[caption=""] -.Returns -`IExplainable` - -[#_IEnumerable__KeyValuePair__string__IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetAttributes___] -==== GetAttributes - -[source,cs] ----- -IEnumerable< KeyValuePair< string, IExplainable > > TypeDB.Driver.Api.IConceptMap.IExplainables.GetAttributes() ----- - - - -Retrieves all of this ``IConceptMap``’s explainable attributes. - - -[caption=""] -.Returns -`IEnumerable< KeyValuePair< string, IExplainable > >` - -[#_IEnumerable__KeyValuePair__KeyValuePair__string__string____IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetOwnerships___] -==== GetOwnerships - -[source,cs] ----- -IEnumerable< KeyValuePair< KeyValuePair< string, string >, IExplainable > > TypeDB.Driver.Api.IConceptMap.IExplainables.GetOwnerships() ----- - - - -Retrieves all of this ``IConceptMap``’s explainable ownerships. - - -[caption=""] -.Returns -`IEnumerable< KeyValuePair< KeyValuePair< string, string >, IExplainable > >` - -[#_IEnumerable__KeyValuePair__string__IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetRelations___] -==== GetRelations - -[source,cs] ----- -IEnumerable< KeyValuePair< string, IExplainable > > TypeDB.Driver.Api.IConceptMap.IExplainables.GetRelations() ----- - - - -Retrieves all of this ``IConceptMap``’s explainable relations. - - -[caption=""] -.Returns -`IEnumerable< KeyValuePair< string, IExplainable > >` - -[#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Ownership___string_owner__string_attribute_] -==== Ownership - -[source,cs] ----- -IExplainable TypeDB.Driver.Api.IConceptMap.IExplainables.Ownership(string owner, string attribute) ----- - - - -Retrieves the explainable attribute ownership with the pair of (owner, attribute) variable names. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `owner` a| The string representation of the owner variable a| -a| `attribute` a| The string representation of the attribute variable a| -|=== - -[caption=""] -.Returns -`IExplainable` - -[#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Relation___string_variable_] -==== Relation - -[source,cs] ----- -IExplainable TypeDB.Driver.Api.IConceptMap.IExplainables.Relation(string variable) ----- - - - -Retrieves the explainable relation with the given variable name. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `variable` a| The string representation of a variable a| -|=== - -[caption=""] -.Returns -`IExplainable` - -// end::methods[] - diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc deleted file mode 100644 index 57dfbdd536..0000000000 --- a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMap.adoc +++ /dev/null @@ -1,89 +0,0 @@ -[#_TypeDB_Driver_Api_IConceptMap_Interface_Reference] -=== TypeDB.Driver.Api.IConceptMap Interface Reference - -*Package*: `TypeDB.Driver.Api.IConceptMap Interface Reference` - - - -Contains a mapping of variables to concepts. - -// tag::methods[] -[#_IConcept_TypeDB_Driver_Api_IConceptMap_Get___string_variable_] -==== Get - -[source,csharp] ----- -IConcept TypeDB.Driver.Api.IConceptMap.Get(string variable) ----- - - - -Retrieves a concept for a given variable name. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `variable` a| The string representation of a variable a| -|=== - -[caption=""] -.Returns -`IConcept` - -[#_IEnumerable__IConcept___TypeDB_Driver_Api_IConceptMap_GetConcepts___] -==== GetConcepts - -[source,csharp] ----- -IEnumerable< IConcept > TypeDB.Driver.Api.IConceptMap.GetConcepts() ----- - - - -Returns a collection of all concepts in this ``IConceptMap``. - - -[caption=""] -.Returns -`IEnumerable< IConcept >` - -[#_Dictionary__string__IConcept___TypeDB_Driver_Api_IConceptMap_GetMap___] -==== GetMap - -[source,csharp] ----- -Dictionary< string, IConcept > TypeDB.Driver.Api.IConceptMap.GetMap() ----- - - - -Returns the inner ``Dictionary`` (``Map`` as a common TypeDB term) where keys are query variables, and values are concepts. - - -[caption=""] -.Returns -`Dictionary< string, IConcept >` - -[#_IEnumerable__string___TypeDB_Driver_Api_IConceptMap_GetVariables___] -==== GetVariables - -[source,csharp] ----- -IEnumerable< string > TypeDB.Driver.Api.IConceptMap.GetVariables() ----- - - - -Returns a collection of all variables in this ``IConceptMap``. - - -[caption=""] -.Returns -`IEnumerable< string >` - -// end::methods[] - diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMapGroup.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IConceptMapGroup.adoc deleted file mode 100644 index dc83706ef7..0000000000 --- a/csharp/docs/answer/TypeDB.Driver.Api.IConceptMapGroup.adoc +++ /dev/null @@ -1,29 +0,0 @@ -[#_TypeDB_Driver_Api_IConceptMapGroup_Interface_Reference] -=== TypeDB.Driver.Api.IConceptMapGroup Interface Reference - -*Package*: `TypeDB.Driver.Api.IConceptMapGroup Interface Reference` - - - -Contains an element of the group query result. - -// tag::methods[] -[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IConceptMapGroup_GetConceptMaps___] -==== GetConceptMaps - -[source,cs] ----- -IEnumerable< IConceptMap > TypeDB.Driver.Api.IConceptMapGroup.GetConceptMaps() ----- - - - -Retrieves the ``IConceptMap``s of the group. - - -[caption=""] -.Returns -`IEnumerable< IConceptMap >` - -// end::methods[] - diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc deleted file mode 100644 index 2229ff5eee..0000000000 --- a/csharp/docs/answer/TypeDB.Driver.Api.IExplanation.adoc +++ /dev/null @@ -1,55 +0,0 @@ -[#_TypeDB_Driver_Api_IExplanation_Interface_Reference] -=== TypeDB.Driver.Api.IExplanation Interface Reference - -*Package*: `TypeDB.Driver.Api.IExplanation Interface Reference` - - - -An explanation of which rule was used for inferring the explained concept, the condition of the rule, the conclusion of the rule, and the mapping of variables between the query and the rule’s conclusion. - -// tag::methods[] -[#_ISet__string___TypeDB_Driver_Api_IExplanation_GetQueryVariables___] -==== GetQueryVariables - -[source,csharp] ----- -ISet< string > TypeDB.Driver.Api.IExplanation.GetQueryVariables() ----- - - - -Retrieves the query variables for this ``Explanation``. - - -[caption=""] -.Returns -`ISet< string >` - -[#_ISet__string___TypeDB_Driver_Api_IExplanation_QueryVariableMapping___string_variable_] -==== QueryVariableMapping - -[source,csharp] ----- -ISet< string > TypeDB.Driver.Api.IExplanation.QueryVariableMapping(string variable) ----- - - - -Retrieves the rule variables corresponding to the query variable var for this ``Explanation``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `variable` a| The query variable to map to rule variables. a| -|=== - -[caption=""] -.Returns -`ISet< string >` - -// end::methods[] - diff --git a/csharp/docs/answer/TypeDB.Driver.Api.IValueGroup.adoc b/csharp/docs/answer/TypeDB.Driver.Api.IValueGroup.adoc deleted file mode 100644 index 78fc162e4f..0000000000 --- a/csharp/docs/answer/TypeDB.Driver.Api.IValueGroup.adoc +++ /dev/null @@ -1,9 +0,0 @@ -[#_TypeDB_Driver_Api_IValueGroup_Interface_Reference] -=== TypeDB.Driver.Api.IValueGroup Interface Reference - -*Package*: `TypeDB.Driver.Api.IValueGroup Interface Reference` - - - -Contains an element of the group aggregate query result. - diff --git a/csharp/docs/answer/TypeDB.Driver.Common.Promise__T__.adoc b/csharp/docs/answer/TypeDB.Driver.Common.Promise__T__.adoc deleted file mode 100644 index 0d7b8cbf68..0000000000 --- a/csharp/docs/answer/TypeDB.Driver.Common.Promise__T__.adoc +++ /dev/null @@ -1,86 +0,0 @@ -[#_TypeDB_Driver_Common_Promise__T_] -=== TypeDB.Driver.Common.Promise< T > - -*Package*: `TypeDB.Driver.Common.Promise< T >` - - - -A ``Promise`` represents an asynchronous network operation. - -The request it represents is performed immediately. The response is only retrieved once the ``Promise`` is ``Resolve``d. - -. - -// tag::methods[] -[#_static_Promise__TTo___TypeDB_Driver_Common_Promise__T___Map__TFrom__TTo_____Func__TFrom__resolver__Func__TFrom__TTo___selector_] -==== Map< TFrom, TTo > - -[source,cs] ----- -static Promise< TTo > TypeDB.Driver.Common.Promise< T >.Map< TFrom, TTo >(Func< TFrom?> resolver, Func< TFrom, TTo > selector) ----- - - - -Helper function to map promises. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `promise` a| The function to wrap into the promise a| -a| `fn` a| The mapping function a| -|=== - -[caption=""] -.Returns -`static Promise< TTo >` - -[#_TypeDB_Driver_Common_Promise__T___Promise___Func__T__resolver_] -==== Promise - -[source,cs] ----- -TypeDB.Driver.Common.Promise< T >.Promise(Func< T?> resolver) ----- - - - -Promise constructor - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `promise` a| The function to wrap into the promise a| -|=== - -[caption=""] -.Returns -`TypeDB.Driver.Common.Promise< T >.Promise` - -[#_T_TypeDB_Driver_Common_Promise__T___Resolve___] -==== Resolve - -[source,cs] ----- -T? TypeDB.Driver.Common.Promise< T >.Resolve() ----- - - - -Retrieves the result of the Promise. - - -[caption=""] -.Returns -`T?` - -// end::methods[] - diff --git a/csharp/docs/answer/TypeDB.Driver.Common.VoidPromise.adoc b/csharp/docs/answer/TypeDB.Driver.Common.VoidPromise.adoc deleted file mode 100644 index 2ae20ce4f5..0000000000 --- a/csharp/docs/answer/TypeDB.Driver.Common.VoidPromise.adoc +++ /dev/null @@ -1,63 +0,0 @@ -[#_TypeDB_Driver_Common_VoidPromise] -=== TypeDB.Driver.Common.VoidPromise - -*Package*: `TypeDB.Driver.Common.VoidPromise` - - - -A ``VoidPromise`` represents a ``Promise`` without an operation's result. - - - See also - - - Promise - - - -// tag::methods[] -[#_void_TypeDB_Driver_Common_VoidPromise_Resolve___] -==== Resolve - -[source,cs] ----- -void TypeDB.Driver.Common.VoidPromise.Resolve() ----- - - - -Retrieves the result of the Promise. - - -[caption=""] -.Returns -`void` - -[#_TypeDB_Driver_Common_VoidPromise_VoidPromise___Action_resolver_] -==== VoidPromise - -[source,cs] ----- -TypeDB.Driver.Common.VoidPromise.VoidPromise(Action resolver) ----- - - - -Promise constructor - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `promise` a| The function to wrap into the promise a| -|=== - -[caption=""] -.Returns -`TypeDB.Driver.Common.VoidPromise.VoidPromise` - -// end::methods[] - diff --git a/csharp/docs/answer/typedefs.adoc b/csharp/docs/answer/typedefs.adoc deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/csharp/docs/concept/TypeDB.Driver.Api.IConcept.adoc b/csharp/docs/concept/TypeDB.Driver.Api.IConcept.adoc deleted file mode 100644 index 7df5f2329e..0000000000 --- a/csharp/docs/concept/TypeDB.Driver.Api.IConcept.adoc +++ /dev/null @@ -1,426 +0,0 @@ -[#_TypeDB_Driver_Api_IConcept_Interface_Reference] -=== TypeDB.Driver.Api.IConcept Interface Reference - -*Package*: `TypeDB.Driver.Api.IConcept Interface Reference` - -// tag::methods[] -[#_IAttribute_TypeDB_Driver_Api_IConcept_AsAttribute___] -==== AsAttribute - -[source,cs] ----- -IAttribute TypeDB.Driver.Api.IConcept.AsAttribute() ----- - - - -Casts the concept to ``IAttribute``. - - -Implemented in TypeDB.Driver.Api.IAttribute. - -[caption=""] -.Returns -`IAttribute` - -[#_IAttributeType_TypeDB_Driver_Api_IConcept_AsAttributeType___] -==== AsAttributeType - -[source,cs] ----- -IAttributeType TypeDB.Driver.Api.IConcept.AsAttributeType() ----- - - - -Casts the concept to ``IAttributeType``. - - -Implemented in TypeDB.Driver.Api.IAttributeType. - -[caption=""] -.Returns -`IAttributeType` - -[#_IEntity_TypeDB_Driver_Api_IConcept_AsEntity___] -==== AsEntity - -[source,cs] ----- -IEntity TypeDB.Driver.Api.IConcept.AsEntity() ----- - - - -Casts the concept to ``IEntity``. - - -Implemented in TypeDB.Driver.Api.IEntity. - -[caption=""] -.Returns -`IEntity` - -[#_IEntityType_TypeDB_Driver_Api_IConcept_AsEntityType___] -==== AsEntityType - -[source,cs] ----- -IEntityType TypeDB.Driver.Api.IConcept.AsEntityType() ----- - - - -Casts the concept to ``IEntityType``. - - -Implemented in TypeDB.Driver.Api.IEntityType. - -[caption=""] -.Returns -`IEntityType` - -[#_IRelation_TypeDB_Driver_Api_IConcept_AsRelation___] -==== AsRelation - -[source,cs] ----- -IRelation TypeDB.Driver.Api.IConcept.AsRelation() ----- - - - -Casts the concept to ``IRelation``. - - -Implemented in TypeDB.Driver.Api.IRelation. - -[caption=""] -.Returns -`IRelation` - -[#_IRelationType_TypeDB_Driver_Api_IConcept_AsRelationType___] -==== AsRelationType - -[source,cs] ----- -IRelationType TypeDB.Driver.Api.IConcept.AsRelationType() ----- - - - -Casts the concept to ``IRelationType``. - - -Implemented in TypeDB.Driver.Api.IRelationType. - -[caption=""] -.Returns -`IRelationType` - -[#_IRoleType_TypeDB_Driver_Api_IConcept_AsRoleType___] -==== AsRoleType - -[source,cs] ----- -IRoleType TypeDB.Driver.Api.IConcept.AsRoleType() ----- - - - -Casts the concept to ``IRoleType``. - - -Implemented in TypeDB.Driver.Api.IRoleType. - -[caption=""] -.Returns -`IRoleType` - -[#_IThing_TypeDB_Driver_Api_IConcept_AsThing___] -==== AsThing - -[source,cs] ----- -IThing TypeDB.Driver.Api.IConcept.AsThing() ----- - - - -Casts the concept to ``IThing``. - - -Implemented in TypeDB.Driver.Api.IThing. - -[caption=""] -.Returns -`IThing` - -[#_IThingType_TypeDB_Driver_Api_IConcept_AsThingType___] -==== AsThingType - -[source,cs] ----- -IThingType TypeDB.Driver.Api.IConcept.AsThingType() ----- - - - -Casts the concept to ``IThingType``. - - -Implemented in TypeDB.Driver.Api.IThingType. - -[caption=""] -.Returns -`IThingType` - -[#_IType_TypeDB_Driver_Api_IConcept_AsType___] -==== AsType - -[source,cs] ----- -IType TypeDB.Driver.Api.IConcept.AsType() ----- - - - -Casts the concept to ``IType``. - - -Implemented in TypeDB.Driver.Api.IType. - -[caption=""] -.Returns -`IType` - -[#_IValue_TypeDB_Driver_Api_IConcept_AsValue___] -==== AsValue - -[source,cs] ----- -IValue TypeDB.Driver.Api.IConcept.AsValue() ----- - - - -Casts the concept to ``IValue``. - - -Implemented in TypeDB.Driver.Api.IValue. - -[caption=""] -.Returns -`IValue` - -[#_bool_TypeDB_Driver_Api_IConcept_IsAttribute___] -==== IsAttribute - -[source,cs] ----- -bool TypeDB.Driver.Api.IConcept.IsAttribute() ----- - - - -Checks if the concept is an ``IAttribute``. - - -Implemented in TypeDB.Driver.Api.IAttribute. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IConcept_IsAttributeType___] -==== IsAttributeType - -[source,cs] ----- -bool TypeDB.Driver.Api.IConcept.IsAttributeType() ----- - - - -Checks if the concept is an ``IAttributeType``. - - -Implemented in TypeDB.Driver.Api.IAttributeType. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IConcept_IsEntity___] -==== IsEntity - -[source,cs] ----- -bool TypeDB.Driver.Api.IConcept.IsEntity() ----- - - - -Checks if the concept is an ``IEntity``. - - -Implemented in TypeDB.Driver.Api.IEntity. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IConcept_IsEntityType___] -==== IsEntityType - -[source,cs] ----- -bool TypeDB.Driver.Api.IConcept.IsEntityType() ----- - - - -Checks if the concept is an ``IEntityType``. - - -Implemented in TypeDB.Driver.Api.IEntityType. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IConcept_IsRelation___] -==== IsRelation - -[source,cs] ----- -bool TypeDB.Driver.Api.IConcept.IsRelation() ----- - - - -Checks if the concept is a ``IRelation``. - - -Implemented in TypeDB.Driver.Api.IRelation. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IConcept_IsRelationType___] -==== IsRelationType - -[source,cs] ----- -bool TypeDB.Driver.Api.IConcept.IsRelationType() ----- - - - -Checks if the concept is a ``IRelationType``. - - -Implemented in TypeDB.Driver.Api.IRelationType. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IConcept_IsRoleType___] -==== IsRoleType - -[source,cs] ----- -bool TypeDB.Driver.Api.IConcept.IsRoleType() ----- - - - -Checks if the concept is a ``IRoleType``. - - -Implemented in TypeDB.Driver.Api.IRoleType. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IConcept_IsThing___] -==== IsThing - -[source,cs] ----- -bool TypeDB.Driver.Api.IConcept.IsThing() ----- - - - -Checks if the concept is a ``IThing``. - - -Implemented in TypeDB.Driver.Api.IThing. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IConcept_IsThingType___] -==== IsThingType - -[source,cs] ----- -bool TypeDB.Driver.Api.IConcept.IsThingType() ----- - - - -Checks if the concept is a ``IThingType``. - - -Implemented in TypeDB.Driver.Api.IThingType. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IConcept_IsType___] -==== IsType - -[source,cs] ----- -bool TypeDB.Driver.Api.IConcept.IsType() ----- - - - -Checks if the concept is a ``IType``. - - -Implemented in TypeDB.Driver.Api.IType. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IConcept_IsValue___] -==== IsValue - -[source,cs] ----- -bool TypeDB.Driver.Api.IConcept.IsValue() ----- - - - -Checks if the concept is a ``IValue``. - - -Implemented in TypeDB.Driver.Api.IValue. - -[caption=""] -.Returns -`bool` - -// end::methods[] - diff --git a/csharp/docs/concept/TypeDB.Driver.Api.IConceptManager.adoc b/csharp/docs/concept/TypeDB.Driver.Api.IConceptManager.adoc deleted file mode 100644 index e6e8128d07..0000000000 --- a/csharp/docs/concept/TypeDB.Driver.Api.IConceptManager.adoc +++ /dev/null @@ -1,264 +0,0 @@ -[#_TypeDB_Driver_Api_IConceptManager_Interface_Reference] -=== TypeDB.Driver.Api.IConceptManager Interface Reference - -*Package*: `TypeDB.Driver.Api.IConceptManager Interface Reference` - - - -Provides access for all Concept API methods. - -// tag::methods[] -[#_Promise__IAttribute___TypeDB_Driver_Api_IConceptManager_GetAttribute___string_iid_] -==== GetAttribute - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IConceptManager.GetAttribute(string iid) ----- - - - -Retrieves an ``IAttribute`` by its iid. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `iid` a| The iid of the ``Attribute`` to retrieve. a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_Promise__IAttributeType___TypeDB_Driver_Api_IConceptManager_GetAttributeType___string_label_] -==== GetAttributeType - -[source,cs] ----- -Promise< IAttributeType > TypeDB.Driver.Api.IConceptManager.GetAttributeType(string label) ----- - - - -Retrieves an ``IAttributeType`` by its label. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `label` a| The label of the ``AttributeType`` to retrieve. a| -|=== - -[caption=""] -.Returns -`Promise< IAttributeType >` - -[#_Promise__IEntity___TypeDB_Driver_Api_IConceptManager_GetEntity___string_iid_] -==== GetEntity - -[source,cs] ----- -Promise< IEntity > TypeDB.Driver.Api.IConceptManager.GetEntity(string iid) ----- - - - -Retrieves an ``IEntity`` by its iid. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `iid` a| The iid of the ``Entity`` to retrieve. a| -|=== - -[caption=""] -.Returns -`Promise< IEntity >` - -[#_Promise__IEntityType___TypeDB_Driver_Api_IConceptManager_GetEntityType___string_label_] -==== GetEntityType - -[source,cs] ----- -Promise< IEntityType > TypeDB.Driver.Api.IConceptManager.GetEntityType(string label) ----- - - - -Retrieves an ``IEntityType`` by its label. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `label` a| The label of the ``IEntityType`` to retrieve. a| -|=== - -[caption=""] -.Returns -`Promise< IEntityType >` - -[#_Promise__IRelation___TypeDB_Driver_Api_IConceptManager_GetRelation___string_iid_] -==== GetRelation - -[source,cs] ----- -Promise< IRelation > TypeDB.Driver.Api.IConceptManager.GetRelation(string iid) ----- - - - -Retrieves a ``IRelation`` by its iid. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `iid` a| The iid of the ``Relation`` to retrieve. a| -|=== - -[caption=""] -.Returns -`Promise< IRelation >` - -[#_Promise__IRelationType___TypeDB_Driver_Api_IConceptManager_GetRelationType___string_label_] -==== GetRelationType - -[source,cs] ----- -Promise< IRelationType > TypeDB.Driver.Api.IConceptManager.GetRelationType(string label) ----- - - - -Retrieves a ``IRelationType`` by its label. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `label` a| The label of the ``IRelationType`` to retrieve. a| -|=== - -[caption=""] -.Returns -`Promise< IRelationType >` - -[#_IList__TypeDBException___TypeDB_Driver_Api_IConceptManager_GetSchemaExceptions___] -==== GetSchemaExceptions - -[source,cs] ----- -IList< TypeDBException > TypeDB.Driver.Api.IConceptManager.GetSchemaExceptions() ----- - - - -A list of all schema exceptions for the current transaction. - - -[caption=""] -.Returns -`IList< TypeDBException >` - -[#_Promise__IAttributeType___TypeDB_Driver_Api_IConceptManager_PutAttributeType___string_label__IValue_ValueType_valueType_] -==== PutAttributeType - -[source,cs] ----- -Promise< IAttributeType > TypeDB.Driver.Api.IConceptManager.PutAttributeType(string label, IValue.ValueType valueType) ----- - - - -Creates a new ``IAttributeType`` if none exists with the given label, or retrieves the existing one. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `label` a| The label of the ``IAttributeType`` to create or retrieve. a| -a| `valueType` a| The value type of the ``IAttributeType`` to create. a| -|=== - -[caption=""] -.Returns -`Promise< IAttributeType >` - -[#_Promise__IEntityType___TypeDB_Driver_Api_IConceptManager_PutEntityType___string_label_] -==== PutEntityType - -[source,cs] ----- -Promise< IEntityType > TypeDB.Driver.Api.IConceptManager.PutEntityType(string label) ----- - - - -Creates a new ``IEntityType`` if none exists with the given label, otherwise retrieves the existing one. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `label` a| The label of the ``IEntityType`` to create or retrieve. a| -|=== - -[caption=""] -.Returns -`Promise< IEntityType >` - -[#_Promise__IRelationType___TypeDB_Driver_Api_IConceptManager_PutRelationType___string_label_] -==== PutRelationType - -[source,cs] ----- -Promise< IRelationType > TypeDB.Driver.Api.IConceptManager.PutRelationType(string label) ----- - - - -Creates a new ``IRelationType`` if none exists with the given label, otherwise retrieves the existing one. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `label` a| The label of the ``IRelationType`` to create or retrieve. a| -|=== - -[caption=""] -.Returns -`Promise< IRelationType >` - -// end::methods[] - diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc deleted file mode 100644 index 160227f9bc..0000000000 --- a/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica.adoc +++ /dev/null @@ -1,44 +0,0 @@ -[#_TypeDB_Driver_Api_IDatabase_IReplica_Interface_Reference] -=== TypeDB.Driver.Api.IDatabase.IReplica Interface Reference - -*Package*: `TypeDB.Driver.Api.IDatabase.IReplica Interface Reference` - - - -The metadata and state of an individual raft replica of a database. - -// tag::methods[] -[#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPreferred___] -==== IsPreferred - -[source,csharp] ----- -bool TypeDB.Driver.Api.IDatabase.IReplica.IsPreferred() ----- - - - -Checks whether this is the preferred replica of the raft cluster. If true, Operations which can be run on any replica will prefer to use this replica. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPrimary___] -==== IsPrimary - -[source,csharp] ----- -bool TypeDB.Driver.Api.IDatabase.IReplica.IsPrimary() ----- - - - -Checks whether this is the primary replica of the raft cluster. - -[caption=""] -.Returns -`bool` - -// end::methods[] - diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica_Interface_Reference.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica_Interface_Reference.adoc deleted file mode 100644 index 9d955bb393..0000000000 --- a/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.IReplica_Interface_Reference.adoc +++ /dev/null @@ -1,44 +0,0 @@ -[#_TypeDB_Driver_Api_IDatabase_IReplica_Interface_Reference] -=== TypeDB.Driver.Api.IDatabase.IReplica Interface Reference - -*Package*: `TypeDB.Driver.Api.IDatabase.IReplica Interface Reference` - - - -The metadata and state of an individual raft replica of a database. - -// tag::methods[] -[#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPreferred___] -==== IsPreferred - -[source,cs] ----- -bool TypeDB.Driver.Api.IDatabase.IReplica.IsPreferred() ----- - - - -Checks whether this is the preferred replica of the raft cluster. If true, Operations which can be run on any replica will prefer to use this replica. - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPrimary___] -==== IsPrimary - -[source,cs] ----- -bool TypeDB.Driver.Api.IDatabase.IReplica.IsPrimary() ----- - - - -Checks whether this is the primary replica of the raft cluster. - -[caption=""] -.Returns -`bool` - -// end::methods[] - diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.adoc deleted file mode 100644 index b2aebc4241..0000000000 --- a/csharp/docs/connection/TypeDB.Driver.Api.IDatabase.adoc +++ /dev/null @@ -1,93 +0,0 @@ -[#_TypeDB_Driver_Api_IDatabase_Interface_Reference] -=== TypeDB.Driver.Api.IDatabase Interface Reference - -*Package*: `TypeDB.Driver.Api.IDatabase Interface Reference` - -// tag::methods[] -[#_void_TypeDB_Driver_Api_IDatabase_Delete___] -==== Delete - -[source,cs] ----- -void TypeDB.Driver.Api.IDatabase.Delete() ----- - - - -Deletes this database. - - -[caption=""] -.Returns -`void` - -[#_ISet__IReplica___TypeDB_Driver_Api_IDatabase_GetReplicas___] -==== GetReplicas - -[source,cs] ----- -ISet< IReplica > TypeDB.Driver.Api.IDatabase.GetReplicas() ----- - - - -Set of ``Replica`` instances for this database. Only works in TypeDB Cloud - - -[caption=""] -.Returns -`ISet< IReplica >` - -[#_string_TypeDB_Driver_Api_IDatabase_GetRuleSchema___] -==== GetRuleSchema - -[source,cs] ----- -string TypeDB.Driver.Api.IDatabase.GetRuleSchema() ----- - - - -The rules in the schema as a valid TypeQL define query string. - - -[caption=""] -.Returns -`string` - -[#_string_TypeDB_Driver_Api_IDatabase_GetSchema___] -==== GetSchema - -[source,cs] ----- -string TypeDB.Driver.Api.IDatabase.GetSchema() ----- - - - -A full schema text as a valid TypeQL define query string. - - -[caption=""] -.Returns -`string` - -[#_string_TypeDB_Driver_Api_IDatabase_GetTypeSchema___] -==== GetTypeSchema - -[source,cs] ----- -string TypeDB.Driver.Api.IDatabase.GetTypeSchema() ----- - - - -The types in the schema as a valid TypeQL define query string. - - -[caption=""] -.Returns -`string` - -// end::methods[] - diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IDatabaseManager.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IDatabaseManager.adoc deleted file mode 100644 index 6628ce084a..0000000000 --- a/csharp/docs/connection/TypeDB.Driver.Api.IDatabaseManager.adoc +++ /dev/null @@ -1,107 +0,0 @@ -[#_TypeDB_Driver_Api_IDatabaseManager_Interface_Reference] -=== TypeDB.Driver.Api.IDatabaseManager Interface Reference - -*Package*: `TypeDB.Driver.Api.IDatabaseManager Interface Reference` - - - -Provides access to all database management methods. - -// tag::methods[] -[#_bool_TypeDB_Driver_Api_IDatabaseManager_Contains___string_name_] -==== Contains - -[source,cs] ----- -bool TypeDB.Driver.Api.IDatabaseManager.Contains(string name) ----- - - - -Checks if a database with the given name exists. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `name` a| The database name to be checked a| -|=== - -[caption=""] -.Returns -`bool` - -[#_void_TypeDB_Driver_Api_IDatabaseManager_Create___string_name_] -==== Create - -[source,cs] ----- -void TypeDB.Driver.Api.IDatabaseManager.Create(string name) ----- - - - -Create a database with the given name. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `name` a| The name of the database to be created a| -|=== - -[caption=""] -.Returns -`void` - -[#_IDatabase_TypeDB_Driver_Api_IDatabaseManager_Get___string_name_] -==== Get - -[source,cs] ----- -IDatabase TypeDB.Driver.Api.IDatabaseManager.Get(string name) ----- - - - -Retrieve the database with the given name. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `name` a| The name of the database to retrieve a| -|=== - -[caption=""] -.Returns -`IDatabase` - -[#_IList__IDatabase___TypeDB_Driver_Api_IDatabaseManager_GetAll___] -==== GetAll - -[source,cs] ----- -IList< IDatabase > TypeDB.Driver.Api.IDatabaseManager.GetAll() ----- - - - -Retrieves all databases present on the TypeDB server. - - -[caption=""] -.Returns -`IList< IDatabase >` - -// end::methods[] - diff --git a/csharp/docs/connection/TypeDB.Driver.Api.ITypeDBDriver.adoc b/csharp/docs/connection/TypeDB.Driver.Api.ITypeDBDriver.adoc deleted file mode 100644 index 0a90e8225c..0000000000 --- a/csharp/docs/connection/TypeDB.Driver.Api.ITypeDBDriver.adoc +++ /dev/null @@ -1,111 +0,0 @@ -[#_TypeDB_Driver_Api_ITypeDBDriver_Interface_Reference] -=== TypeDB.Driver.Api.ITypeDBDriver Interface Reference - -*Package*: `TypeDB.Driver.Api.ITypeDBDriver Interface Reference` - -// tag::methods[] -[#_void_TypeDB_Driver_Api_ITypeDBDriver_Close___] -==== Close - -[source,cs] ----- -void TypeDB.Driver.Api.ITypeDBDriver.Close() ----- - - - -Closes the driver. Before instantiating a new driver, the driver that’s currently open should first be closed. - - -[caption=""] -.Returns -`void` - -[#_IUser_TypeDB_Driver_Api_ITypeDBDriver_GetCurrentUser___] -==== GetCurrentUser - -[source,cs] ----- -IUser TypeDB.Driver.Api.ITypeDBDriver.GetCurrentUser() ----- - - - -Returns the logged-in user for the connection. Only for TypeDB Cloud. - - -[caption=""] -.Returns -`IUser` - -[#_bool_TypeDB_Driver_Api_ITypeDBDriver_IsOpen___] -==== IsOpen - -[source,cs] ----- -bool TypeDB.Driver.Api.ITypeDBDriver.IsOpen() ----- - - - -Checks whether this connection is presently open. - - -[caption=""] -.Returns -`bool` - -[#_ITypeDBSession_TypeDB_Driver_Api_ITypeDBDriver_Session___string_database__SessionType_type_] -==== Session - -[source,cs] ----- -ITypeDBSession TypeDB.Driver.Api.ITypeDBDriver.Session(string database, SessionType type) ----- - - - -Opens a session to the given database with default options. - - - See also - - - TypeDBDriver::Session(string, SessionType, TypeDBOptions); - - - -[caption=""] -.Returns -`ITypeDBSession` - -[#_ITypeDBSession_TypeDB_Driver_Api_ITypeDBDriver_Session___string_database__SessionType_type__TypeDBOptions_options_] -==== Session - -[source,cs] ----- -ITypeDBSession TypeDB.Driver.Api.ITypeDBDriver.Session(string database, SessionType type, TypeDBOptions options) ----- - - - -Opens a communication tunnel (session) to the given database on the running TypeDB server. For more information on the methods, available with sessions, see the ``ITypeDBSession`` section. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `database` a| The name of the database with which the session connects a| -a| `type` a| The type of session to be created (Data or Schema) a| -a| `options` a| ``TypeDBOptions`` for the session a| -|=== - -[caption=""] -.Returns -`ITypeDBSession` - -// end::methods[] - diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc deleted file mode 100644 index 3ecf0d66f0..0000000000 --- a/csharp/docs/connection/TypeDB.Driver.Api.IUser.adoc +++ /dev/null @@ -1,57 +0,0 @@ -[#_TypeDB_Driver_Api_IUser_Interface_Reference] -=== TypeDB.Driver.Api.IUser Interface Reference - -*Package*: `TypeDB.Driver.Api.IUser Interface Reference` - - - -TypeDB user information - -// tag::methods[] -[#_void_TypeDB_Driver_Api_IUser_UpdatePassword___string_passwordOld__string_passwordNew_] -==== UpdatePassword - -[source,csharp] ----- -void TypeDB.Driver.Api.IUser.UpdatePassword(string passwordOld, string passwordNew) ----- - - - -Updates the password for this user. - - - Parameters - - - - - - passwordOld - The current password of this user - - - passwordNew - The new password - - - - - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `passwordOld` a| The current password of this user a| -a| `passwordNew` a| The new password a| -|=== - -[caption=""] -.Returns -`void` - -// end::methods[] - diff --git a/csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc b/csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc deleted file mode 100644 index bc37e4a1b7..0000000000 --- a/csharp/docs/connection/TypeDB.Driver.Api.IUserManager.adoc +++ /dev/null @@ -1,161 +0,0 @@ -[#_TypeDB_Driver_Api_IUserManager_Interface_Reference] -=== TypeDB.Driver.Api.IUserManager Interface Reference - -*Package*: `TypeDB.Driver.Api.IUserManager Interface Reference` - - - -Provides access to all user management methods. - -// tag::methods[] -[#_bool_TypeDB_Driver_Api_IUserManager_Contains___string_username_] -==== Contains - -[source,csharp] ----- -bool TypeDB.Driver.Api.IUserManager.Contains(string username) ----- - - - -Checks if a user with the given name exists. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `username` a| The user name to be checked a| -|=== - -[caption=""] -.Returns -`bool` - -[#_void_TypeDB_Driver_Api_IUserManager_Create___string_username__string_password_] -==== Create - -[source,csharp] ----- -void TypeDB.Driver.Api.IUserManager.Create(string username, string password) ----- - - - -Creates a user with the given name & password. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `username` a| The name of the user to be created a| -a| `password` a| The password of the user to be created a| -|=== - -[caption=""] -.Returns -`void` - -[#_void_TypeDB_Driver_Api_IUserManager_Delete___string_username_] -==== Delete - -[source,csharp] ----- -void TypeDB.Driver.Api.IUserManager.Delete(string username) ----- - - - -Deletes a user with the given name. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `username` a| The name of the user to be deleted a| -|=== - -[caption=""] -.Returns -`void` - -[#_IUser_TypeDB_Driver_Api_IUserManager_Get___string_username_] -==== Get - -[source,csharp] ----- -IUser? TypeDB.Driver.Api.IUserManager.Get(string username) ----- - - - -Retrieves a user with the given name. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `username` a| The name of the user to retrieve a| -|=== - -[caption=""] -.Returns -`IUser?` - -[#_ISet__IUser___TypeDB_Driver_Api_IUserManager_GetAll___] -==== GetAll - -[source,csharp] ----- -ISet< IUser > TypeDB.Driver.Api.IUserManager.GetAll() ----- - - - -Retrieves all users which exist on the TypeDB server. - - -[caption=""] -.Returns -`ISet< IUser >` - -[#_void_TypeDB_Driver_Api_IUserManager_SetPassword___string_username__string_password_] -==== SetPassword - -[source,csharp] ----- -void TypeDB.Driver.Api.IUserManager.SetPassword(string username, string password) ----- - - - -Sets a new password for a user. This operation can only be performed by administrators. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `username` a| The name of the user to set the password of a| -a| `password` a| The new password a| -|=== - -[caption=""] -.Returns -`void` - -// end::methods[] - diff --git a/csharp/docs/connection/TypeDB.Driver.Api.TypeDBCredential.adoc b/csharp/docs/connection/TypeDB.Driver.Api.TypeDBCredential.adoc deleted file mode 100644 index c976925f4a..0000000000 --- a/csharp/docs/connection/TypeDB.Driver.Api.TypeDBCredential.adoc +++ /dev/null @@ -1,118 +0,0 @@ -[#_TypeDB_Driver_Api_TypeDBCredential] -=== TypeDB.Driver.Api.TypeDBCredential - -*Package*: `TypeDB.Driver.Api.TypeDBCredential` - - - -User credentials and TLS encryption settings for connecting to TypeDB Cloud. - - -[caption=""] -.Examples -[source,cs] ----- -// Creates a credential as above, but the connection will be made over TLS. -TypeDBCredential credential = new TypeDBCredential(username, password, true); - -// Creates a credential as above, but TLS will use the specified CA to authenticate server certificates. -TypeDBCredential credential = new TypeDBCredential(username, password, Path.of("path/to/ca-certificate.pem")); ----- - -// tag::methods[] -[#_TypeDB_Driver_Api_TypeDBCredential_TypeDBCredential___string_username__string_password__bool_tlsEnabled_] -==== TypeDBCredential - -[source,cs] ----- -TypeDB.Driver.Api.TypeDBCredential.TypeDBCredential(string username, string password, bool tlsEnabled) ----- - - - - Parameters - - - - - - username - The name of the user to connect as - - - password - The password for the user - - - tlsEnabled - Specify whether the connection to TypeDB Cloud must be done over TLS - - - - - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `username` a| The name of the user to connect as a| -a| `password` a| The password for the user a| -a| `tlsEnabled` a| Specify whether the connection to TypeDB Cloud must be done over TLS a| -|=== - -[caption=""] -.Returns -`TypeDB.Driver.Api.TypeDBCredential.TypeDBCredential` - -[#_TypeDB_Driver_Api_TypeDBCredential_TypeDBCredential___string_username__string_password__string_tlsRootCAPath_] -==== TypeDBCredential - -[source,cs] ----- -TypeDB.Driver.Api.TypeDBCredential.TypeDBCredential(string username, string password, string? tlsRootCAPath) ----- - - - - Parameters - - - - - - username - The name of the user to connect as - - - password - The password for the user - - - tlsRootCAPath - Path to the CA certificate to use for authenticating server certificates - - - - - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `username` a| The name of the user to connect as a| -a| `password` a| The password for the user a| -a| `tlsRootCAPath` a| Path to the CA certificate to use for authenticating server certificates a| -|=== - -[caption=""] -.Returns -`TypeDB.Driver.Api.TypeDBCredential.TypeDBCredential` - -// end::methods[] - diff --git a/csharp/docs/data/TypeDB.Driver.Api.IAttribute.adoc b/csharp/docs/data/TypeDB.Driver.Api.IAttribute.adoc deleted file mode 100644 index 8d8a866307..0000000000 --- a/csharp/docs/data/TypeDB.Driver.Api.IAttribute.adoc +++ /dev/null @@ -1,110 +0,0 @@ -[#_TypeDB_Driver_Api_IAttribute_Interface_Reference] -=== TypeDB.Driver.Api.IAttribute Interface Reference - -*Package*: `TypeDB.Driver.Api.IAttribute Interface Reference` - -*Supertypes:* - -* `TypeDB.Driver.Api.IThing` -* `TypeDB.Driver.Api.IConcept` - - - -Attribute is an instance of the attribute type and has a value. This value is fixed and unique for every given instance of the attribute type. - -Attributes can be uniquely addressed by their type and value. - -// tag::methods[] -[#_IAttribute_IConcept__TypeDB_Driver_Api_IAttribute_AsAttribute___] -==== AsAttribute - -[source,cs] ----- -IAttribute IConcept. TypeDB.Driver.Api.IAttribute.AsAttribute() ----- - - - -Casts the concept to ``IAttribute``. - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`IAttribute IConcept.` - -[#_IEnumerable__IThing___TypeDB_Driver_Api_IAttribute_GetOwners___ITypeDBTransaction_transaction_] -==== GetOwners - -[source,cs] ----- -IEnumerable< IThing > TypeDB.Driver.Api.IAttribute.GetOwners(ITypeDBTransaction transaction) ----- - - - -Retrieves the instances that own this ``IAttribute``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`IEnumerable< IThing >` - -[#_IEnumerable__IThing___TypeDB_Driver_Api_IAttribute_GetOwners___ITypeDBTransaction_transaction__IThingType_ownerType_] -==== GetOwners - -[source,cs] ----- -IEnumerable< IThing > TypeDB.Driver.Api.IAttribute.GetOwners(ITypeDBTransaction transaction, IThingType ownerType) ----- - - - -Retrieves the instances that own this ``IAttribute``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `ownerType` a| Filter results for only owners of the given type a| -|=== - -[caption=""] -.Returns -`IEnumerable< IThing >` - -[#_bool_IConcept__TypeDB_Driver_Api_IAttribute_IsAttribute___] -==== IsAttribute - -[source,cs] ----- -bool IConcept. TypeDB.Driver.Api.IAttribute.IsAttribute() ----- - - - -Checks if the concept is an ``IAttribute``. - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`bool IConcept.` - -// end::methods[] - diff --git a/csharp/docs/data/TypeDB.Driver.Api.IEntity.adoc b/csharp/docs/data/TypeDB.Driver.Api.IEntity.adoc deleted file mode 100644 index 7f69f70b20..0000000000 --- a/csharp/docs/data/TypeDB.Driver.Api.IEntity.adoc +++ /dev/null @@ -1,55 +0,0 @@ -[#_TypeDB_Driver_Api_IEntity_Interface_Reference] -=== TypeDB.Driver.Api.IEntity Interface Reference - -*Package*: `TypeDB.Driver.Api.IEntity Interface Reference` - -*Supertypes:* - -* `TypeDB.Driver.Api.IThing` -* `TypeDB.Driver.Api.IConcept` - - - -Instance of data of an entity type, representing a standalone object that exists in the data model independently. Entity does not have a value. It is usually addressed by its ownership over attribute instances and/or roles played in relation instances. - -// tag::methods[] -[#_IEntity_IConcept__TypeDB_Driver_Api_IEntity_AsEntity___] -==== AsEntity - -[source,cs] ----- -IEntity IConcept. TypeDB.Driver.Api.IEntity.AsEntity() ----- - - - -Casts the concept to ``IEntity``. - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`IEntity IConcept.` - -[#_bool_IConcept__TypeDB_Driver_Api_IEntity_IsEntity___] -==== IsEntity - -[source,cs] ----- -bool IConcept. TypeDB.Driver.Api.IEntity.IsEntity() ----- - - - -Checks if the concept is an ``IEntity``. - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`bool IConcept.` - -// end::methods[] - diff --git a/csharp/docs/data/TypeDB.Driver.Api.IRelation.adoc b/csharp/docs/data/TypeDB.Driver.Api.IRelation.adoc deleted file mode 100644 index f9f2145d6a..0000000000 --- a/csharp/docs/data/TypeDB.Driver.Api.IRelation.adoc +++ /dev/null @@ -1,190 +0,0 @@ -[#_TypeDB_Driver_Api_IRelation_Interface_Reference] -=== TypeDB.Driver.Api.IRelation Interface Reference - -*Package*: `TypeDB.Driver.Api.IRelation Interface Reference` - -*Supertypes:* - -* `TypeDB.Driver.Api.IThing` -* `TypeDB.Driver.Api.IConcept` - - - -Relation is an instance of a relation type and can be uniquely addressed by a combination of its type, owned attributes and role players. - -// tag::methods[] -[#_VoidPromise_TypeDB_Driver_Api_IRelation_AddPlayer___ITypeDBTransaction_transaction__IRoleType_roleType__IThing_player_] -==== AddPlayer - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IRelation.AddPlayer(ITypeDBTransaction transaction, IRoleType roleType, IThing player) ----- - - - -Adds a new role player to play the given role in this ``IRelation``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to be played by the ``player`` a| -a| `player` a| The thing to play the role a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_IRelation_IConcept__TypeDB_Driver_Api_IRelation_AsRelation___] -==== AsRelation - -[source,cs] ----- -IRelation IConcept. TypeDB.Driver.Api.IRelation.AsRelation() ----- - - - -Casts the concept to ``IRelation``. - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`IRelation IConcept.` - -[#_Dictionary__IRoleType__ICollection__IThing_____TypeDB_Driver_Api_IRelation_GetPlayers___ITypeDBTransaction_transaction_] -==== GetPlayers - -[source,cs] ----- -Dictionary< IRoleType, ICollection< IThing > > TypeDB.Driver.Api.IRelation.GetPlayers(ITypeDBTransaction transaction) ----- - - - -Retrieves a mapping of all instances involved in the ``IRelation`` and the role each play. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`Dictionary< IRoleType, ICollection< IThing > >` - -[#_IEnumerable__IThing___TypeDB_Driver_Api_IRelation_GetPlayersByRoleType___ITypeDBTransaction_transaction__params_IRoleType___roleTypes_] -==== GetPlayersByRoleType - -[source,cs] ----- -IEnumerable< IThing > TypeDB.Driver.Api.IRelation.GetPlayersByRoleType(ITypeDBTransaction transaction, params IRoleType[] roleTypes) ----- - - - -Retrieves all role players of this ``IRelation``, optionally filtered by given role types. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleTypes` a| 0 or more role types a| -|=== - -[caption=""] -.Returns -`IEnumerable< IThing >` - -[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelation_GetRelating___ITypeDBTransaction_transaction_] -==== GetRelating - -[source,cs] ----- -IEnumerable< IRoleType > TypeDB.Driver.Api.IRelation.GetRelating(ITypeDBTransaction transaction) ----- - - - -Retrieves all role types currently played in this ``IRelation``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`IEnumerable< IRoleType >` - -[#_bool_IConcept__TypeDB_Driver_Api_IRelation_IsRelation___] -==== IsRelation - -[source,cs] ----- -bool IConcept. TypeDB.Driver.Api.IRelation.IsRelation() ----- - - - -Checks if the concept is a ``IRelation``. - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`bool IConcept.` - -[#_VoidPromise_TypeDB_Driver_Api_IRelation_RemovePlayer___ITypeDBTransaction_transaction__IRoleType_roleType__IThing_player_] -==== RemovePlayer - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IRelation.RemovePlayer(ITypeDBTransaction transaction, IRoleType roleType, IThing player) ----- - - - -Removes the association of the given instance that plays the given role in this ``IRelation``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to no longer be played by the thing in this ``IRelation`` a| -a| `player` a| The instance to no longer play the role in this ``IRelation`` a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -// end::methods[] - diff --git a/csharp/docs/data/TypeDB.Driver.Api.IThing.adoc b/csharp/docs/data/TypeDB.Driver.Api.IThing.adoc deleted file mode 100644 index 5e0ec9436f..0000000000 --- a/csharp/docs/data/TypeDB.Driver.Api.IThing.adoc +++ /dev/null @@ -1,280 +0,0 @@ -[#_TypeDB_Driver_Api_IThing_Interface_Reference] -=== TypeDB.Driver.Api.IThing Interface Reference - -*Package*: `TypeDB.Driver.Api.IThing Interface Reference` - -*Supertypes:* - -* `TypeDB.Driver.Api.IConcept` - -// tag::methods[] -[#_IThing_IConcept__TypeDB_Driver_Api_IThing_AsThing___] -==== AsThing - -[source,cs] ----- -IThing IConcept. TypeDB.Driver.Api.IThing.AsThing() ----- - - - -Casts the concept to ``IThing``. - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`IThing IConcept.` - -[#_VoidPromise_TypeDB_Driver_Api_IThing_Delete___ITypeDBTransaction_transaction_] -==== Delete - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThing.Delete(ITypeDBTransaction transaction) ----- - - - -Deletes this ``IThing``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_IEnumerable__IAttribute___TypeDB_Driver_Api_IThing_GetHas___ITypeDBTransaction_transaction__params_IAttributeType___attributeTypes_] -==== GetHas - -[source,cs] ----- -IEnumerable< IAttribute > TypeDB.Driver.Api.IThing.GetHas(ITypeDBTransaction transaction, params IAttributeType[] attributeTypes) ----- - - - -Retrieves the ``IAttribute``s that this ``IThing`` owns, optionally filtered by ``IAttributeType``s. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeTypes` a| The ``IAttributeType``s to filter the attributes by a| -|=== - -[caption=""] -.Returns -`IEnumerable< IAttribute >` - -[#_IEnumerable__IAttribute___TypeDB_Driver_Api_IThing_GetHas___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] -==== GetHas - -[source,cs] ----- -IEnumerable< IAttribute > TypeDB.Driver.Api.IThing.GetHas(ITypeDBTransaction transaction, ICollection< Annotation > annotations) ----- - - - -Retrieves the ``IAttribute``s that this ``IThing`` owns, filtered by ``Annotation``s. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `annotations` a| Only retrieve attributes with all given ``Annotation``s a| -|=== - -[caption=""] -.Returns -`IEnumerable< IAttribute >` - -[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThing_GetPlaying___ITypeDBTransaction_transaction_] -==== GetPlaying - -[source,cs] ----- -IEnumerable< IRoleType > TypeDB.Driver.Api.IThing.GetPlaying(ITypeDBTransaction transaction) ----- - - - -Retrieves the roles that this ``IThing`` is currently playing. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`IEnumerable< IRoleType >` - -[#_IEnumerable__IRelation___TypeDB_Driver_Api_IThing_GetRelations___ITypeDBTransaction_transaction__params_IRoleType___roleTypes_] -==== GetRelations - -[source,cs] ----- -IEnumerable< IRelation > TypeDB.Driver.Api.IThing.GetRelations(ITypeDBTransaction transaction, params IRoleType[] roleTypes) ----- - - - -Retrieves all the ``Relations`` which this ``IThing`` plays a role in, optionally filtered by one or more given roles. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleTypes` a| The array of roles to filter the relations by. a| -|=== - -[caption=""] -.Returns -`IEnumerable< IRelation >` - -[#_Promise__bool___TypeDB_Driver_Api_IThing_IsDeleted___ITypeDBTransaction_transaction_] -==== IsDeleted - -[source,cs] ----- -Promise< bool > TypeDB.Driver.Api.IThing.IsDeleted(ITypeDBTransaction transaction) ----- - - - -Checks if this ``IThing`` is deleted. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`Promise< bool >` - -[#_bool_TypeDB_Driver_Api_IThing_IsInferred___] -==== IsInferred - -[source,cs] ----- -bool TypeDB.Driver.Api.IThing.IsInferred() ----- - - - -Checks if this ``IThing`` is inferred by a [Reasoning Rule]. - - -[caption=""] -.Returns -`bool` - -[#_bool_IConcept__TypeDB_Driver_Api_IThing_IsThing___] -==== IsThing - -[source,cs] ----- -bool IConcept. TypeDB.Driver.Api.IThing.IsThing() ----- - - - -Checks if the concept is a ``IThing``. - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`bool IConcept.` - -[#_VoidPromise_TypeDB_Driver_Api_IThing_SetHas___ITypeDBTransaction_transaction__IAttribute_attribute_] -==== SetHas - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThing.SetHas(ITypeDBTransaction transaction, IAttribute attribute) ----- - - - -Assigns an ``IAttribute`` to be owned by this ``IThing``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attribute` a| The ``IAttribute`` to be owned by this ``IThing``. a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IThing_UnsetHas___ITypeDBTransaction_transaction__IAttribute_attribute_] -==== UnsetHas - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThing.UnsetHas(ITypeDBTransaction transaction, IAttribute attribute) ----- - - - -Unassigns an ``IAttribute`` from this ``IThing``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attribute` a| The ``IAttribute`` to be disowned from this ``IThing``. a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -// end::methods[] - diff --git a/csharp/docs/data/TypeDB.Driver.Api.IValue.adoc b/csharp/docs/data/TypeDB.Driver.Api.IValue.adoc deleted file mode 100644 index 6268af77c2..0000000000 --- a/csharp/docs/data/TypeDB.Driver.Api.IValue.adoc +++ /dev/null @@ -1,241 +0,0 @@ -[#_TypeDB_Driver_Api_IValue_Interface_Reference] -=== TypeDB.Driver.Api.IValue Interface Reference - -*Package*: `TypeDB.Driver.Api.IValue Interface Reference` - -*Supertypes:* - -* `TypeDB.Driver.Api.IConcept` - -// tag::methods[] -[#_bool_TypeDB_Driver_Api_IValue_AsBool___] -==== AsBool - -[source,csharp] ----- -bool TypeDB.Driver.Api.IValue.AsBool() ----- - - - -Returns a ``bool`` value of this value concept. If the value has another type, raises an exception. - - -[caption=""] -.Returns -`bool` - -[#_System_DateTime_TypeDB_Driver_Api_IValue_AsDateTime___] -==== AsDateTime - -[source,csharp] ----- -System.DateTime TypeDB.Driver.Api.IValue.AsDateTime() ----- - - - -Returns a ``datetime`` value of this value concept. This value contains raw date and time without considering your time zone (Kind = Unspecified). If the value has another type, raises an exception. - - -[caption=""] -.Returns -`System.DateTime` - -[#_double_TypeDB_Driver_Api_IValue_AsDouble___] -==== AsDouble - -[source,csharp] ----- -double TypeDB.Driver.Api.IValue.AsDouble() ----- - - - -Returns a ``double`` value of this value concept. If the value has another type, raises an exception. - - -[caption=""] -.Returns -`double` - -[#_long_TypeDB_Driver_Api_IValue_AsLong___] -==== AsLong - -[source,csharp] ----- -long TypeDB.Driver.Api.IValue.AsLong() ----- - - - -Returns a ``long`` value of this value concept. If the value has another type, raises an exception. - - -[caption=""] -.Returns -`long` - -[#_string_TypeDB_Driver_Api_IValue_AsString___] -==== AsString - -[source,csharp] ----- -string TypeDB.Driver.Api.IValue.AsString() ----- - - - -Returns a ``string`` value of this value concept. If the value has another type, raises an exception. - - -[caption=""] -.Returns -`string` - -[#_object_TypeDB_Driver_Api_IValue_AsUntyped___] -==== AsUntyped - -[source,csharp] ----- -object TypeDB.Driver.Api.IValue.AsUntyped() ----- - - - -Returns an untyped ``object`` value of this value concept. This is useful for value equality or printing without having to switch on the actual contained value. - - -[caption=""] -.Returns -`object` - -[#_IValue_IConcept__TypeDB_Driver_Api_IValue_AsValue___] -==== AsValue - -[source,csharp] ----- -IValue IConcept. TypeDB.Driver.Api.IValue.AsValue() ----- - - - -Casts the concept to ``IValue``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`IValue IConcept.` - -[#_bool_TypeDB_Driver_Api_IValue_IsBool___] -==== IsBool - -[source,csharp] ----- -bool TypeDB.Driver.Api.IValue.IsBool() ----- - - - -Returns ``True`` if the value which this value concept holds is of type ``bool``. Otherwise, returns ``false``. - - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IValue_IsDateTime___] -==== IsDateTime - -[source,csharp] ----- -bool TypeDB.Driver.Api.IValue.IsDateTime() ----- - - - -Returns ``True`` if the value which this value concept holds is of type ``datetime``. Otherwise, returns ``false``. - - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IValue_IsDouble___] -==== IsDouble - -[source,csharp] ----- -bool TypeDB.Driver.Api.IValue.IsDouble() ----- - - - -Returns ``True`` if the value which this value concept holds is of type ``double``. Otherwise, returns ``false``. - - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IValue_IsLong___] -==== IsLong - -[source,csharp] ----- -bool TypeDB.Driver.Api.IValue.IsLong() ----- - - - -Returns ``True`` if the value which this value concept holds is of type ``long``. Otherwise, returns ``false``. - - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IValue_IsString___] -==== IsString - -[source,csharp] ----- -bool TypeDB.Driver.Api.IValue.IsString() ----- - - - -Returns ``True`` if the value which this value concept holds is of type ``string``. Otherwise, returns ``false``. - - -[caption=""] -.Returns -`bool` - -[#_bool_IConcept__TypeDB_Driver_Api_IValue_IsValue___] -==== IsValue - -[source,csharp] ----- -bool IConcept. TypeDB.Driver.Api.IValue.IsValue() ----- - - - -Checks if the concept is a ``IValue``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`bool IConcept.` - -// end::methods[] - diff --git a/csharp/docs/errors/TypeDB.Driver.Common.TypeDBDriverException.adoc b/csharp/docs/errors/TypeDB.Driver.Common.TypeDBDriverException.adoc deleted file mode 100644 index 0dcd5862b8..0000000000 --- a/csharp/docs/errors/TypeDB.Driver.Common.TypeDBDriverException.adoc +++ /dev/null @@ -1,93 +0,0 @@ -[#_TypeDB_Driver_Common_TypeDBDriverException] -=== TypeDB.Driver.Common.TypeDBDriverException - -*Package*: `TypeDB.Driver.Common.TypeDBDriverException` - - - -Exceptions raised by the driver. - -// tag::methods[] -[#_bool_TypeDB_Driver_Common_TypeDBDriverException_Contains___string_subString_] -==== Contains - -[source,cs] ----- -bool TypeDB.Driver.Common.TypeDBDriverException.Contains(string subString) ----- - - - -Checks whether a substring is a part of this exception's message. - - -[caption=""] -.Returns -`bool` - -[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___ErrorMessage_error__params_object___errorParams_] -==== TypeDBDriverException - -[source,cs] ----- -TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException(ErrorMessage error, params object?[] errorParams) ----- - - - -@hidden - -[caption=""] -.Returns -`TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException` - -[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___string_message_] -==== TypeDBDriverException - -[source,cs] ----- -TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException(string message) ----- - - - -@hidden - -[caption=""] -.Returns -`TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException` - -[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___SystemException_error_] -==== TypeDBDriverException - -[source,cs] ----- -TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException(System::Exception error) ----- - - - -@hidden - -[caption=""] -.Returns -`TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException` - -[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___PinvokeError_nativeError_] -==== TypeDBDriverException - -[source,cs] ----- -TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException(Pinvoke::Error nativeError) ----- - - - -@hidden - -[caption=""] -.Returns -`TypeDB.Driver.Common.TypeDBDriverException.TypeDBDriverException` - -// end::methods[] - diff --git a/csharp/docs/logic/TypeDB.Driver.Api.ILogicManager.adoc b/csharp/docs/logic/TypeDB.Driver.Api.ILogicManager.adoc deleted file mode 100644 index 7a1a92f5e0..0000000000 --- a/csharp/docs/logic/TypeDB.Driver.Api.ILogicManager.adoc +++ /dev/null @@ -1,83 +0,0 @@ -[#_TypeDB_Driver_Api_ILogicManager_Interface_Reference] -=== TypeDB.Driver.Api.ILogicManager Interface Reference - -*Package*: `TypeDB.Driver.Api.ILogicManager Interface Reference` - - - -Provides methods for manipulating rules in the database. - -// tag::methods[] -[#_Promise__IRule___TypeDB_Driver_Api_ILogicManager_GetRule___string_label_] -==== GetRule - -[source,cs] ----- -Promise< IRule > TypeDB.Driver.Api.ILogicManager.GetRule(string label) ----- - - - -Retrieves the Rule that has the given label. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `label` a| The label of the Rule to create or retrieve a| -|=== - -[caption=""] -.Returns -`Promise< IRule >` - -[#_IEnumerable__IRule___TypeDB_Driver_Api_ILogicManager_GetRules___] -==== GetRules - -[source,cs] ----- -IEnumerable< IRule > TypeDB.Driver.Api.ILogicManager.GetRules() ----- - - - -Retrieves all rules. - - -[caption=""] -.Returns -`IEnumerable< IRule >` - -[#_Promise__IRule___TypeDB_Driver_Api_ILogicManager_PutRule___string_label__string_when__string_then_] -==== PutRule - -[source,cs] ----- -Promise< IRule > TypeDB.Driver.Api.ILogicManager.PutRule(string label, string when, string then) ----- - - - -Creates a new Rule if none exists with the given label, or replaces the existing one. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `label` a| The label of the IRule to create or replace a| -a| `when` a| The when body of the rule to create a| -a| `then` a| The then body of the rule to create a| -|=== - -[caption=""] -.Returns -`Promise< IRule >` - -// end::methods[] - diff --git a/csharp/docs/logic/TypeDB.Driver.Api.IRule.adoc b/csharp/docs/logic/TypeDB.Driver.Api.IRule.adoc deleted file mode 100644 index b48af8a78b..0000000000 --- a/csharp/docs/logic/TypeDB.Driver.Api.IRule.adoc +++ /dev/null @@ -1,91 +0,0 @@ -[#_TypeDB_Driver_Api_IRule_Interface_Reference] -=== TypeDB.Driver.Api.IRule Interface Reference - -*Package*: `TypeDB.Driver.Api.IRule Interface Reference` - - - -Rules are a part of schema and define embedded logic. The reasoning engine uses rules as a set of logic to infer new data. A rule consists of a condition and a conclusion, and is uniquely identified by a label. - -// tag::methods[] -[#_VoidPromise_TypeDB_Driver_Api_IRule_Delete___ITypeDBTransaction_transaction_] -==== Delete - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IRule.Delete(ITypeDBTransaction transaction) ----- - - - -Deletes this rule. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current ``Transaction`` a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_Promise__bool___TypeDB_Driver_Api_IRule_IsDeleted___ITypeDBTransaction_transaction_] -==== IsDeleted - -[source,cs] ----- -Promise< bool > TypeDB.Driver.Api.IRule.IsDeleted(ITypeDBTransaction transaction) ----- - - - -Check if this rule has been deleted. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current ``Transaction`` a| -|=== - -[caption=""] -.Returns -`Promise< bool >` - -[#_VoidPromise_TypeDB_Driver_Api_IRule_SetLabel___ITypeDBTransaction_transaction__string_label_] -==== SetLabel - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IRule.SetLabel(ITypeDBTransaction transaction, string label) ----- - - - -Renames the label of the rule. The new label must remain unique. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current ``Transaction`` a| -a| `label` a| The new label to be given to the rule a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -// end::methods[] - diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IAttributeType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IAttributeType.adoc deleted file mode 100644 index 1947d7967e..0000000000 --- a/csharp/docs/schema/TypeDB.Driver.Api.IAttributeType.adoc +++ /dev/null @@ -1,746 +0,0 @@ -[#_TypeDB_Driver_Api_IAttributeType_Interface_Reference] -=== TypeDB.Driver.Api.IAttributeType Interface Reference - -*Package*: `TypeDB.Driver.Api.IAttributeType Interface Reference` - -*Supertypes:* - -* `TypeDB.Driver.Api.IThingType` -* `TypeDB.Driver.Api.IType` -* `TypeDB.Driver.Api.IConcept` - - - -Attribute types represent properties that other types can own. - -IAttribute types have a value type. This value type is fixed and unique for every given instance of the attribute type. - -Other types can own an attribute type. That means that instances of these other types can own an instance of this attribute type. This usually means that an object in our domain has a property with the matching value. - -Multiple types can own the same attribute type, and different instances of the same type or different types can share ownership of the same attribute instance. - -// tag::methods[] -[#_IAttributeType_IConcept__TypeDB_Driver_Api_IAttributeType_AsAttributeType___] -==== AsAttributeType - -[source,cs] ----- -IAttributeType IConcept. TypeDB.Driver.Api.IAttributeType.AsAttributeType() ----- - - - -Casts the concept to ``IAttributeType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`IAttributeType IConcept.` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__IValue_value_] -==== Get - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, IValue value) ----- - - - -Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__string_value_] -==== Get - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, string value) ----- - - - -Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__long_value_] -==== Get - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, long value) ----- - - - -Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__double_value_] -==== Get - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, double value) ----- - - - -Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__bool_value_] -==== Get - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, bool value) ----- - - - -Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__System_DateTime_value_] -==== Get - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Get(ITypeDBTransaction transaction, System.DateTime value) ----- - - - -Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction_] -==== GetOwners - -[source,cs] ----- -IEnumerable< IThingType > TypeDB.Driver.Api.IAttributeType.GetOwners(ITypeDBTransaction transaction) ----- - - - -Retrieve all ``Things`` that own an attribute of this ``IAttributeType`` directly or through inheritance. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`IEnumerable< IThingType >` - -[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] -==== GetOwners - -[source,cs] ----- -IEnumerable< IThingType > TypeDB.Driver.Api.IAttributeType.GetOwners(ITypeDBTransaction transaction, ICollection< Annotation > annotations) ----- - - - -Retrieve all ``Things`` that own an attribute of this ``IAttributeType``, filtered by ``Annotation``s, directly or through inheritance. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``IAttributeType`` with all given ``Annotation``s a| -|=== - -[caption=""] -.Returns -`IEnumerable< IThingType >` - -[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] -==== GetOwners - -[source,cs] ----- -IEnumerable< IThingType > TypeDB.Driver.Api.IAttributeType.GetOwners(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ----- - - - -Retrieve all ``Things`` that own an attribute of this ``IAttributeType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| -|=== - -[caption=""] -.Returns -`IEnumerable< IThingType >` - -[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] -==== GetOwners - -[source,cs] ----- -IEnumerable< IThingType > TypeDB.Driver.Api.IAttributeType.GetOwners(ITypeDBTransaction transaction, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) ----- - - - -Retrieve all ``Things`` that own an attribute of this ``IAttributeType``, filtered by ``Annotation``s. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``IAttributeType`` with all given ``Annotation``s a| -a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| -|=== - -[caption=""] -.Returns -`IEnumerable< IThingType >` - -[#_Promise__string___TypeDB_Driver_Api_IAttributeType_GetRegex___ITypeDBTransaction_transaction_] -==== GetRegex - -[source,cs] ----- -Promise< string > TypeDB.Driver.Api.IAttributeType.GetRegex(ITypeDBTransaction transaction) ----- - - - -Retrieves the regular expression that is defined for this ``IAttributeType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`Promise< string >` - -[#_IEnumerable__IType___TypeDB_Driver_Api_IAttributeType_GetSubtypes___ITypeDBTransaction_transaction__IValue_ValueType_valueType_] -==== GetSubtypes - -[source,cs] ----- -IEnumerable< IType > TypeDB.Driver.Api.IAttributeType.GetSubtypes(ITypeDBTransaction transaction, IValue.ValueType valueType) ----- - - - -Retrieves all direct and indirect subtypes of this ``IAttributeType`` with given ``IValue.ValueType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| -|=== - -[caption=""] -.Returns -`IEnumerable< IType >` - -[#_IEnumerable__IType___TypeDB_Driver_Api_IAttributeType_GetSubtypes___ITypeDBTransaction_transaction__IValue_ValueType_valueType__IConcept_Transitivity_transitivity_] -==== GetSubtypes - -[source,cs] ----- -IEnumerable< IType > TypeDB.Driver.Api.IAttributeType.GetSubtypes(ITypeDBTransaction transaction, IValue.ValueType valueType, IConcept.Transitivity transitivity) ----- - - - -Retrieves all direct and indirect (or direct only) subtypes of this ``IAttributeType`` with given ``IValue.ValueType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| -a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| -|=== - -[caption=""] -.Returns -`IEnumerable< IType >` - -[#_bool_IConcept__TypeDB_Driver_Api_IAttributeType_IsAttributeType___] -==== IsAttributeType - -[source,cs] ----- -bool IConcept. TypeDB.Driver.Api.IAttributeType.IsAttributeType() ----- - - - -Checks if the concept is an ``IAttributeType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`bool IConcept.` - -[#_bool_TypeDB_Driver_Api_IAttributeType_IsBool___] -==== IsBool - -[source,cs] ----- -bool TypeDB.Driver.Api.IAttributeType.IsBool() ----- - - - -Returns ``True`` if the value for attributes of this type is of type ``bool``. Otherwise, returns ``False``. - - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IAttributeType_IsDateTime___] -==== IsDateTime - -[source,cs] ----- -bool TypeDB.Driver.Api.IAttributeType.IsDateTime() ----- - - - -Returns ``True`` if the value for attributes of this type is of type ``datetime``. Otherwise, returns ``False``. - - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IAttributeType_IsDouble___] -==== IsDouble - -[source,cs] ----- -bool TypeDB.Driver.Api.IAttributeType.IsDouble() ----- - - - -Returns ``True`` if the value for attributes of this type is of type ``double``. Otherwise, returns ``False``. - - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IAttributeType_IsLong___] -==== IsLong - -[source,cs] ----- -bool TypeDB.Driver.Api.IAttributeType.IsLong() ----- - - - -Returns ``True`` if the value for attributes of this type is of type ``long``. Otherwise, returns ``False``. - - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IAttributeType_IsString___] -==== IsString - -[source,cs] ----- -bool TypeDB.Driver.Api.IAttributeType.IsString() ----- - - - -Returns ``True`` if the value for attributes of this type is of type ``string``. Otherwise, returns ``False``. - - -[caption=""] -.Returns -`bool` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__IValue_value_] -==== Put - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, IValue value) ----- - - - -Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given value. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__string_value_] -==== Put - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, string value) ----- - - - -Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``string`` value. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__long_value_] -==== Put - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, long value) ----- - - - -Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``long`` value. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__double_value_] -==== Put - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, double value) ----- - - - -Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``double`` value. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__bool_value_] -==== Put - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, bool value) ----- - - - -Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``bool`` value. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__System_DateTime_value_] -==== Put - -[source,cs] ----- -Promise< IAttribute > TypeDB.Driver.Api.IAttributeType.Put(ITypeDBTransaction transaction, System.DateTime value) ----- - - - -Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``DateTime`` value. The input DateTime value is treated as timezone naive, with DateTimeKind being ignored. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| -|=== - -[caption=""] -.Returns -`Promise< IAttribute >` - -[#_VoidPromise_TypeDB_Driver_Api_IAttributeType_SetRegex___ITypeDBTransaction_transaction__string_regex_] -==== SetRegex - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IAttributeType.SetRegex(ITypeDBTransaction transaction, string regex) ----- - - - -Sets a regular expression as a constraint for this ``IAttributeType``. ``Values`` of all ``IAttribute``s of this type (inserted earlier or later) should match this regex. - -Can only be applied for ``IAttributeType``s with a ``string`` value type. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `regex` a| Regular expression a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IAttributeType_SetSupertype___ITypeDBTransaction_transaction__IAttributeType_attributeType_] -==== SetSupertype - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IAttributeType.SetSupertype(ITypeDBTransaction transaction, IAttributeType attributeType) ----- - - - -Sets the supplied ``IAttributeType`` as the supertype of the current ``IAttributeType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``IAttributeType`` to set as the supertype of this ``IAttributeType`` a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IAttributeType_UnsetRegex___ITypeDBTransaction_transaction_] -==== UnsetRegex - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IAttributeType.UnsetRegex(ITypeDBTransaction transaction) ----- - - - -Removes the regular expression that is defined for this ``IAttributeType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -// end::methods[] - diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IEntityType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IEntityType.adoc deleted file mode 100644 index 1998c4e2ce..0000000000 --- a/csharp/docs/schema/TypeDB.Driver.Api.IEntityType.adoc +++ /dev/null @@ -1,113 +0,0 @@ -[#_TypeDB_Driver_Api_IEntityType_Interface_Reference] -=== TypeDB.Driver.Api.IEntityType Interface Reference - -*Package*: `TypeDB.Driver.Api.IEntityType Interface Reference` - -*Supertypes:* - -* `TypeDB.Driver.Api.IThingType` -* `TypeDB.Driver.Api.IType` -* `TypeDB.Driver.Api.IConcept` - - - -Entity types represent the classification of independent objects in the data model of the business domain. - -// tag::methods[] -[#_IEntityType_IConcept__TypeDB_Driver_Api_IEntityType_AsEntityType___] -==== AsEntityType - -[source,cs] ----- -IEntityType IConcept. TypeDB.Driver.Api.IEntityType.AsEntityType() ----- - - - -Casts the concept to ``IEntityType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`IEntityType IConcept.` - -[#_Promise__IEntity___TypeDB_Driver_Api_IEntityType_Create___ITypeDBTransaction_transaction_] -==== Create - -[source,cs] ----- -Promise< IEntity > TypeDB.Driver.Api.IEntityType.Create(ITypeDBTransaction transaction) ----- - - - -Creates and returns a new instance of this ``IEntityType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`Promise< IEntity >` - -[#_bool_IConcept__TypeDB_Driver_Api_IEntityType_IsEntityType___] -==== IsEntityType - -[source,cs] ----- -bool IConcept. TypeDB.Driver.Api.IEntityType.IsEntityType() ----- - - - -Checks if the concept is an ``IEntityType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`bool IConcept.` - -[#_VoidPromise_TypeDB_Driver_Api_IEntityType_SetSupertype___ITypeDBTransaction_transaction__IEntityType_superEntityType_] -==== SetSupertype - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IEntityType.SetSupertype(ITypeDBTransaction transaction, IEntityType superEntityType) ----- - - - -Sets the supplied ``IEntityType`` as the supertype of the current ``IEntityType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `superEntityType` a| The ``IEntityType`` to set as the supertype of this ``IEntityType`` a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -// end::methods[] - diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc deleted file mode 100644 index 242f9c1a10..0000000000 --- a/csharp/docs/schema/TypeDB.Driver.Api.IRelationType.adoc +++ /dev/null @@ -1,369 +0,0 @@ -[#_TypeDB_Driver_Api_IRelationType_Interface_Reference] -=== TypeDB.Driver.Api.IRelationType Interface Reference - -*Package*: `TypeDB.Driver.Api.IRelationType Interface Reference` - -*Supertypes:* - -* `TypeDB.Driver.Api.IThingType` -* `TypeDB.Driver.Api.IType` -* `TypeDB.Driver.Api.IConcept` - - - -Relation types (or subtypes of the relation root type) represent relationships between types. Relation types have roles. Other types can play roles in relations if it’s mentioned in their definition. A relation type must specify at least one role. - -// tag::methods[] -[#_IRelationType_IConcept__TypeDB_Driver_Api_IRelationType_AsRelationType___] -==== AsRelationType - -[source,csharp] ----- -IRelationType IConcept. TypeDB.Driver.Api.IRelationType.AsRelationType() ----- - - - -Casts the concept to ``IRelationType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`IRelationType IConcept.` - -[#_Promise__IRelation___TypeDB_Driver_Api_IRelationType_Create___ITypeDBTransaction_transaction_] -==== Create - -[source,csharp] ----- -Promise< IRelation > TypeDB.Driver.Api.IRelationType.Create(ITypeDBTransaction transaction) ----- - - - -Creates and returns an instance of this ``IRelationType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`Promise< IRelation >` - -[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction_] -==== GetRelates - -[source,csharp] ----- -IEnumerable< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelates(ITypeDBTransaction transaction) ----- - - - -Retrieves roles that this ``IRelationType`` relates to directly or via inheritance. - - - See also - - - IRelationType::getRelates(ITypeDBTransaction, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IRoleType >` - -[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] -==== GetRelates - -[source,csharp] ----- -IEnumerable< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelates(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ----- - - - -Retrieves roles that this ``IRelationType`` relates to directly or via inheritance. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and inherited relates, ``Explicit`` for direct relates only a| -|=== - -[caption=""] -.Returns -`IEnumerable< IRoleType >` - -[#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction__string_roleLabel_] -==== GetRelates - -[source,csharp] ----- -Promise< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelates(ITypeDBTransaction transaction, string roleLabel) ----- - - - -Retrieves roles that this ``IRelationType`` relates to directly or via inheritance. If ``role_label`` is given, returns a corresponding ``IRoleType`` or ``null``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| Label of the role we wish to retrieve a| -|=== - -[caption=""] -.Returns -`Promise< IRoleType >` - -[#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__IRoleType_roleType_] -==== GetRelatesOverridden - -[source,csharp] ----- -Promise< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelatesOverridden(ITypeDBTransaction transaction, IRoleType roleType) ----- - - - -Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label``. - - - See also - - - <<#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__string_roleLabel_,IRelationType::GetRelatesOverridden(ITypeDBTransaction, string)>> - - - -[caption=""] -.Returns -`Promise< IRoleType >` - -[#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__string_roleLabel_] -==== GetRelatesOverridden - -[source,csharp] ----- -Promise< IRoleType > TypeDB.Driver.Api.IRelationType.GetRelatesOverridden(ITypeDBTransaction transaction, string roleLabel) ----- - - - -Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| Label of the role that overrides an inherited role a| -|=== - -[caption=""] -.Returns -`Promise< IRoleType >` - -[#_bool_IConcept__TypeDB_Driver_Api_IRelationType_IsRelationType___] -==== IsRelationType - -[source,csharp] ----- -bool IConcept. TypeDB.Driver.Api.IRelationType.IsRelationType() ----- - - - -Checks if the concept is a ``IRelationType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`bool IConcept.` - -[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel_] -==== SetRelates - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IRelationType.SetRelates(ITypeDBTransaction transaction, string roleLabel) ----- - - - -Sets the new role that this ``IRelationType`` relates to. - - - See also - - - IRelationType::SetRelates(ITypeDBTransaction, string, string) - - - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel__IRoleType_overriddenType_] -==== SetRelates - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IRelationType.SetRelates(ITypeDBTransaction transaction, string roleLabel, IRoleType overriddenType) ----- - - - -Sets the new role that this ``IRelationType`` relates to. - - - See also - - - IRelationType::SetRelates(ITypeDBTransaction, string, string) - - - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel__string_overriddenLabel_] -==== SetRelates - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IRelationType.SetRelates(ITypeDBTransaction transaction, string roleLabel, string? overriddenLabel) ----- - - - -Sets the new role that this ``IRelationType`` relates to. If we are setting an overriding type this way, we have to also pass the overridden type as a second argument. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| The new role for the ``IRelationType`` to relate to a| -a| `overriddenLabel` a| The label being overridden, if applicable a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetSupertype___ITypeDBTransaction_transaction__IRelationType_superRelationType_] -==== SetSupertype - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IRelationType.SetSupertype(ITypeDBTransaction transaction, IRelationType superRelationType) ----- - - - -Sets the supplied ``IRelationType`` as the supertype of the current ``IRelationType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `superRelationType` a| The ``IRelationType`` to set as the supertype of this ``IRelationType`` a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__IRoleType_roleType_] -==== UnsetRelates - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IRelationType.UnsetRelates(ITypeDBTransaction transaction, IRoleType roleType) ----- - - - -Disallows this ``IRelationType`` from relating to the given role. - - - See also - - - <<#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__string_roleLabel_,IRelationType::UnsetRelates(ITypeDBTransaction, string)>> - - - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__string_roleLabel_] -==== UnsetRelates - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IRelationType.UnsetRelates(ITypeDBTransaction transaction, string roleLabel) ----- - - - -Disallows this ``IRelationType`` from relating to the given role. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| The role to not relate to the relation type. a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -// end::methods[] - diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IRoleType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IRoleType.adoc deleted file mode 100644 index 3480e7c75f..0000000000 --- a/csharp/docs/schema/TypeDB.Driver.Api.IRoleType.adoc +++ /dev/null @@ -1,238 +0,0 @@ -[#_TypeDB_Driver_Api_IRoleType_Interface_Reference] -=== TypeDB.Driver.Api.IRoleType Interface Reference - -*Package*: `TypeDB.Driver.Api.IRoleType Interface Reference` - -*Supertypes:* - -* `TypeDB.Driver.Api.IType` -* `TypeDB.Driver.Api.IConcept` - - - -Roles are special internal types used by relations. We can not create an instance of a role in a database. But we can set an instance of another type (role player) to play a role in a particular instance of a relation type. Roles allow a schema to enforce logical constraints on types of role players. - -// tag::methods[] -[#_IRoleType_IConcept__TypeDB_Driver_Api_IRoleType_AsRoleType___] -==== AsRoleType - -[source,cs] ----- -IRoleType IConcept. TypeDB.Driver.Api.IRoleType.AsRoleType() ----- - - - -Casts the concept to ``IRoleType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`IRoleType IConcept.` - -[#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction_] -==== GetPlayerInstances - -[source,cs] ----- -IEnumerable< IThing > TypeDB.Driver.Api.IRoleType.GetPlayerInstances(ITypeDBTransaction transaction) ----- - - - -Retrieves the ``Thing`` instances that play this role. - - - See also - - - <<#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction_,IRoleType::GetPlayerInstances>>(ITypeDBTransaction, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IThing >` - -[#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] -==== GetPlayerInstances - -[source,cs] ----- -IEnumerable< IThing > TypeDB.Driver.Api.IRoleType.GetPlayerInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ----- - - - -Retrieves the ``Thing`` instances that play this role. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| -|=== - -[caption=""] -.Returns -`IEnumerable< IThing >` - -[#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction_] -==== GetPlayerTypes - -[source,cs] ----- -IEnumerable< IThingType > TypeDB.Driver.Api.IRoleType.GetPlayerTypes(ITypeDBTransaction transaction) ----- - - - -Retrieves the ``ThingType``s whose instances play this role. Equivalent to ``GetPlayerTypes(transaction, Transitive)``. - - - See also - - - <<#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction_,IRoleType::GetPlayerTypes>>(ITypeDBTransaction, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IThingType >` - -[#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] -==== GetPlayerTypes - -[source,cs] ----- -IEnumerable< IThingType > TypeDB.Driver.Api.IRoleType.GetPlayerTypes(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ----- - - - -Retrieves the ``ThingType``s whose instances play this role. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| -|=== - -[caption=""] -.Returns -`IEnumerable< IThingType >` - -[#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction_] -==== GetRelationInstances - -[source,cs] ----- -IEnumerable< IRelation > TypeDB.Driver.Api.IRoleType.GetRelationInstances(ITypeDBTransaction transaction) ----- - - - -Retrieves the ``Relation`` instances that this role is related to. Equivalent to ``GetRelationInstances(transaction, Transitive)`` - - - See also - - - <<#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction_,IRoleType::GetRelationInstances>>(ITypeDBTransaction, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IRelation >` - -[#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] -==== GetRelationInstances - -[source,cs] ----- -IEnumerable< IRelation > TypeDB.Driver.Api.IRoleType.GetRelationInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ----- - - - -Retrieves the ``Relation`` instances that this role is related to. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and indirect relation, ``Explicit`` for direct relation only a| -|=== - -[caption=""] -.Returns -`IEnumerable< IRelation >` - -[#_IEnumerable__IRelationType___TypeDB_Driver_Api_IRoleType_GetRelationTypes___ITypeDBTransaction_transaction_] -==== GetRelationTypes - -[source,cs] ----- -IEnumerable< IRelationType > TypeDB.Driver.Api.IRoleType.GetRelationTypes(ITypeDBTransaction transaction) ----- - - - -Retrieves ``RelationType``s that this role is related to (directly or indirectly). - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`IEnumerable< IRelationType >` - -[#_bool_IConcept__TypeDB_Driver_Api_IRoleType_IsRoleType___] -==== IsRoleType - -[source,cs] ----- -bool IConcept. TypeDB.Driver.Api.IRoleType.IsRoleType() ----- - - - -Checks if the concept is a ``IRoleType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`bool IConcept.` - -// end::methods[] - diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc deleted file mode 100644 index 0544922cdc..0000000000 --- a/csharp/docs/schema/TypeDB.Driver.Api.IThingType.Annotation.adoc +++ /dev/null @@ -1,139 +0,0 @@ -[#_TypeDB_Driver_Api_IThingType_Annotation] -=== TypeDB.Driver.Api.IThingType.Annotation - -*Package*: `TypeDB.Driver.Api.IThingType.Annotation` - - - -Annotation - -// tag::methods[] -[#_override_bool_TypeDB_Driver_Api_IThingType_Annotation_Equals___object_obj_] -==== Equals - -[source,csharp] ----- -override bool TypeDB.Driver.Api.IThingType.Annotation.Equals(object? obj) ----- - - - -Checks if this ``Annotation`` is equal to another object. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `obj` a| Object to compare with a| -|=== - -[caption=""] -.Returns -`override bool` - -[#_override_int_TypeDB_Driver_Api_IThingType_Annotation_GetHashCode___] -==== GetHashCode - -[source,csharp] ----- -override int TypeDB.Driver.Api.IThingType.Annotation.GetHashCode() ----- - - - -@hidden - -[caption=""] -.Returns -`override int` - -[#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsKey___] -==== IsKey - -[source,csharp] ----- -bool TypeDB.Driver.Api.IThingType.Annotation.IsKey() ----- - - - -Checks if this ``Annotation`` is a ``@key`` annotation. - - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsUnique___] -==== IsUnique - -[source,csharp] ----- -bool TypeDB.Driver.Api.IThingType.Annotation.IsUnique() ----- - - - -Checks if this ``Annotation`` is a ``@unique`` annotation. - - -[caption=""] -.Returns -`bool` - -[#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewKey___] -==== NewKey - -[source,csharp] ----- -static Annotation TypeDB.Driver.Api.IThingType.Annotation.NewKey() ----- - - - -Produces a ``@key`` annotation. - - -[caption=""] -.Returns -`static Annotation` - -[#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewUnique___] -==== NewUnique - -[source,csharp] ----- -static Annotation TypeDB.Driver.Api.IThingType.Annotation.NewUnique() ----- - - - -Produces a ``@unique`` annotation. - - -[caption=""] -.Returns -`static Annotation` - -[#_override_string_TypeDB_Driver_Api_IThingType_Annotation_ToString___] -==== ToString - -[source,csharp] ----- -override string TypeDB.Driver.Api.IThingType.Annotation.ToString() ----- - - - -Retrieves a string representation of this ``Annotation``. - - -[caption=""] -.Returns -`override string` - -// end::methods[] - diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IThingType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IThingType.adoc deleted file mode 100644 index 36cfa75164..0000000000 --- a/csharp/docs/schema/TypeDB.Driver.Api.IThingType.adoc +++ /dev/null @@ -1,693 +0,0 @@ -[#_TypeDB_Driver_Api_IThingType_Interface_Reference] -=== TypeDB.Driver.Api.IThingType Interface Reference - -*Package*: `TypeDB.Driver.Api.IThingType Interface Reference` - -*Supertypes:* - -* `TypeDB.Driver.Api.IType` -* `TypeDB.Driver.Api.IConcept` - -// tag::methods[] -[#_IThingType_IConcept__TypeDB_Driver_Api_IThingType_AsThingType___] -==== AsThingType - -[source,cs] ----- -IThingType IConcept. TypeDB.Driver.Api.IThingType.AsThingType() ----- - - - -Casts the concept to ``IThingType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`IThingType IConcept.` - -[#_IEnumerable__IThing___TypeDB_Driver_Api_IThingType_GetInstances___ITypeDBTransaction_transaction_] -==== GetInstances - -[source,cs] ----- -IEnumerable< IThing > TypeDB.Driver.Api.IThingType.GetInstances(ITypeDBTransaction transaction) ----- - - - -Retrieves all ``IThing`` objects that are instances of this ``IThingType`` or its subtypes. Equivalent to ``GetInstances(transaction, Transitive)`` - - - See also - - - ThingType::GetInstances(ITypeDBTransaction, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IThing >` - -[#_IEnumerable__IThing___TypeDB_Driver_Api_IThingType_GetInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] -==== GetInstances - -[source,cs] ----- -IEnumerable< IThing > TypeDB.Driver.Api.IThingType.GetInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ----- - - - -Retrieves ``IThing`` objects that are instances of this exact ``IThingType``, OR this ``IThingType`` and any of its subtypes - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Explicit`` for direct instances only, ``Transitive`` to include instances of subtypes a| -|=== - -[caption=""] -.Returns -`IEnumerable< IThing >` - -[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction_] -==== GetOwns - -[source,cs] ----- -IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction) ----- - - - -Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - - - See also - - - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IAttributeType >` - -[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType_] -==== GetOwns - -[source,cs] ----- -IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, IValue.ValueType valueType) ----- - - - -Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - - - See also - - - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IAttributeType >` - -[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] -==== GetOwns - -[source,cs] ----- -IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, ICollection< Annotation > annotations) ----- - - - -Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - - - See also - - - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IAttributeType >` - -[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__ICollection__Annotation___annotations_] -==== GetOwns - -[source,cs] ----- -IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, ICollection< Annotation > annotations) ----- - - - -Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - - - See also - - - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IAttributeType >` - -[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] -==== GetOwns - -[source,cs] ----- -IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ----- - - - -Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - - - See also - - - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IAttributeType >` - -[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__IConcept_Transitivity_transitivity_] -==== GetOwns - -[source,cs] ----- -IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, IConcept.Transitivity transitivity) ----- - - - -Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - - - See also - - - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IAttributeType >` - -[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] -==== GetOwns - -[source,cs] ----- -IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) ----- - - - -Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - - - See also - - - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IAttributeType >` - -[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] -==== GetOwns - -[source,cs] ----- -IEnumerable< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) ----- - - - -Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `valueType` a| If specified, only attribute types of this ``ValueType`` will be retrieved. a| -a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| -a| `annotations` a| Only retrieve attribute types owned with annotations. a| -|=== - -[caption=""] -.Returns -`IEnumerable< IAttributeType >` - -[#_Promise__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwnsOverridden___ITypeDBTransaction_transaction__IAttributeType_attributeType_] -==== GetOwnsOverridden - -[source,cs] ----- -Promise< IAttributeType > TypeDB.Driver.Api.IThingType.GetOwnsOverridden(ITypeDBTransaction transaction, IAttributeType attributeType) ----- - - - -Retrieves an ``IAttributeType``, ownership of which is overridden for this ``IThingType`` by a given ``IAttributeType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``IAttributeType`` that overrides requested ``IAttributeType`` a| -|=== - -[caption=""] -.Returns -`Promise< IAttributeType >` - -[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThingType_GetPlays___ITypeDBTransaction_transaction_] -==== GetPlays - -[source,cs] ----- -IEnumerable< IRoleType > TypeDB.Driver.Api.IThingType.GetPlays(ITypeDBTransaction transaction) ----- - - - -Retrieves all direct and inherited roles that are allowed to be played by the instances of this ``IThingType``. - - - See also - - - ThingType::GetPlays(ITypeDBTransaction, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IRoleType >` - -[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThingType_GetPlays___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] -==== GetPlays - -[source,cs] ----- -IEnumerable< IRoleType > TypeDB.Driver.Api.IThingType.GetPlays(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ----- - - - -Retrieves all direct and inherited (or direct only) roles that are allowed to be played by the instances of this ``IThingType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| transitivity: ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| -|=== - -[caption=""] -.Returns -`IEnumerable< IRoleType >` - -[#_Promise__IRoleType___TypeDB_Driver_Api_IThingType_GetPlaysOverridden___ITypeDBTransaction_transaction__IRoleType_roleType_] -==== GetPlaysOverridden - -[source,cs] ----- -Promise< IRoleType > TypeDB.Driver.Api.IThingType.GetPlaysOverridden(ITypeDBTransaction transaction, IRoleType roleType) ----- - - - -Retrieves a ``IRoleType`` that is overridden by the given ``role_type`` for this ``IThingType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The ``IRoleType`` that overrides an inherited role a| -|=== - -[caption=""] -.Returns -`Promise< IRoleType >` - -[#_Promise__string___TypeDB_Driver_Api_IThingType_GetSyntax___ITypeDBTransaction_transaction_] -==== GetSyntax - -[source,cs] ----- -Promise< string > TypeDB.Driver.Api.IThingType.GetSyntax(ITypeDBTransaction transaction) ----- - - - -Produces a pattern for creating this ``IThingType`` in a ``define`` query. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`Promise< string >` - -[#_bool_IConcept__TypeDB_Driver_Api_IThingType_IsThingType___] -==== IsThingType - -[source,cs] ----- -bool IConcept. TypeDB.Driver.Api.IThingType.IsThingType() ----- - - - -Checks if the concept is a ``IThingType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`bool IConcept.` - -[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetAbstract___ITypeDBTransaction_transaction_] -==== SetAbstract - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThingType.SetAbstract(ITypeDBTransaction transaction) ----- - - - -Set a ``IThingType`` to be abstract, meaning it cannot have instances. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__IAttributeType_overriddenType__ICollection__Annotation___annotations_] -==== SetOwns - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThingType.SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, IAttributeType? overriddenType, ICollection< Annotation > annotations) ----- - - - -Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. Optionally, overriding a previously declared ownership. Optionally, adds annotations to the ownership. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``IAttributeType`` to be owned by the instances of this type. a| -a| `overriddenType` a| The ``IAttributeType`` that this attribute ownership overrides, if applicable. a| -a| `annotations` a| Adds annotations to the ownership. a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__IAttributeType_overriddenType_] -==== SetOwns - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThingType.SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, IAttributeType overriddenType) ----- - - - -Allows the instances of this ``IThingType`` to own the given ``IAttributeType``, - - - See also - - - ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) - - - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__ICollection__Annotation___annotations_] -==== SetOwns - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThingType.SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, ICollection< Annotation > annotations) ----- - - - -Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. - - - See also - - - ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) - - - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType_] -==== SetOwns - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThingType.SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType) ----- - - - -Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. - - - See also - - - ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) - - - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetPlays___ITypeDBTransaction_transaction__IRoleType_roleType_] -==== SetPlays - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThingType.SetPlays(ITypeDBTransaction transaction, IRoleType roleType) ----- - - - -Allows the instances of this ``IThingType`` to play the given role. - - - See also - - - ThingType::SetPlays(ITypeDBTransaction, IRoleType, IRoleType) - - - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetPlays___ITypeDBTransaction_transaction__IRoleType_roleType__IRoleType_overriddenType_] -==== SetPlays - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThingType.SetPlays(ITypeDBTransaction transaction, IRoleType roleType, IRoleType overriddenType) ----- - - - -Allows the instances of this ``IThingType`` to play the given role. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to be played by the instances of this type a| -a| `overriddenType` a| The role type that this role overrides, if applicable a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetAbstract___ITypeDBTransaction_transaction_] -==== UnsetAbstract - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThingType.UnsetAbstract(ITypeDBTransaction transaction) ----- - - - -Set a ``IThingType`` to be non-abstract, meaning it can have instances. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType_] -==== UnsetOwns - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThingType.UnsetOwns(ITypeDBTransaction transaction, IAttributeType attributeType) ----- - - - -Disallows the instances of this ``IThingType`` from owning the given ``IAttributeType``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``IAttributeType`` to not be owned by the type. a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetPlays___ITypeDBTransaction_transaction__IRoleType_roleType_] -==== UnsetPlays - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IThingType.UnsetPlays(ITypeDBTransaction transaction, IRoleType roleType) ----- - - - -Disallows the instances of this ``IThingType`` from playing the given role. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to not be played by the instances of this type. a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -// end::methods[] - diff --git a/csharp/docs/schema/TypeDB.Driver.Api.IType.adoc b/csharp/docs/schema/TypeDB.Driver.Api.IType.adoc deleted file mode 100644 index f4f49607d9..0000000000 --- a/csharp/docs/schema/TypeDB.Driver.Api.IType.adoc +++ /dev/null @@ -1,270 +0,0 @@ -[#_TypeDB_Driver_Api_IType_Interface_Reference] -=== TypeDB.Driver.Api.IType Interface Reference - -*Package*: `TypeDB.Driver.Api.IType Interface Reference` - -*Supertypes:* - -* `TypeDB.Driver.Api.IConcept` - -// tag::methods[] -[#_IType_IConcept__TypeDB_Driver_Api_IType_AsType___] -==== AsType - -[source,cs] ----- -IType IConcept. TypeDB.Driver.Api.IType.AsType() ----- - - - -Casts the concept to ``IType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`IType IConcept.` - -[#_VoidPromise_TypeDB_Driver_Api_IType_Delete___ITypeDBTransaction_transaction_] -==== Delete - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IType.Delete(ITypeDBTransaction transaction) ----- - - - -Deletes this type from the database. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSubtypes___ITypeDBTransaction_transaction_] -==== GetSubtypes - -[source,cs] ----- -IEnumerable< IType > TypeDB.Driver.Api.IType.GetSubtypes(ITypeDBTransaction transaction) ----- - - - -Retrieves all direct and indirect subtypes of the type. Equivalent to ``GetSubtypes(transaction, Transitive)`` - - - See also - - - Type::GetSubtypes(ITypeDBTransaction, IConcept.Transitivity) - - - -[caption=""] -.Returns -`IEnumerable< IType >` - -[#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSubtypes___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] -==== GetSubtypes - -[source,cs] ----- -IEnumerable< IType > TypeDB.Driver.Api.IType.GetSubtypes(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ----- - - - -Retrieves all direct and indirect (or direct only) subtypes of the type. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| -|=== - -[caption=""] -.Returns -`IEnumerable< IType >` - -[#_Promise__IType___TypeDB_Driver_Api_IType_GetSupertype___ITypeDBTransaction_transaction_] -==== GetSupertype - -[source,cs] ----- -Promise< IType > TypeDB.Driver.Api.IType.GetSupertype(ITypeDBTransaction transaction) ----- - - - -Retrieves the most immediate supertype of the type. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`Promise< IType >` - -[#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSupertypes___ITypeDBTransaction_transaction_] -==== GetSupertypes - -[source,cs] ----- -IEnumerable< IType > TypeDB.Driver.Api.IType.GetSupertypes(ITypeDBTransaction transaction) ----- - - - -Retrieves all supertypes of the type. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`IEnumerable< IType >` - -[#_bool_TypeDB_Driver_Api_IType_IsAbstract___] -==== IsAbstract - -[source,cs] ----- -bool TypeDB.Driver.Api.IType.IsAbstract() ----- - - - -Checks if the type is prevented from having data instances (i.e., ``abstract``). - - -[caption=""] -.Returns -`bool` - -[#_Promise__bool___TypeDB_Driver_Api_IType_IsDeleted___ITypeDBTransaction_transaction_] -==== IsDeleted - -[source,cs] ----- -Promise< bool > TypeDB.Driver.Api.IType.IsDeleted(ITypeDBTransaction transaction) ----- - - - -Check if the concept has been deleted. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -|=== - -[caption=""] -.Returns -`Promise< bool >` - -[#_bool_TypeDB_Driver_Api_IType_IsRoot___] -==== IsRoot - -[source,cs] ----- -bool TypeDB.Driver.Api.IType.IsRoot() ----- - - - -Checks if the type is a root type. - - -[caption=""] -.Returns -`bool` - -[#_bool_IConcept__TypeDB_Driver_Api_IType_IsType___] -==== IsType - -[source,cs] ----- -bool IConcept. TypeDB.Driver.Api.IType.IsType() ----- - - - -Checks if the concept is a ``IType``. - - - - -Implements TypeDB.Driver.Api.IConcept. - -[caption=""] -.Returns -`bool IConcept.` - -[#_VoidPromise_TypeDB_Driver_Api_IType_SetLabel___ITypeDBTransaction_transaction__string_label_] -==== SetLabel - -[source,cs] ----- -VoidPromise TypeDB.Driver.Api.IType.SetLabel(ITypeDBTransaction transaction, string label) ----- - - - -Renames the label of the type. The new label must remain unique. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `label` a| The new ``Label`` to be given to the type. a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -// end::methods[] - diff --git a/csharp/docs/session/TypeDB.Driver.Api.ITypeDBSession.adoc b/csharp/docs/session/TypeDB.Driver.Api.ITypeDBSession.adoc deleted file mode 100644 index 6dd0dd4349..0000000000 --- a/csharp/docs/session/TypeDB.Driver.Api.ITypeDBSession.adoc +++ /dev/null @@ -1,145 +0,0 @@ -[#_TypeDB_Driver_Api_ITypeDBSession_Interface_Reference] -=== TypeDB.Driver.Api.ITypeDBSession Interface Reference - -*Package*: `TypeDB.Driver.Api.ITypeDBSession Interface Reference` - -// tag::methods[] -[#_void_TypeDB_Driver_Api_ITypeDBSession_Close___] -==== Close - -[source,cs] ----- -void TypeDB.Driver.Api.ITypeDBSession.Close() ----- - - - -Closes the session. Before opening a new session, the session currently open should first be closed. - - -[caption=""] -.Returns -`void` - -[#_bool_TypeDB_Driver_Api_ITypeDBSession_IsOpen___] -==== IsOpen - -[source,cs] ----- -bool TypeDB.Driver.Api.ITypeDBSession.IsOpen() ----- - - - -Checks whether this session is open. - - -[caption=""] -.Returns -`bool` - -[#_void_TypeDB_Driver_Api_ITypeDBSession_OnClose___Action_function_] -==== OnClose - -[source,cs] ----- -void TypeDB.Driver.Api.ITypeDBSession.OnClose(Action function) ----- - - - -Registers a callback function which will be executed when this session is closed. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `function` a| The callback function. a| -|=== - -[caption=""] -.Returns -`void` - -[#_void_TypeDB_Driver_Api_ITypeDBSession_OnReopen___Action_function_] -==== OnReopen - -[source,cs] ----- -void TypeDB.Driver.Api.ITypeDBSession.OnReopen(Action function) ----- - - - -Registers a callback function which will be executed when this session is reopened. A session may be closed if it times out, or loses the connection to the database. In such situations, the session is reopened automatically when opening a new transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `function` a| The callback function. a| -|=== - -[caption=""] -.Returns -`void` - -[#_ITypeDBTransaction_TypeDB_Driver_Api_ITypeDBSession_Transaction___TransactionType_type_] -==== Transaction - -[source,cs] ----- -ITypeDBTransaction TypeDB.Driver.Api.ITypeDBSession.Transaction(TransactionType type) ----- - - - -Opens a transaction on the database connected to the session with default options. - - - See also - - - ITypeDBSession::Transaction(TransactionType, TypeDBOptions) - - - -[caption=""] -.Returns -`ITypeDBTransaction` - -[#_ITypeDBTransaction_TypeDB_Driver_Api_ITypeDBSession_Transaction___TransactionType_type__TypeDBOptions_options_] -==== Transaction - -[source,cs] ----- -ITypeDBTransaction TypeDB.Driver.Api.ITypeDBSession.Transaction(TransactionType type, TypeDBOptions options) ----- - - - -Opens a transaction to perform read or write queries on the database connected to the session. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `type` a| The type of transaction to be created (Read or Write) a| -a| `options` a| Options for the session a| -|=== - -[caption=""] -.Returns -`ITypeDBTransaction` - -// end::methods[] - diff --git a/csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc b/csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc deleted file mode 100644 index c4ae66f554..0000000000 --- a/csharp/docs/session/TypeDB.Driver.Api.TypeDBOptions.adoc +++ /dev/null @@ -1,459 +0,0 @@ -[#_TypeDB_Driver_Api_TypeDBOptions] -=== TypeDB.Driver.Api.TypeDBOptions - -*Package*: `TypeDB.Driver.Api.TypeDBOptions` - - - -TypeDB session and transaction options. ``TypeDBOptions`` object can be used to override the default server behaviour. - -// tag::methods[] -[#_bool_TypeDB_Driver_Api_TypeDBOptions_Explain___] -==== Explain - -[source,csharp] ----- -bool? TypeDB.Driver.Api.TypeDBOptions.Explain() ----- - - - -Returns the value set for the explanation in this ``TypeDBOptions`` object. If set to ``true``, explanations for queries are enabled. - - -[caption=""] -.Returns -`bool?` - -[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Explain___bool_explain_] -==== Explain - -[source,csharp] ----- -TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Explain(bool explain) ----- - - - -Explicitly enables or disables explanations. If set to ``true``, enables explanations for queries. Only affects read transactions. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `explain` a| Explicitly enable or disable explanations a| -|=== - -[caption=""] -.Returns -`TypeDBOptions` - -[#_bool_TypeDB_Driver_Api_TypeDBOptions_Infer___] -==== Infer - -[source,csharp] ----- -bool? TypeDB.Driver.Api.TypeDBOptions.Infer() ----- - - - -Returns the value set for the inference in this ``TypeDBOptions`` object. - - -[caption=""] -.Returns -`bool?` - -[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Infer___bool_infer_] -==== Infer - -[source,csharp] ----- -TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Infer(bool infer) ----- - - - -Explicitly enables or disables inference. Only settable at transaction level and above. Only affects read transactions. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `infer` a| Explicitly enable or disable inference a| -|=== - -[caption=""] -.Returns -`TypeDBOptions` - -[#_bool_TypeDB_Driver_Api_TypeDBOptions_Parallel___] -==== Parallel - -[source,csharp] ----- -bool? TypeDB.Driver.Api.TypeDBOptions.Parallel() ----- - - - -Returns the value set for the parallel execution in this ``TypeDBOptions`` object. If set to ``true``, the server uses parallel instead of single-threaded execution. - - -[caption=""] -.Returns -`bool?` - -[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Parallel___bool_parallel_] -==== Parallel - -[source,csharp] ----- -TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Parallel(bool parallel) ----- - - - -Explicitly enables or disables parallel execution. If set to ``true``, the server uses parallel instead of single-threaded execution. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `parallel` a| Explicitly enable or disable parallel execution a| -|=== - -[caption=""] -.Returns -`TypeDBOptions` - -[#_bool_TypeDB_Driver_Api_TypeDBOptions_Prefetch___] -==== Prefetch - -[source,csharp] ----- -bool? TypeDB.Driver.Api.TypeDBOptions.Prefetch() ----- - - - -Returns the value set for the prefetching in this ``TypeDBOptions`` object. If set to ``true``, the first batch of answers is streamed to the driver even without an explicit request for it. - - -[caption=""] -.Returns -`bool?` - -[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Prefetch___bool_prefetch_] -==== Prefetch - -[source,csharp] ----- -TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.Prefetch(bool prefetch) ----- - - - -Explicitly enables or disables prefetching. If set to ``true``, the first batch of answers is streamed to the driver even without an explicit request for it. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `prefetch` a| Explicitly enable or disable prefetching a| -|=== - -[caption=""] -.Returns -`TypeDBOptions` - -[#_int_TypeDB_Driver_Api_TypeDBOptions_PrefetchSize___] -==== PrefetchSize - -[source,csharp] ----- -int? TypeDB.Driver.Api.TypeDBOptions.PrefetchSize() ----- - - - -Returns the value set for the prefetch size in this ``TypeDBOptions`` object. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request. - - -[caption=""] -.Returns -`int?` - -[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_PrefetchSize___int_prefetchSize_] -==== PrefetchSize - -[source,csharp] ----- -TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.PrefetchSize(int prefetchSize) ----- - - - -Explicitly sets a prefetch size. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `prefetchSize` a| Number of answers that the server should send before the driver issues a fresh request a| -|=== - -[caption=""] -.Returns -`TypeDBOptions` - -[#_bool_TypeDB_Driver_Api_TypeDBOptions_ReadAnyReplica___] -==== ReadAnyReplica - -[source,csharp] ----- -bool? TypeDB.Driver.Api.TypeDBOptions.ReadAnyReplica() ----- - - - -Returns the value set for reading data from any replica in this ``TypeDBOptions`` object. If set to ``True``, enables reading data from any replica, potentially boosting read throughput. - - -[caption=""] -.Returns -`bool?` - -[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_ReadAnyReplica___bool_readAnyReplica_] -==== ReadAnyReplica - -[source,csharp] ----- -TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.ReadAnyReplica(bool readAnyReplica) ----- - - - -Explicitly enables or disables reading data from any replica. If set to ``True``, enables reading data from any replica, potentially boosting read throughput. Only settable in TypeDB Cloud. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `readAnyReplica` a| Explicitly enable or disable reading data from any replica a| -|=== - -[caption=""] -.Returns -`TypeDBOptions` - -[#_int_TypeDB_Driver_Api_TypeDBOptions_SchemaLockAcquireTimeoutMillis___] -==== SchemaLockAcquireTimeoutMillis - -[source,csharp] ----- -int? TypeDB.Driver.Api.TypeDBOptions.SchemaLockAcquireTimeoutMillis() ----- - - - -Returns the value set for the schema lock acquire timeout in this ``TypeDBOptions`` object. If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock. - - -[caption=""] -.Returns -`int?` - -[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_SchemaLockAcquireTimeoutMillis___int_schemaLockAcquireTimeoutMillis_] -==== SchemaLockAcquireTimeoutMillis - -[source,csharp] ----- -TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.SchemaLockAcquireTimeoutMillis(int schemaLockAcquireTimeoutMillis) ----- - - - -Explicitly sets schema lock acquire timeout. If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `schemaLockAcquireTimeoutMillis` a| How long the driver should wait if opening a session or transaction is blocked by a schema write lock. a| -|=== - -[caption=""] -.Returns -`TypeDBOptions` - -[#_int_TypeDB_Driver_Api_TypeDBOptions_SessionIdleTimeoutMillis___] -==== SessionIdleTimeoutMillis - -[source,csharp] ----- -int? TypeDB.Driver.Api.TypeDBOptions.SessionIdleTimeoutMillis() ----- - - - -Returns the value set for the session idle timeout in this ``TypeDBOptions`` object. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. - - -[caption=""] -.Returns -`int?` - -[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_SessionIdleTimeoutMillis___int_sessionIdleTimeoutMillis_] -==== SessionIdleTimeoutMillis - -[source,csharp] ----- -TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.SessionIdleTimeoutMillis(int sessionIdleTimeoutMillis) ----- - - - -Explicitly sets a session idle timeout. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `sessionIdleTimeoutMillis` a| timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. a| -|=== - -[caption=""] -.Returns -`TypeDBOptions` - -[#_bool_TypeDB_Driver_Api_TypeDBOptions_TraceInference___] -==== TraceInference - -[source,csharp] ----- -bool? TypeDB.Driver.Api.TypeDBOptions.TraceInference() ----- - - - -Returns the value set for reasoning tracing in this ``TypeDBOptions`` object. If set to ``true``, reasoning tracing graphs are output in the logging directory. - - -[caption=""] -.Returns -`bool?` - -[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_TraceInference___bool_traceInference_] -==== TraceInference - -[source,csharp] ----- -TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.TraceInference(bool traceInference) ----- - - - -Explicitly enables or disables reasoning tracing. If set to ``true``, reasoning tracing graphs are output in the logging directory. Should be used with ``parallel = False``. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `traceInference` a| Explicitly enable or disable reasoning tracing a| -|=== - -[caption=""] -.Returns -`TypeDBOptions` - -[#_int_TypeDB_Driver_Api_TypeDBOptions_TransactionTimeoutMillis___] -==== TransactionTimeoutMillis - -[source,csharp] ----- -int? TypeDB.Driver.Api.TypeDBOptions.TransactionTimeoutMillis() ----- - - - -Returns the value set for the transaction timeout in this ``TypeDBOptions`` object. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions. - - -[caption=""] -.Returns -`int?` - -[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_TransactionTimeoutMillis___int_transactionTimeoutMillis_] -==== TransactionTimeoutMillis - -[source,csharp] ----- -TypeDBOptions TypeDB.Driver.Api.TypeDBOptions.TransactionTimeoutMillis(int transactionTimeoutMillis) ----- - - - -Explicitly set a transaction timeout. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transactionTimeoutMillis` a| Timeout for killing transactions automatically. a| -|=== - -[caption=""] -.Returns -`TypeDBOptions` - -[#_TypeDB_Driver_Api_TypeDBOptions_TypeDBOptions___] -==== TypeDBOptions - -[source,csharp] ----- -TypeDB.Driver.Api.TypeDBOptions.TypeDBOptions() ----- - - - -Produces a new ``TypeDBOptions`` object. - - -[caption=""] -.Returns -`TypeDB.Driver.Api.TypeDBOptions.TypeDBOptions` - -// end::methods[] - diff --git a/csharp/docs/test/TypeDB.Driver.Api.IThingType.Annotation.adoc b/csharp/docs/test/TypeDB.Driver.Api.IThingType.Annotation.adoc deleted file mode 100644 index a614a307c9..0000000000 --- a/csharp/docs/test/TypeDB.Driver.Api.IThingType.Annotation.adoc +++ /dev/null @@ -1,139 +0,0 @@ -[#_TypeDB_Driver_Api_IThingType_Annotation] -=== TypeDB.Driver.Api.IThingType.Annotation - -*Package*: `TypeDB.Driver.Api.IThingType.Annotation` - - - -Annotation - -// tag::methods[] -[#_override_bool_TypeDB_Driver_Api_IThingType_Annotation_Equals___object_obj_] -==== Equals - -[source,cs] ----- -override bool TypeDB.Driver.Api.IThingType.Annotation.Equals(object? obj) ----- - - - -Checks if this ``Annotation`` is equal to another object. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `obj` a| Object to compare with a| -|=== - -[caption=""] -.Returns -`override bool` - -[#_override_int_TypeDB_Driver_Api_IThingType_Annotation_GetHashCode___] -==== GetHashCode - -[source,cs] ----- -override int TypeDB.Driver.Api.IThingType.Annotation.GetHashCode() ----- - - - -@hidden - -[caption=""] -.Returns -`override int` - -[#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsKey___] -==== IsKey - -[source,cs] ----- -bool TypeDB.Driver.Api.IThingType.Annotation.IsKey() ----- - - - -Checks if this ``Annotation`` is a ``@key`` annotation. - - -[caption=""] -.Returns -`bool` - -[#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsUnique___] -==== IsUnique - -[source,cs] ----- -bool TypeDB.Driver.Api.IThingType.Annotation.IsUnique() ----- - - - -Checks if this ``Annotation`` is a ``@unique`` annotation. - - -[caption=""] -.Returns -`bool` - -[#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewKey___] -==== NewKey - -[source,cs] ----- -static Annotation TypeDB.Driver.Api.IThingType.Annotation.NewKey() ----- - - - -Produces a ``@key`` annotation. - - -[caption=""] -.Returns -`static Annotation` - -[#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewUnique___] -==== NewUnique - -[source,cs] ----- -static Annotation TypeDB.Driver.Api.IThingType.Annotation.NewUnique() ----- - - - -Produces a ``@unique`` annotation. - - -[caption=""] -.Returns -`static Annotation` - -[#_override_string_TypeDB_Driver_Api_IThingType_Annotation_ToString___] -==== ToString - -[source,cs] ----- -override string TypeDB.Driver.Api.IThingType.Annotation.ToString() ----- - - - -Retrieves a string representation of this ``Annotation``. - - -[caption=""] -.Returns -`override string` - -// end::methods[] - diff --git a/csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc b/csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc deleted file mode 100644 index 797bbf965b..0000000000 --- a/csharp/docs/transaction/TypeDB.Driver.Api.IQueryManager.adoc +++ /dev/null @@ -1,573 +0,0 @@ -[#_TypeDB_Driver_Api_IQueryManager_Interface_Reference] -=== TypeDB.Driver.Api.IQueryManager Interface Reference - -*Package*: `TypeDB.Driver.Api.IQueryManager Interface Reference` - - - -Provides methods for executing TypeQL queries in the transaction. - -// tag::methods[] -[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query_] -==== Define - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IQueryManager.Define(string query) ----- - - - -Performs a TypeQL Define query with default options. - - - See also - - - <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query__TypeDBOptions_options_,IQueryManager::Define(string, TypeDBOptions)>> - - - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query__TypeDBOptions_options_] -==== Define - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IQueryManager.Define(string query, TypeDBOptions options) ----- - - - -Performs a TypeQL Define query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `query` a| The TypeQL Define query to be executed a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query_] -==== Delete - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IQueryManager.Delete(string query) ----- - - - -Performs a TypeQL Delete query with default options. - - - See also - - - <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query__TypeDBOptions_options_,IQueryManager::Delete(string, TypeDBOptions)>> - - - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query__TypeDBOptions_options_] -==== Delete - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IQueryManager.Delete(string query, TypeDBOptions options) ----- - - - -Performs a TypeQL Delete query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `query` a| The TypeQL Delete query to be executed a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable_] -==== Explain - -[source,csharp] ----- -IEnumerable< IExplanation > TypeDB.Driver.Api.IQueryManager.Explain(IConceptMap.IExplainable explainable) ----- - - - -Performs a TypeQL Explain query with default options. - - - See also - - - <<#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable_,IQueryManager::Explain>>(IConceptMap.IExplainable, TypeDBOptions) - - - -[caption=""] -.Returns -`IEnumerable< IExplanation >` - -[#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable__TypeDBOptions_options_] -==== Explain - -[source,csharp] ----- -IEnumerable< IExplanation > TypeDB.Driver.Api.IQueryManager.Explain(IConceptMap.IExplainable explainable, TypeDBOptions options) ----- - - - -Performs a TypeQL Explain query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `explainable` a| The IExplainable to be explained a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`IEnumerable< IExplanation >` - -[#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query_] -==== Fetch - -[source,csharp] ----- -IEnumerable< JObject > TypeDB.Driver.Api.IQueryManager.Fetch(string query) ----- - - - -Performs a TypeQL Fetch (Fetch) with default options. - - - See also - - - <<#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query__TypeDBOptions_options_,IQueryManager::Fetch(string, TypeDBOptions)>> - - - -[caption=""] -.Returns -`IEnumerable< JObject >` - -[#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query__TypeDBOptions_options_] -==== Fetch - -[source,csharp] ----- -IEnumerable< JObject > TypeDB.Driver.Api.IQueryManager.Fetch(string query, TypeDBOptions options) ----- - - - -Performs a TypeQL Fetch (Fetch) query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `query` a| The TypeQL Fetch (Fetch) query to be executed a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`IEnumerable< JObject >` - -[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query_] -==== Get - -[source,csharp] ----- -IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Get(string query) ----- - - - -Performs a TypeQL Get (Get) with default options. - - - See also - - - <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query__TypeDBOptions_options_,IQueryManager::Get(string, TypeDBOptions)>> - - - -[caption=""] -.Returns -`IEnumerable< IConceptMap >` - -[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query__TypeDBOptions_options_] -==== Get - -[source,csharp] ----- -IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Get(string query, TypeDBOptions options) ----- - - - -Performs a TypeQL Get (Get) query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `query` a| The TypeQL Get (Get) query to be executed a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`IEnumerable< IConceptMap >` - -[#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query_] -==== GetAggregate - -[source,csharp] ----- -Promise< IValue > TypeDB.Driver.Api.IQueryManager.GetAggregate(string query) ----- - - - -Performs a TypeQL Get Aggregate query with default options. - - - See also - - - <<#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query__TypeDBOptions_options_,IQueryManager::GetAggregate(string, TypeDBOptions)>> - - - -[caption=""] -.Returns -`Promise< IValue >` - -[#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query__TypeDBOptions_options_] -==== GetAggregate - -[source,csharp] ----- -Promise< IValue > TypeDB.Driver.Api.IQueryManager.GetAggregate(string query, TypeDBOptions options) ----- - - - -Performs a TypeQL Get Aggregate query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `query` a| The TypeQL Get Aggregate query to be executed a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`Promise< IValue >` - -[#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query_] -==== GetGroup - -[source,csharp] ----- -IEnumerable< IConceptMapGroup > TypeDB.Driver.Api.IQueryManager.GetGroup(string query) ----- - - - -Performs a TypeQL Get Group query with default options. - - - See also - - - <<#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query__TypeDBOptions_options_,IQueryManager::GetGroup(string, TypeDBOptions)>> - - - -[caption=""] -.Returns -`IEnumerable< IConceptMapGroup >` - -[#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query__TypeDBOptions_options_] -==== GetGroup - -[source,csharp] ----- -IEnumerable< IConceptMapGroup > TypeDB.Driver.Api.IQueryManager.GetGroup(string query, TypeDBOptions options) ----- - - - -Performs a TypeQL Get Group query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `query` a| The TypeQL Get Group query to be executed a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`IEnumerable< IConceptMapGroup >` - -[#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query_] -==== GetGroupAggregate - -[source,csharp] ----- -IEnumerable< IValueGroup > TypeDB.Driver.Api.IQueryManager.GetGroupAggregate(string query) ----- - - - -Performs a TypeQL Get Group Aggregate query with default options. - - - See also - - - <<#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query__TypeDBOptions_options_,IQueryManager::GetGroupAggregate(string, TypeDBOptions)>> - - - -[caption=""] -.Returns -`IEnumerable< IValueGroup >` - -[#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query__TypeDBOptions_options_] -==== GetGroupAggregate - -[source,csharp] ----- -IEnumerable< IValueGroup > TypeDB.Driver.Api.IQueryManager.GetGroupAggregate(string query, TypeDBOptions options) ----- - - - -Performs a TypeQL Get Group Aggregate query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `query` a| The TypeQL Get Group Aggregate query to be executed a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`IEnumerable< IValueGroup >` - -[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query_] -==== Insert - -[source,csharp] ----- -IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Insert(string query) ----- - - - -Performs a TypeQL Insert query with default options. - - - See also - - - <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query__TypeDBOptions_options_,IQueryManager::Insert(string, TypeDBOptions)>> - - - -[caption=""] -.Returns -`IEnumerable< IConceptMap >` - -[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query__TypeDBOptions_options_] -==== Insert - -[source,csharp] ----- -IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Insert(string query, TypeDBOptions options) ----- - - - -Performs a TypeQL Insert query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `query` a| The TypeQL Insert query to be executed a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`IEnumerable< IConceptMap >` - -[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query_] -==== Undefine - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IQueryManager.Undefine(string query) ----- - - - -Performs a TypeQL Undefine query with default options. - - - See also - - - <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query__TypeDBOptions_options_,IQueryManager::Undefine(string, TypeDBOptions)>> - - - -[caption=""] -.Returns -`VoidPromise` - -[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query__TypeDBOptions_options_] -==== Undefine - -[source,csharp] ----- -VoidPromise TypeDB.Driver.Api.IQueryManager.Undefine(string query, TypeDBOptions options) ----- - - - -Performs a TypeQL Undefine query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `query` a| The TypeQL Undefine query to be executed a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`VoidPromise` - -[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query_] -==== Update - -[source,csharp] ----- -IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Update(string query) ----- - - - -Performs a TypeQL Update query with default options. - - - See also - - - <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query__TypeDBOptions_options_,IQueryManager::Update(string, TypeDBOptions)>> - - - -[caption=""] -.Returns -`IEnumerable< IConceptMap >` - -[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query__TypeDBOptions_options_] -==== Update - -[source,csharp] ----- -IEnumerable< IConceptMap > TypeDB.Driver.Api.IQueryManager.Update(string query, TypeDBOptions options) ----- - - - -Performs a TypeQL Update query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `query` a| The TypeQL Update query to be executed a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`IEnumerable< IConceptMap >` - -// end::methods[] - diff --git a/csharp/docs/transaction/TypeDB.Driver.Api.ITypeDBTransaction.adoc b/csharp/docs/transaction/TypeDB.Driver.Api.ITypeDBTransaction.adoc deleted file mode 100644 index 35abef37d7..0000000000 --- a/csharp/docs/transaction/TypeDB.Driver.Api.ITypeDBTransaction.adoc +++ /dev/null @@ -1,102 +0,0 @@ -[#_TypeDB_Driver_Api_ITypeDBTransaction_Interface_Reference] -=== TypeDB.Driver.Api.ITypeDBTransaction Interface Reference - -*Package*: `TypeDB.Driver.Api.ITypeDBTransaction Interface Reference` - -// tag::methods[] -[#_void_TypeDB_Driver_Api_ITypeDBTransaction_Close___] -==== Close - -[source,cs] ----- -void TypeDB.Driver.Api.ITypeDBTransaction.Close() ----- - - - -Closes the transaction. - - -[caption=""] -.Returns -`void` - -[#_void_TypeDB_Driver_Api_ITypeDBTransaction_Commit___] -==== Commit - -[source,cs] ----- -void TypeDB.Driver.Api.ITypeDBTransaction.Commit() ----- - - - -Commits the changes made via this transaction to the TypeDB database. Whether or not the transaction is committed successfully, it gets closed after the commit call. - - -[caption=""] -.Returns -`void` - -[#_bool_TypeDB_Driver_Api_ITypeDBTransaction_IsOpen___] -==== IsOpen - -[source,cs] ----- -bool TypeDB.Driver.Api.ITypeDBTransaction.IsOpen() ----- - - - -Checks whether this transaction is open. - - -[caption=""] -.Returns -`bool` - -[#_void_TypeDB_Driver_Api_ITypeDBTransaction_OnClose___Action__Exception___function_] -==== OnClose - -[source,cs] ----- -void TypeDB.Driver.Api.ITypeDBTransaction.OnClose(Action< Exception > function) ----- - - - -Registers a callback function which will be executed when this transaction is closed. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `function` a| The callback function. a| -|=== - -[caption=""] -.Returns -`void` - -[#_void_TypeDB_Driver_Api_ITypeDBTransaction_Rollback___] -==== Rollback - -[source,cs] ----- -void TypeDB.Driver.Api.ITypeDBTransaction.Rollback() ----- - - - -Rolls back the uncommitted changes made via this transaction. - - -[caption=""] -.Returns -`void` - -// end::methods[] - diff --git a/csharp/docs_structure.bzl b/csharp/docs_structure.bzl index 51103fde49..20a4dcdc8c 100644 --- a/csharp/docs_structure.bzl +++ b/csharp/docs_structure.bzl @@ -20,48 +20,47 @@ # dir_mapping = { - "TypeDB.Driver.Api.ITypeDBTransaction.adoc": "transaction", - "TypeDB.Driver.Api.TransactionType.adoc": "transaction", - "TypeDB.Driver.Api.IQueryManager.adoc": "transaction", - "TypeDB.Driver.Api.IExplanation.adoc": "answer", - "TypeDB.Driver.Api.IConceptMap.Explainable.adoc": "answer", - "TypeDB.Driver.Api.IConceptMap.Explainables.adoc": "answer", - "TypeDB.Driver.Api.IConceptMap.adoc": "answer", - "TypeDB.Driver.Api.IConceptMap.IExplainable.adoc": "answer", - "TypeDB.Driver.Api.IConceptMap.IExplainables.adoc": "answer", - "TypeDB.Driver.Api.IConceptMapGroup.adoc": "answer", - "TypeDB.Driver.Api.IValueGroup.adoc": "answer", - "TypeDB.Driver.Common.Promise__T__.adoc": "answer", - "TypeDB.Driver.Common.VoidPromise.adoc": "answer", - "TypeDB.Driver.TypeDB.adoc": "connection", - "TypeDB.Driver.Api.ITypeDBDriver.adoc": "connection", - "TypeDB.Driver.Api.TypeDBCredential.adoc": "connection", - "TypeDB.Driver.Api.IUserManager.adoc": "connection", - "TypeDB.Driver.Api.IDatabase.IReplica.adoc": "connection", - "TypeDB.Driver.Api.IUser.adoc": "connection", - "TypeDB.Driver.Api.IDatabase.adoc": "connection", - "TypeDB.Driver.Api.IDatabaseManager.adoc": "connection", - "TypeDB.Driver.Api.IRule.adoc": "logic", - "TypeDB.Driver.Api.ILogicManager.adoc": "logic", - "TypeDB.Driver.Api.IValue.Type.adoc": "schema", - "TypeDB.Driver.Api.IRelationType.adoc": "schema", - "TypeDB.Driver.Api.IAttributeType.adoc": "schema", - "TypeDB.Driver.Api.IRoleType.adoc": "schema", - "TypeDB.Driver.Api.IEntityType.adoc": "schema", - "TypeDB.Driver.Api.IThingType.Annotation.adoc": "schema", - "TypeDB.Driver.Api.IThingType.adoc": "schema", - "TypeDB.Driver.Api.IConcept.Transitivity.adoc": "schema", - "TypeDB.Driver.Api.IType.adoc": "schema", - "TypeDB.Driver.Api.Label.adoc": "schema", - "TypeDB.Driver.Api.IConcept.adoc": "concept", - "TypeDB.Driver.Api.IConceptManager.adoc": "concept", - "TypeDB.Driver.Api.IRelation.adoc": "data", - "TypeDB.Driver.Api.IEntity.adoc": "data", - "TypeDB.Driver.Api.IAttribute.adoc": "data", - "TypeDB.Driver.Api.IValue.adoc": "data", - "TypeDB.Driver.Api.IThing.adoc": "data", - "TypeDB.Driver.Api.ITypeDBSession.adoc": "session", - "TypeDB.Driver.Api.SessionType.adoc": "session", - "TypeDB.Driver.Api.TypeDBOptions.adoc": "session", - "TypeDB.Driver.Common.TypeDBDriverException.adoc": "errors", + "ITypeDBTransaction.adoc": "transaction", + "TransactionType.adoc": "transaction", + "IQueryManager.adoc": "transaction", + "IExplanation.adoc": "answer", + "IConceptMap.adoc": "answer", + "IExplainable.adoc": "answer", + "IExplainables.adoc": "answer", + "IConceptMapGroup.adoc": "answer", + "IValueGroup.adoc": "answer", + "Promise__T__.adoc": "answer", + "VoidPromise.adoc": "answer", + "TypeDB.adoc": "connection", + "ITypeDBDriver.adoc": "connection", + "TypeDBCredential.adoc": "connection", + "IUserManager.adoc": "connection", + "IReplica.adoc": "connection", + "IUser.adoc": "connection", + "IDatabase.adoc": "connection", + "IDatabaseManager.adoc": "connection", + "IRule.adoc": "logic", + "ILogicManager.adoc": "logic", + "IValue.Type.adoc": "schema", + "IRelationType.adoc": "schema", + "IAttributeType.adoc": "schema", + "IRoleType.adoc": "schema", + "IEntityType.adoc": "schema", + "Annotation.adoc": "schema", + "IThingType.adoc": "schema", + "IType.adoc": "schema", + "Label.adoc": "schema", + "IConcept.adoc": "concept", + "IConceptManager.adoc": "concept", + "Transitivity.adoc": "concept", + "IRelation.adoc": "data", + "IEntity.adoc": "data", + "IAttribute.adoc": "data", + "IValue.adoc": "data", + "ValueType.adoc": "data", + "IThing.adoc": "data", + "ITypeDBSession.adoc": "session", + "SessionType.adoc": "session", + "TypeDBOptions.adoc": "session", + "TypeDBDriverException.adoc": "errors", } diff --git a/java/api/concept/value/Value.java b/java/api/concept/value/Value.java index 19e67fa0c0..cd08dc200a 100644 --- a/java/api/concept/value/Value.java +++ b/java/api/concept/value/Value.java @@ -176,6 +176,14 @@ default Value asValue() { */ LocalDateTime asDateTime(); + /** + * Used to specify the type of the value. + * + *

Examples

+ * 
+     * thingType.getOwns(transaction, Value.Type.STRING);
+     *
+ */ enum Type { OBJECT(Object.class, false, false, com.vaticle.typedb.driver.jni.ValueType.Object), BOOLEAN(Boolean.class, true, false, com.vaticle.typedb.driver.jni.ValueType.Boolean), diff --git a/java/docs/schema/Value.Type.adoc b/java/docs/schema/Value.Type.adoc index 3fe26eef17..0fe8f94ae8 100644 --- a/java/docs/schema/Value.Type.adoc +++ b/java/docs/schema/Value.Type.adoc @@ -3,6 +3,16 @@ *Package*: `com.vaticle.typedb.driver.api.concept.value` +Used to specify the type of the value. + + +[caption=""] +.Examples +[source,java] +---- +thingType.getOwns(transaction, Value.Type.STRING); +---- + [caption=""] .Enum constants // tag::enum_constants[] From 27de3ff0df7c78944403f54bc3642b5695d939bc Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Fri, 22 Mar 2024 11:53:54 +0000 Subject: [PATCH 031/118] Add enums and fix naming choosing in the parser --- tool/docs/csharp/DoxygenParserCsharp.kt | 169 +++++++++++++++--------- 1 file changed, 104 insertions(+), 65 deletions(-) diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index 4a709eca43..6c3334c138 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -58,6 +58,7 @@ class DoxygenParserCsharp : Callable { @Override override fun call() { val inputDirectoryName = inputDirectoryNames[0] + val htmlDocsDirectoryName = inputDirectoryName + "/html/" val docsDir = System.getenv("BUILD_WORKSPACE_DIRECTORY")?.let { Paths.get(it).resolve(outputDirectoryName) } ?: Paths.get(outputDirectoryName) @@ -66,20 +67,38 @@ class DoxygenParserCsharp : Callable { } val classes: MutableList = ArrayList() - // TODO: Parse enums? + // Enums that are not a part of a class + run { + val namespaceFiles = Files.walk(Paths.get(htmlDocsDirectoryName)) + .filter { Files.isRegularFile(it) } + .filter { it.toString().startsWith(htmlDocsDirectoryName + "namespace_type_d_b_1_1_driver_") } + .forEach { + val html = File(it.toAbsolutePath().toString()).readText(Charsets.UTF_8) + val parsed = Jsoup.parse(html) + + // Enums + val (_, _, parsedEnums) = parseMemberDecls(parsed, true) // enumsOnly + parsedEnums.forEach{ element -> classes.add(element) } + } + + + } // class files File(inputDirectoryName).walkTopDown().filter { - (it.toString().startsWith("csharp/doxygen_docs/html/class_type_") - || it.toString().startsWith("csharp/doxygen_docs/html/interface_type_") - || it.toString().startsWith("csharp/doxygen_docs/html/struct_type_")) + (it.toString().startsWith(htmlDocsDirectoryName + "class_type_") + || it.toString().startsWith(htmlDocsDirectoryName + "interface_type_") + || it.toString().startsWith(htmlDocsDirectoryName + "struct_type_")) && it.toString().endsWith(".html") && !it.toString().contains("-members") }.forEach { val html = File(it.path).readText(Charsets.UTF_8) val parsed = Jsoup.parse(html) - val parsedClass = parseClass(parsed) + + val (parsedClass, additionalParsedClasses) = parseClass(parsed) + if (parsedClass.isNotEmpty()) classes.add(parsedClass) + additionalParsedClasses.forEach{ element -> classes.add(element) } } classes.forEach { parsedClass -> @@ -102,40 +121,44 @@ class DoxygenParserCsharp : Callable { return outputFile } - private fun parseMemberDecls(document: Element): Pair>, Map> { + private fun parseMemberDecls(document: Element, enumsOnly: Boolean = false): Triple>, Map, List> { val missingDeclarations: MutableList = ArrayList() val map: MutableMap> = HashMap() val idToAnchor: MutableMap = HashMap() + val additionalClasses: MutableList = ArrayList() + document.select("table.memberdecls").forEach { table -> val heading: String = table.selectFirst("tr.heading > td > h2 > a")!!.attr("name") println(heading) val members: MutableList = ArrayList() - table.select("tr").filter { element -> - element.className().matches(Regex("memitem:[a-f0-9]+")) - }.forEach { element -> - val id = element.className().substringAfter("memitem:") - val type = element.selectFirst("td.memItemLeft")?.text() - if (type == "enum") { - println("ENUM! $element") + + table.select("tr") + .filter { element -> + element.className().matches(Regex("memitem:[a-f0-9]+")) + }.forEach { element -> + val id = element.className().substringAfter("memitem:") + val type = element.selectFirst("td.memItemLeft")?.text() + val memberDetails = document.selectFirst("div.contents > a#$id")?.nextElementSibling()?.nextElementSibling() - val typeAndName = memberDetails?.selectFirst("div.memitem > div.memproto > table.memname > tbody > tr > td.memname")?.text()?.split(" ") - if (typeAndName != null && typeAndName.size > 1 && typeAndName[0] == "enum") { // ENUM! - println("Details: $memberDetails, typeAndName: ${typeAndName}") + if (memberDetails == null) { + missingDeclarations.add(element.selectFirst("td.memItemRight")!!.text()) + } + else { + if (type == "enum") { + additionalClasses.add(parseEnum(element, memberDetails)) + + } + else if (!enumsOnly) { + println("Not enum....") + members.add(memberDetails) + idToAnchor[id] = replaceSymbolsForAnchor(memberDetails.select("table.memname").text()) + } else { + + } } } - - val memberDetails = - document.selectFirst("div.contents > a#$id")?.nextElementSibling()?.nextElementSibling() - - if (memberDetails == null) { - missingDeclarations.add(element.selectFirst("td.memItemRight")!!.text()) - } else { - members.add(memberDetails) - idToAnchor[id] = replaceSymbolsForAnchor(memberDetails.select("table.memname").text()) - } - } map[heading] = members // print("Result for now: $map") } @@ -144,23 +167,21 @@ class DoxygenParserCsharp : Callable { println("Missing some member declarations:\n\t-" + missingDeclarations.joinToString("\n\t-")) } - return Pair(map, idToAnchor) + return Triple(map, idToAnchor, additionalClasses) } - private fun parseClass(document: Element): Class { + private fun parseClass(document: Element): Pair> { // If we want inherited members, consider doxygen's INLINE_INHERITED_MEMB instead of the javadoc approach - val fullyQualifiedName = document.selectFirst("div .title")!!.text() - .replace(Regex("Class(?: Template)? Reference.*"), "").trim() - val packagePath = fullyQualifiedName.substringBeforeLast("::") - val className = fullyQualifiedName.substringAfterLast("::") -// println(packagePath, className) + val fullyQualifiedName = formatEntityName(document.selectFirst("div .title")!!.text()) + val packagePath = fullyQualifiedName.substringBeforeLast(".") + val className = fullyQualifiedName.substringAfterLast(".") val classAnchor = replaceSymbolsForAnchor(className) val classExamples = document.select("div.textblock > pre").map { replaceSpaces(it.text()) } val superClasses = document.select("tr.inherit_header") .map { it.text().substringAfter("inherited from ") } .toSet().toList() - val (memberDecls, idToAnchor) = parseMemberDecls(document) + val (memberDecls, idToAnchor, additionalClasses) = parseMemberDecls(document) val classDescr: List = document.selectFirst("div.textblock") ?.let { splitToParagraphs(it.html()) }?.map { reformatTextWithCode(it.substringBefore(" { parseMethod(it, idToAnchor) } - return Class( - name = className, - anchor = classAnchor, - description = classDescr, - examples = classExamples, - fields = fields, - methods = methods, - packagePath = packagePath, - superClasses = superClasses, - ) + return Pair( + Class( + name = className, + anchor = classAnchor, + description = classDescr, + examples = classExamples, + fields = fields, + methods = methods, + packagePath = packagePath, + superClasses = superClasses), + additionalClasses) } - private fun parseEnum(element: Element): Class { - val id = element.previousElementSibling()?.previousElementSibling()?.id()!! - val fullyQualifiedName = element.select("td.memname > a").text() - val className = fullyQualifiedName.substringAfterLast("::") + private fun parseEnum(constantsElement: Element, detailsElement: Element): Class { + println("ELEMENT:" + constantsElement + "\nDETAILS: " + detailsElement + "\n") + val typeAndName = detailsElement + ?.selectFirst("div.memitem > div.memproto > table.memname > tbody > tr > td.memname") + ?.text()?.split(" ")!! + assert(typeAndName.size > 1) + + val fullyQualifiedName = typeAndName[1] + val className = fullyQualifiedName.substringAfterLast(".") val classAnchor = replaceSymbolsForAnchor(className) - val classDescr: List = element.selectFirst("div.memdoc") + val packagePath = fullyQualifiedName.substringBeforeLast(".") + + val classDescr: List = detailsElement.selectFirst("div.memdoc") ?.let { splitToParagraphs(it.html()) }?.map { reformatTextWithCode(it.substringBefore(" pre").map { replaceSpaces(it.text()) } - val enumConstants = - element.parents().select("div.contents").first()!! - .select("table.memberdecls > tbody > tr[class=memitem:$id] > td.memItemRight ").first()!! - .text().substringAfter("{").substringBefore("}") - .split(",") - .map { - EnumConstant(it.trim()) - } - val packagePath = fullyQualifiedName.substringBeforeLast("::") +// val classExamples = element.select("div.memdoc > pre").map { replaceSpaces(it.text()) } + + val enumConstantsText = constantsElement + ?.selectFirst("td.memItemRight") + ?.text()!! + val enumConstants = Regex("[A-Za-z]+ = [A-Za-z.]+") + .findAll(enumConstantsText).map{ EnumConstant(it.value.substringBefore(" ")) }.toList() + return Class( name = className, anchor = classAnchor, description = classDescr, enumConstants = enumConstants, - examples = classExamples, +// examples = classExamples, packagePath = packagePath, + + examples = listOf("awklfawlkfl"), ) } @@ -217,7 +246,7 @@ class DoxygenParserCsharp : Callable { val id = element.previousElementSibling()?.previousElementSibling()?.id()!! val methodAnchor = idToAnchor[id] val methodName = element.previousElementSibling()!!.text().substringBefore("()").substringAfter(" ") - val methodSignature = enhanceSignature(element.selectFirst("table.memname")!!.text()) + val methodSignature = updateSignature(element.selectFirst("table.memname")!!.text()) val argsList = getArgsFromSignature(methodSignature) val argsMap = argsList.toMap() val methodReturnType = getReturnTypeFromSignature(methodSignature) @@ -278,11 +307,16 @@ class DoxygenParserCsharp : Callable { return html.replace("
", "[source,java]\n----\n").replace("
", "\n----\n") } - private fun enhanceSignature(signature: String): String { + private fun updateSignature(signature: String): String { var enhanced = replaceSpaces(signature) enhanced = enhanced.replace("( ", "(") enhanced = Regex("\\s([()*&])").replace(enhanced, "$1") - return enhanced + var splitted = enhanced.split(" ").toMutableList() + val methodNameIndex = splitted.indexOfFirst { it.contains('(') } + if (methodNameIndex != -1) { + splitted[methodNameIndex] = splitted[methodNameIndex].substringAfterLast(".") + } + return splitted.joinToString(separator = " ") } private fun getReturnTypeFromSignature(signature: String): String { @@ -307,6 +341,11 @@ class DoxygenParserCsharp : Callable { } private fun generateFilename(className: String): String { - return className.replace("[<> ,]".toRegex(), "_").replace("_Interface_Reference", "") + return className.replace("[<> ,]".toRegex(), "_") + } + + private fun formatEntityName(entityName: String): String { + return entityName.replace(Regex("(Class|Interface|Struct)(?: Template)? Reference.*"), "").trim() + } } From 3e51a974e5cee9a964775fc80be576bf550f19bf Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Fri, 22 Mar 2024 12:09:20 +0000 Subject: [PATCH 032/118] Add code examples for method for the cpp driver --- cpp/docs/answer/ConceptMap.adoc | 35 +++++ cpp/docs/answer/ConceptMapGroup.adoc | 14 ++ cpp/docs/answer/Explainable.adoc | 14 ++ cpp/docs/answer/Explainables.adoc | 42 ++++++ cpp/docs/answer/Explanation.adoc | 35 +++++ cpp/docs/answer/ValueGroup.adoc | 14 ++ cpp/docs/concept/Concept.adoc | 147 ++++++++++++++++++ cpp/docs/concept/ConceptManager.adoc | 91 ++++++++++++ cpp/docs/connection/Database.adoc | 49 ++++++ cpp/docs/connection/DatabaseManager.adoc | 28 ++++ cpp/docs/connection/Driver.adoc | 49 ++++++ cpp/docs/connection/UserManager.adoc | 42 ++++++ cpp/docs/data/Attribute.adoc | 28 ++++ cpp/docs/data/Entity.adoc | 7 + cpp/docs/data/Relation.adoc | 42 ++++++ cpp/docs/data/Thing.adoc | 79 ++++++++++ cpp/docs/data/Value.adoc | 126 ++++++++++++++++ cpp/docs/errors/DriverException.adoc | 21 +++ cpp/docs/logic/LogicManager.adoc | 21 +++ cpp/docs/logic/Rule.adoc | 21 +++ cpp/docs/schema/Annotation.adoc | 28 ++++ cpp/docs/schema/AttributeType.adoc | 182 +++++++++++++++++++++++ cpp/docs/schema/EntityType.adoc | 28 ++++ cpp/docs/schema/RelationType.adoc | 71 +++++++++ cpp/docs/schema/RoleType.adoc | 112 ++++++++++++++ cpp/docs/schema/ThingType.adoc | 145 ++++++++++++++++++ cpp/docs/schema/Type.adoc | 57 +++++++ cpp/docs/session/Options.adoc | 147 ++++++++++++++++++ cpp/docs/session/Session.adoc | 42 ++++++ cpp/docs/transaction/QueryManager.adoc | 77 ++++++++++ cpp/docs/transaction/Transaction.adoc | 42 ++++++ 31 files changed, 1836 insertions(+) diff --git a/cpp/docs/answer/ConceptMap.adoc b/cpp/docs/answer/ConceptMap.adoc index bac2571876..daebadf316 100644 --- a/cpp/docs/answer/ConceptMap.adoc +++ b/cpp/docs/answer/ConceptMap.adoc @@ -25,6 +25,13 @@ Produces an ``Iterator`` over all concepts in this ``ConceptMap``. .Returns `ConceptIterable< Concept >` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.concepts(); +---- + [#_Explainables_TypeDBConceptMapexplainables___] ==== explainables @@ -42,6 +49,13 @@ Gets the ``Explainables`` object for this ``ConceptMap``, exposing which of the .Returns `Explainables` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables(); +---- + [#_stdunique_ptr__Concept___TypeDBConceptMapget___const_stdstring__variableName_] ==== get @@ -68,6 +82,13 @@ a| `variable` a| The string representation of a variable a| .Returns `std::unique_ptr< Concept >` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.get(variable); +---- + [#_stdmap__stdstring__stdunique_ptr__Concept_____TypeDBConceptMapmap___] ==== map @@ -85,6 +106,13 @@ Returns the inner ``Map`` where keys are query variables, and values are concept .Returns `std::map< std::string, std::unique_ptr< Concept > >` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.map(); +---- + [#_stdstring_TypeDBConceptMaptoString___] ==== toString @@ -118,5 +146,12 @@ Produces an ``Iterator`` stream over all variables in this ``ConceptMap``. .Returns `StringIterable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.variables(); +---- + // end::methods[] diff --git a/cpp/docs/answer/ConceptMapGroup.adoc b/cpp/docs/answer/ConceptMapGroup.adoc index 390ff214d6..e440dda03a 100644 --- a/cpp/docs/answer/ConceptMapGroup.adoc +++ b/cpp/docs/answer/ConceptMapGroup.adoc @@ -25,6 +25,13 @@ Retrieves the ``ConceptMap``s of the group. .Returns `ConceptMapIterable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMapGroup.conceptMaps(); +---- + [#_stdunique_ptr__Concept___TypeDBConceptMapGroupowner___] ==== owner @@ -42,6 +49,13 @@ Retrieves the concept that is the group owner. .Returns `std::unique_ptr< Concept >` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMapGroup.owner(); +---- + [#_stdstring_TypeDBConceptMapGrouptoString___] ==== toString diff --git a/cpp/docs/answer/Explainable.adoc b/cpp/docs/answer/Explainable.adoc index 75c94347df..e41c187473 100644 --- a/cpp/docs/answer/Explainable.adoc +++ b/cpp/docs/answer/Explainable.adoc @@ -25,6 +25,13 @@ Retrieves the subquery of the original query that is actually being explained. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +explainable.conjunction(); +---- + [#_int64_t_TypeDBExplainableexplainableId___] ==== explainableId @@ -42,5 +49,12 @@ Retrieves the unique ID that identifies this ``Explainable``. .Returns `int64_t` +[caption=""] +.Code examples +[source,cpp] +---- +explainable.id(); +---- + // end::methods[] diff --git a/cpp/docs/answer/Explainables.adoc b/cpp/docs/answer/Explainables.adoc index ecb9f10e72..cfeb76e943 100644 --- a/cpp/docs/answer/Explainables.adoc +++ b/cpp/docs/answer/Explainables.adoc @@ -34,6 +34,13 @@ a| `variable` a| The string representation of a variable a| .Returns `Explainable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().attribute(variable); +---- + [#_StringIterable_TypeDBExplainablesattributes___] ==== attributes @@ -51,6 +58,13 @@ Retrieves all of this ``ConceptMap``’s explainable attributes. .Returns `StringIterable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().attributes(); +---- + [#_Explainable_TypeDBExplainablesownership___stdstring__owner__stdstring__attribute_] ==== ownership @@ -78,6 +92,13 @@ a| `attribute` a| The string representation of the attribute variable a| .Returns `Explainable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().ownership(owner, attribute); +---- + [#_OwnerAttributePairIterable_TypeDBExplainablesownerships___] ==== ownerships @@ -95,6 +116,13 @@ Retrieves all of this ``ConceptMap``’s explainable ownerships. .Returns `OwnerAttributePairIterable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().ownerships(); +---- + [#_Explainable_TypeDBExplainablesrelation___stdstring__variable_] ==== relation @@ -121,6 +149,13 @@ a| `variable` a| The string representation of a variable a| .Returns `Explainable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().relation(variable); +---- + [#_StringIterable_TypeDBExplainablesrelations___] ==== relations @@ -138,6 +173,13 @@ Retrieves all of this ``ConceptMap``’s explainable relations. .Returns `StringIterable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().relations(); +---- + [#_stdstring_TypeDBExplainablestoString___] ==== toString diff --git a/cpp/docs/answer/Explanation.adoc b/cpp/docs/answer/Explanation.adoc index 30a0b61580..1003b40107 100644 --- a/cpp/docs/answer/Explanation.adoc +++ b/cpp/docs/answer/Explanation.adoc @@ -27,6 +27,13 @@ Retrieves the Conclusion for this Explanation. .Returns `ConceptMap` +[caption=""] +.Code examples +[source,cpp] +---- +explanation.conclusion() +---- + [#_ConceptMap_TypeDBExplanationcondition___] ==== condition @@ -44,6 +51,13 @@ Retrieves the Condition for this Explanation. .Returns `ConceptMap` +[caption=""] +.Code examples +[source,cpp] +---- +explanation.condition() +---- + [#_stdvector__stdstring___TypeDBExplanationqueryVariableMapping___const_stdstring__var_] ==== queryVariableMapping @@ -70,6 +84,13 @@ a| `var` a| The query variable to map to rule variables. a| .Returns `std::vector< std::string >` +[caption=""] +.Code examples +[source,cpp] +---- +explanation.variableMapping(var) +---- + [#_stdvector__stdstring___TypeDBExplanationqueryVariables___] ==== queryVariables @@ -87,6 +108,13 @@ Retrieves the query variables for this ``Explanation``. .Returns `std::vector< std::string >` +[caption=""] +.Code examples +[source,cpp] +---- +explanation.queryVariables() +---- + [#_Rule_TypeDBExplanationrule___] ==== rule @@ -104,6 +132,13 @@ Retrieves the Rule for this Explanation. .Returns `Rule` +[caption=""] +.Code examples +[source,cpp] +---- +explanation.rule() +---- + [#_stdstring_TypeDBExplanationtoString___] ==== toString diff --git a/cpp/docs/answer/ValueGroup.adoc b/cpp/docs/answer/ValueGroup.adoc index bb89e98cf5..bd8829b44f 100644 --- a/cpp/docs/answer/ValueGroup.adoc +++ b/cpp/docs/answer/ValueGroup.adoc @@ -25,6 +25,13 @@ Retrieves the concept that is the group owner. .Returns `std::unique_ptr< Concept >` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMapGroup.owner() +---- + [#_stdstring_TypeDBValueGrouptoString___] ==== toString @@ -58,5 +65,12 @@ Retrieves the ``Value`` answer of the group. .Returns `AggregateResult` +[caption=""] +.Code examples +[source,cpp] +---- +valueGroup.value(); +---- + // end::methods[] diff --git a/cpp/docs/concept/Concept.adoc b/cpp/docs/concept/Concept.adoc index f6c5db56ae..f6454c7925 100644 --- a/cpp/docs/concept/Concept.adoc +++ b/cpp/docs/concept/Concept.adoc @@ -25,6 +25,13 @@ Casts the concept to ``Attribute``. .Returns `Attribute*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asAttribute(); +---- + [#_AttributeType__ptr__TypeDBConceptasAttributeType___] ==== asAttributeType @@ -42,6 +49,13 @@ Casts the concept to ``EntityType``. .Returns `AttributeType*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asEntityType(); +---- + [#_Entity__ptr__TypeDBConceptasEntity___] ==== asEntity @@ -59,6 +73,13 @@ Casts the concept to ``Entity``. .Returns `Entity*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asEntity(); +---- + [#_EntityType__ptr__TypeDBConceptasEntityType___] ==== asEntityType @@ -76,6 +97,13 @@ Casts the concept to ``EntityType``. .Returns `EntityType*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asEntityType(); +---- + [#_Relation__ptr__TypeDBConceptasRelation___] ==== asRelation @@ -93,6 +121,13 @@ Casts the concept to ``Relation``. .Returns `Relation*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asRelation(); +---- + [#_RelationType__ptr__TypeDBConceptasRelationType___] ==== asRelationType @@ -110,6 +145,13 @@ Casts the concept to ``RelationType``. .Returns `RelationType*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asRelationType(); +---- + [#_RoleType__ptr__TypeDBConceptasRoleType___] ==== asRoleType @@ -127,6 +169,13 @@ Casts the concept to ``RoleType``. .Returns `RoleType*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asRoleType(); +---- + [#_Thing__ptr__TypeDBConceptasThing___] ==== asThing @@ -144,6 +193,13 @@ Casts the concept to ``Thing``. .Returns `Thing*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asThing(); +---- + [#_ThingType__ptr__TypeDBConceptasThingType___] ==== asThingType @@ -161,6 +217,13 @@ Casts the concept to ``ThingType``. .Returns `ThingType*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asThingType(); +---- + [#_Value__ptr__TypeDBConceptasValue___] ==== asValue @@ -178,6 +241,13 @@ Casts the concept to ``Value``. .Returns `Value*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asValue(); +---- + [#_static_bool_TypeDBConceptequals___Concept__ptr__first__Concept__ptr__second_] ==== equals @@ -211,6 +281,13 @@ Returns the ConceptType of this concept. .Returns `ConceptType` +[caption=""] +.Code examples +[source,cpp] +---- +switch(concept.getConceptType()) { ... } +---- + [#_bool_TypeDBConceptisAttribute___] ==== isAttribute @@ -228,6 +305,13 @@ Checks if the concept is a ``Relation``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isRelation(); +---- + [#_bool_TypeDBConceptisAttributeType___] ==== isAttributeType @@ -245,6 +329,13 @@ Checks if the concept is an ``AttributeType``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isAttributeType(); +---- + [#_bool_TypeDBConceptisEntity___] ==== isEntity @@ -262,6 +353,13 @@ Checks if the concept is an ``Entity``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isEntity(); +---- + [#_bool_TypeDBConceptisEntityType___] ==== isEntityType @@ -279,6 +377,13 @@ Checks if the concept is an ``EntityType``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isEntityType(); +---- + [#_bool_TypeDBConceptisRelation___] ==== isRelation @@ -296,6 +401,13 @@ Checks if the concept is a ``Value``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isValue(); +---- + [#_bool_TypeDBConceptisRelationType___] ==== isRelationType @@ -313,6 +425,13 @@ Checks if the concept is a ``RelationType``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isRelationType(); +---- + [#_bool_TypeDBConceptisRoleType___] ==== isRoleType @@ -330,6 +449,13 @@ Checks if the concept is a ``RoleType``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isRoleType(); +---- + [#_bool_TypeDBConceptisThing___] ==== isThing @@ -347,6 +473,13 @@ Checks if the concept is a ``Thing``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isThing(); +---- + [#_bool_TypeDBConceptisThingType___] ==== isThingType @@ -364,6 +497,13 @@ Checks if the concept is a ``ThingType``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isThingType(); +---- + [#_bool_TypeDBConceptisValue___] ==== isValue @@ -381,6 +521,13 @@ Checks if the concept is a ``Value``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isValue(); +---- + [#_bool_TypeDBConceptoperator___const_Concept__other_] ==== operator== diff --git a/cpp/docs/concept/ConceptManager.adoc b/cpp/docs/concept/ConceptManager.adoc index 4bb32d0d6e..a376e97b5c 100644 --- a/cpp/docs/concept/ConceptManager.adoc +++ b/cpp/docs/concept/ConceptManager.adoc @@ -34,6 +34,13 @@ a| `iid` a| The iid of the ``Attribute`` to retrieve a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getAttribute(iid).get(); +---- + [#_ConceptPtrFuture__AttributeType___TypeDBConceptManagergetAttributeType___const_stdstring__label___const] ==== getAttributeType @@ -60,6 +67,13 @@ a| `label` a| The label of the ``AttributeType`` to retrieve a| .Returns `ConceptPtrFuture< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getAttributeType(label).get(); +---- + [#_ConceptPtrFuture__Entity___TypeDBConceptManagergetEntity___const_stdstring__iid___const] ==== getEntity @@ -86,6 +100,13 @@ a| `iid` a| The iid of the ``Entity`` to retrieve a| .Returns `ConceptPtrFuture< Entity >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getEntity(iid).get(); +---- + [#_ConceptPtrFuture__EntityType___TypeDBConceptManagergetEntityType___const_stdstring__label___const] ==== getEntityType @@ -112,6 +133,13 @@ a| `label` a| The label of the ``EntityType`` to retrieve a| .Returns `ConceptPtrFuture< EntityType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getEntityType(label).get(); +---- + [#_ConceptPtrFuture__Relation___TypeDBConceptManagergetRelation___const_stdstring__iid___const] ==== getRelation @@ -138,6 +166,13 @@ a| `iid` a| The iid of the ``Relation`` to retrieve a| .Returns `ConceptPtrFuture< Relation >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getRelation(iid).get(); +---- + [#_ConceptPtrFuture__RelationType___TypeDBConceptManagergetRelationType___const_stdstring__label___const] ==== getRelationType @@ -164,6 +199,13 @@ a| `label` a| The label of the ``RelationType`` to retrieve a| .Returns `ConceptPtrFuture< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getRelationType(label).get(); +---- + [#_stdunique_ptr__AttributeType___TypeDBConceptManagergetRootAttributeType_____const] ==== getRootAttributeType @@ -181,6 +223,13 @@ Retrieve the root ``AttributeType``, “attribute”. .Returns `std::unique_ptr< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getRootAttributeType(); +---- + [#_stdunique_ptr__EntityType___TypeDBConceptManagergetRootEntityType_____const] ==== getRootEntityType @@ -198,6 +247,13 @@ Retrieves the root ``EntityType``, “entity”. .Returns `std::unique_ptr< EntityType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getRootEntityType(); +---- + [#_stdunique_ptr__RelationType___TypeDBConceptManagergetRootRelationType_____const] ==== getRootRelationType @@ -215,6 +271,13 @@ Retrieve the root ``RelationType``, “relation”. .Returns `std::unique_ptr< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getRootRelationType(); +---- + [#_stdvector__DriverException___TypeDBConceptManagergetSchemaExceptions___] ==== getSchemaExceptions @@ -232,6 +295,13 @@ Retrieves a list of all schema exceptions for the current transaction. .Returns `std::vector< DriverException >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getSchemaExceptions(); +---- + [#_ConceptPtrFuture__AttributeType___TypeDBConceptManagerputAttributeType___const_stdstring__label__ValueType_valueType___const] ==== putAttributeType @@ -259,6 +329,13 @@ a| `valueType` a| The value type of the ``AttributeType`` to create a| .Returns `ConceptPtrFuture< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.putAttributeType(label, valueType).get(); +---- + [#_ConceptPtrFuture__EntityType___TypeDBConceptManagerputEntityType___const_stdstring__label___const] ==== putEntityType @@ -285,6 +362,13 @@ a| `label` a| The label of the ``EntityType`` to create or retrieve a| .Returns `ConceptPtrFuture< EntityType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.putEntityType(label).get(); +---- + [#_ConceptPtrFuture__RelationType___TypeDBConceptManagerputRelationType___const_stdstring__label___const] ==== putRelationType @@ -311,5 +395,12 @@ a| `label` a| The label of the ``RelationType`` to create or retrieve a| .Returns `ConceptPtrFuture< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.putRelationType(label).get(); +---- + // end::methods[] diff --git a/cpp/docs/connection/Database.adoc b/cpp/docs/connection/Database.adoc index ddb28aef28..d3f25e90b7 100644 --- a/cpp/docs/connection/Database.adoc +++ b/cpp/docs/connection/Database.adoc @@ -25,6 +25,13 @@ Deletes this database. .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +database.deleteDatabase() +---- + [#_stdstring_TypeDBDatabasename_____const] ==== name @@ -58,6 +65,13 @@ Returns the preferred replica for this database. Operations which can be run on .Returns `std::optional< ReplicaInfo >` +[caption=""] +.Code examples +[source,cpp] +---- +database.preferredReplica() +---- + [#_stdoptional__ReplicaInfo___TypeDBDatabaseprimaryReplica___] ==== primaryReplica @@ -75,6 +89,13 @@ Returns the primary replica for this database. _Only works in TypeDB Cloud_ .Returns `std::optional< ReplicaInfo >` +[caption=""] +.Code examples +[source,cpp] +---- +database.primaryReplica() +---- + [#_ReplicaInfoIterable_TypeDBDatabasereplicas___] ==== replicas @@ -92,6 +113,13 @@ Set of ``Replica`` instances for this database. Only works in TypeDB Cloud .Returns `ReplicaInfoIterable` +[caption=""] +.Code examples +[source,cpp] +---- +database.replicas() +---- + [#_stdstring_TypeDBDatabaseruleSchema___] ==== ruleSchema @@ -109,6 +137,13 @@ The rules in the schema as a valid TypeQL define query string. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +database.ruleSchema() +---- + [#_stdstring_TypeDBDatabaseschema___] ==== schema @@ -126,6 +161,13 @@ A full schema text as a valid TypeQL define query string. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +database.schema() +---- + [#_stdstring_TypeDBDatabasetypeSchema___] ==== typeSchema @@ -143,5 +185,12 @@ The types in the schema as a valid TypeQL define query string. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +database.typeSchema() +---- + // end::methods[] diff --git a/cpp/docs/connection/DatabaseManager.adoc b/cpp/docs/connection/DatabaseManager.adoc index 5636f8492a..3c62c72245 100644 --- a/cpp/docs/connection/DatabaseManager.adoc +++ b/cpp/docs/connection/DatabaseManager.adoc @@ -25,6 +25,13 @@ Retrieves all databases present on the TypeDB server .Returns `DatabaseIterable` +[caption=""] +.Code examples +[source,cpp] +---- +driver.databases.all() +---- + [#_bool_TypeDBDatabaseManagercontains___const_stdstring____const] ==== contains @@ -51,6 +58,13 @@ a| `name` a| The database name to be checked a| .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +driver.databases.contains(name) +---- + [#_void_TypeDBDatabaseManagercreate___const_stdstring____const] ==== create @@ -77,6 +91,13 @@ a| `name` a| The name of the database to be created a| .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +driver.databases.create(name) +---- + [#_Database_TypeDBDatabaseManagerget___const_stdstring____const] ==== get @@ -103,5 +124,12 @@ a| `name` a| The name of the database to retrieve a| .Returns `Database` +[caption=""] +.Code examples +[source,cpp] +---- +driver.databases.get(name) +---- + // end::methods[] diff --git a/cpp/docs/connection/Driver.adoc b/cpp/docs/connection/Driver.adoc index dd176a833c..5ba2e9e778 100644 --- a/cpp/docs/connection/Driver.adoc +++ b/cpp/docs/connection/Driver.adoc @@ -37,6 +37,13 @@ Closes the driver. Before instantiating a new driver, the driver that’s curren .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +driver.close() +---- + [#_static_Driver_TypeDBDrivercloudDriver___const_stdvector__stdstring____cloudAddresses__const_Credential__credential_] ==== cloudDriver @@ -64,6 +71,13 @@ a| `credential` a| The Credential to connect with a| .Returns `static Driver` +[caption=""] +.Code examples +[source,cpp] +---- +Driver::cloudDriver(addresses, credential); +---- + [#_static_Driver_TypeDBDrivercoreDriver___const_stdstring__coreAddress_] ==== coreDriver @@ -90,6 +104,13 @@ a| `address` a| The address of the TypeDB server a| .Returns `static Driver` +[caption=""] +.Code examples +[source,cpp] +---- +Driver::coreDriver(address); +---- + [#_static_void_TypeDBDriverinitLogging___] ==== initLogging @@ -107,6 +128,13 @@ Enables logging in the TypeDB driver. .Returns `static void` +[caption=""] +.Code examples +[source,cpp] +---- +Driver::initLogging(); +---- + [#_bool_TypeDBDriverisOpen___] ==== isOpen @@ -124,6 +152,13 @@ Checks whether this connection is presently open. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +driver.isOpen(); +---- + [#_Session_TypeDBDriversession___const_stdstring__database__SessionType_sessionType__const_Options__options__Options___] ==== session @@ -152,6 +187,13 @@ a| `options` a| ``TypeDBOptions`` for the session a| .Returns `Session` +[caption=""] +.Code examples +[source,cpp] +---- +driver.session(database, sessionType, options); +---- + [#_User_TypeDBDriveruser___] ==== user @@ -169,5 +211,12 @@ Returns the logged-in user for the connection. Only for TypeDB Cloud. .Returns `User` +[caption=""] +.Code examples +[source,cpp] +---- +driver.user(); +---- + // end::methods[] diff --git a/cpp/docs/connection/UserManager.adoc b/cpp/docs/connection/UserManager.adoc index b839c75255..9fae0e8d56 100644 --- a/cpp/docs/connection/UserManager.adoc +++ b/cpp/docs/connection/UserManager.adoc @@ -25,6 +25,13 @@ Retrieves all users which exist on the TypeDB server. .Returns `UserIterable` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.all(); +---- + [#_bool_TypeDBUserManagercontains___const_stdstring__username___const] ==== contains @@ -51,6 +58,13 @@ a| `username` a| The user name to be checked a| .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.contains(username); +---- + [#_void_TypeDBUserManagercreate___const_stdstring__username__const_stdstring__password___const] ==== create @@ -78,6 +92,13 @@ a| `password` a| The password of the user to be created a| .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.create(username, password); +---- + [#_void_TypeDBUserManagerdeleteUser___const_stdstring__username___const] ==== deleteUser @@ -104,6 +125,13 @@ a| `username` a| The name of the user to be deleted a| .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.deleteUser(username); +---- + [#_stdunique_ptr__User___TypeDBUserManagerget___const_stdstring__username___const] ==== get @@ -130,6 +158,13 @@ a| `username` a| The name of the user to retrieve a| .Returns `std::unique_ptr< User >` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.get(username); +---- + [#_void_TypeDBUserManagerpasswordSet___const_stdstring__username__const_stdstring__password___const] ==== passwordSet @@ -157,5 +192,12 @@ a| `password` a| The new password a| .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.passwordSet(username, password); +---- + // end::methods[] diff --git a/cpp/docs/data/Attribute.adoc b/cpp/docs/data/Attribute.adoc index edc7e00703..c3fb746c61 100644 --- a/cpp/docs/data/Attribute.adoc +++ b/cpp/docs/data/Attribute.adoc @@ -41,6 +41,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptIterable< Thing >` +[caption=""] +.Code examples +[source,cpp] +---- +attribute.getOwners(transaction); +---- + [#_ConceptIterable__Thing___TypeDBAttributegetOwners___Transaction__transaction__const_ThingType__ptr__ownerType_] ==== getOwners @@ -68,6 +75,13 @@ a| `ownerType` a| Filter results for only owners of the given type a| .Returns `ConceptIterable< Thing >` +[caption=""] +.Code examples +[source,cpp] +---- +attribute.getOwners(transaction, ownerType); +---- + [#_stdunique_ptr__AttributeType___TypeDBAttributegetType___] ==== getType @@ -85,6 +99,13 @@ Retrieves the type which this ``Attribute`` belongs to. .Returns `std::unique_ptr< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +attribute.getType(); +---- + [#_stdunique_ptr__Value___TypeDBAttributegetValue___] ==== getValue @@ -102,5 +123,12 @@ Retrieves the value which the ``Attribute`` instance holds. .Returns `std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +attribute.getValue(); +---- + // end::methods[] diff --git a/cpp/docs/data/Entity.adoc b/cpp/docs/data/Entity.adoc index 7292eb9420..e70b11a7de 100644 --- a/cpp/docs/data/Entity.adoc +++ b/cpp/docs/data/Entity.adoc @@ -32,5 +32,12 @@ Retrieves the type which this ``Entity`` belongs to. .Returns `std::unique_ptr< EntityType >` +[caption=""] +.Code examples +[source,cpp] +---- +entity.getType(); +---- + // end::methods[] diff --git a/cpp/docs/data/Relation.adoc b/cpp/docs/data/Relation.adoc index f8de6615ea..94d45c7c9b 100644 --- a/cpp/docs/data/Relation.adoc +++ b/cpp/docs/data/Relation.adoc @@ -43,6 +43,13 @@ a| `player` a| The thing to play the role a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +relation.addPlayer(transaction, roleType, player).get(); +---- + [#_stdmap__stdunique_ptr__RoleType____stdunique_ptr__Thing_____TypeDBRelationgetPlayers___Transaction__transaction_] ==== getPlayers @@ -69,6 +76,13 @@ a| `transaction` a| The current transaction a| .Returns `std::map< std::unique_ptr< RoleType >, std::unique_ptr< Thing > >` +[caption=""] +.Code examples +[source,cpp] +---- +relation.getPlayers(transaction) +---- + [#_ConceptIterable__Thing___TypeDBRelationgetPlayersByRoleType___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes_] ==== getPlayersByRoleType @@ -96,6 +110,13 @@ a| `roleTypes` a| 0 or more role types a| .Returns `ConceptIterable< Thing >` +[caption=""] +.Code examples +[source,cpp] +---- +relation.getPlayersByRoleType(transaction, roleTypes); +---- + [#_ConceptIterable__Thing___TypeDBRelationgetPlayersByRoleType___Transaction__transaction__const_stdvector__RoleType__ptr_____roleTypes_] ==== getPlayersByRoleType @@ -138,6 +159,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +relation.getRelating(transaction); +---- + [#_stdunique_ptr__RelationType___TypeDBRelationgetType___] ==== getType @@ -155,6 +183,13 @@ Retrieves the type which this ``Relation`` belongs to. .Returns `std::unique_ptr< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +relation.getType(); +---- + [#_VoidFuture_TypeDBRelationremovePlayer___Transaction__transaction__RoleType__ptr__roleType__Thing__ptr__player_] ==== removePlayer @@ -183,5 +218,12 @@ a| `player` a| The instance to no longer play the role in this ``Relation`` a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +relation.removePlayer(transaction, roleType, player).get(); +---- + // end::methods[] diff --git a/cpp/docs/data/Thing.adoc b/cpp/docs/data/Thing.adoc index 1b62d5bc62..6dae765dd9 100644 --- a/cpp/docs/data/Thing.adoc +++ b/cpp/docs/data/Thing.adoc @@ -38,6 +38,13 @@ a| `transaction` a| The current transaction a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thing.deleteThing(transaction).get(); +---- + [#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdinitializer_list__Annotation____annotations___] ==== getHas @@ -65,6 +72,14 @@ a| `annotations` a| Only retrieve attributes with all given ``Annotation``s a| .Returns `ConceptIterable< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getHas(transaction); +thing.getHas(transaction, {Annotation.key()})); +---- + [#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_AttributeType__ptr__attribute_] ==== getHas @@ -108,6 +123,13 @@ a| `attributeTypes` a| The ``AttributeType``s to filter the attributes by a| .Returns `ConceptIterable< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getHas(transaction, attributeTypes); +---- + [#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__const_AttributeType__ptr_____attributeTypes_] ==== getHas @@ -157,6 +179,13 @@ Retrieves the unique id of the ``Thing``. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getIID(); +---- + [#_ConceptIterable__RoleType___TypeDBThinggetPlaying___Transaction__transaction_] ==== getPlaying @@ -183,6 +212,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getPlaying(transaction); +---- + [#_ConceptIterable__Relation___TypeDBThinggetRelations___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes___] ==== getRelations @@ -210,6 +246,14 @@ a| `roleTypes` a| The array of roles to filter the relations by. a| .Returns `ConceptIterable< Relation >` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getRelations(transaction); +thing.getRelations(transaction, roleTypes); +---- + [#_ConceptIterable__Relation___TypeDBThinggetRelations___Transaction__transaction__const_stdvector__RoleType__ptr_____roleTypes_] ==== getRelations @@ -243,6 +287,13 @@ Retrieves the type which this ``Thing`` belongs to. .Returns `std::unique_ptr< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getType(); +---- + [#_BoolFuture_TypeDBThingisDeleted___Transaction__transaction_] ==== isDeleted @@ -269,6 +320,13 @@ a| `transaction` a| The current transaction a| .Returns `BoolFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thing.isDeleted(transaction).get(); +---- + [#_bool_TypeDBThingisInferred___] ==== isInferred @@ -286,6 +344,13 @@ Checks if this ``Thing`` is inferred by a [Reasoning Rule]. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +thing.isInferred(); +---- + [#_VoidFuture_TypeDBThingsetHas___Transaction__transaction__Attribute__ptr__attribute_] ==== setHas @@ -313,6 +378,13 @@ a| `attribute` a| The ``Attribute`` to be owned by this ``Thing``. a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thing.setHas(transaction, attribute).get(); +---- + [#_VoidFuture_TypeDBThingunsetHas___Transaction__transaction__Attribute__ptr__attribute_] ==== unsetHas @@ -340,5 +412,12 @@ a| `attribute` a| The ``Attribute`` to be disowned from this ``Thing``. a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thing.unsetHas(transaction, attribute).get(); +---- + // end::methods[] diff --git a/cpp/docs/data/Value.adoc b/cpp/docs/data/Value.adoc index 45bc424bc3..42dd6ff7ac 100644 --- a/cpp/docs/data/Value.adoc +++ b/cpp/docs/data/Value.adoc @@ -29,6 +29,13 @@ Returns a ``boolean`` value of this value concept. If the value has another type .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.asBoolean(); +---- + [#_DateTime_TypeDBValueasDateTime___] ==== asDateTime @@ -46,6 +53,13 @@ Returns a ``DateTime`` value of this value concept. If the value has another typ .Returns `DateTime` +[caption=""] +.Code examples +[source,cpp] +---- +value.asDatetime(); +---- + [#_double_TypeDBValueasDouble___] ==== asDouble @@ -63,6 +77,13 @@ Returns a ``double`` value of this value concept. If the value has another type, .Returns `double` +[caption=""] +.Code examples +[source,cpp] +---- +value.asDouble(); +---- + [#_int64_t_TypeDBValueasLong___] ==== asLong @@ -80,6 +101,13 @@ Returns a ``long`` value of this value concept. If the value has another type, r .Returns `int64_t` +[caption=""] +.Code examples +[source,cpp] +---- +value.asLong(); +---- + [#_stdstring_TypeDBValueasString___] ==== asString @@ -97,6 +125,13 @@ Returns a ``string`` value of this value concept. If the value has another type, .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +value.asString(); +---- + [#_static_stdstring_TypeDBValueformatDateTime___DateTime_t_] ==== formatDateTime @@ -114,6 +149,13 @@ Returns a string in the TypeQL DateTime format corresponding to the specified Da .Returns `static std::string` +[caption=""] +.Code examples +[source,cpp] +---- +Value::formatDateTime(datetime); +---- + [#_bool_TypeDBValueisBoolean___] ==== isBoolean @@ -131,6 +173,13 @@ Returns ``true`` if the value which this value concept holds is of type ``boolea .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.isBoolean() +---- + [#_bool_TypeDBValueisDateTime___] ==== isDateTime @@ -148,6 +197,13 @@ Returns ``True`` if the value which this value concept holds is of type ``DateTi .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.isDatetime(); +---- + [#_bool_TypeDBValueisDouble___] ==== isDouble @@ -165,6 +221,13 @@ Returns ``true`` if the value which this value concept holds is of type ``double .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.isDouble(); +---- + [#_bool_TypeDBValueisLong___] ==== isLong @@ -182,6 +245,13 @@ Returns ``true`` if the value which this value concept holds is of type ``long`` .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.isLong() +---- + [#_bool_TypeDBValueisString___] ==== isString @@ -199,6 +269,13 @@ Returns ``true`` if the value which this value concept holds is of type ``string .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.isString(); +---- + [#_static_stdunique_ptr__Value___TypeDBValueof___bool_value_] ==== of @@ -216,6 +293,13 @@ Creates a new Value object of the specified boolean value. .Returns `static std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +Value::of(value); +---- + [#_static_stdunique_ptr__Value___TypeDBValueof___int64_t_value_] ==== of @@ -233,6 +317,13 @@ Creates a new Value object of the specified long value. .Returns `static std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +Value::of(value); +---- + [#_static_stdunique_ptr__Value___TypeDBValueof___double_value_] ==== of @@ -250,6 +341,13 @@ Creates a new Value object of the specified double value. .Returns `static std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +Value::of(value); +---- + [#_static_stdunique_ptr__Value___TypeDBValueof___const_stdstring__value_] ==== of @@ -267,6 +365,13 @@ Creates a new Value object of the specified string value. .Returns `static std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +Value::of(value); +---- + [#_static_stdunique_ptr__Value___TypeDBValueof___DateTime_value_] ==== of @@ -284,6 +389,13 @@ Creates a new Value object of the specified DateTime value. .Returns `static std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +Value::of(value); +---- + [#_static_DateTime_TypeDBValueparseDateTime___const_stdstring__s_] ==== parseDateTime @@ -301,6 +413,13 @@ Parses a DateTime from a string in the TypeQL DateTime format (yyyy-mm-dd'T'HH:M .Returns `static DateTime` +[caption=""] +.Code examples +[source,cpp] +---- +Value::parseDateTime(str); +---- + [#_ValueType_TypeDBValuevalueType___] ==== valueType @@ -318,5 +437,12 @@ Retrieves the ``ValueType`` of this value concept. .Returns `ValueType` +[caption=""] +.Code examples +[source,cpp] +---- +value.getType() +---- + // end::methods[] diff --git a/cpp/docs/errors/DriverException.adoc b/cpp/docs/errors/DriverException.adoc index 3e1df49ecd..211e889679 100644 --- a/cpp/docs/errors/DriverException.adoc +++ b/cpp/docs/errors/DriverException.adoc @@ -25,6 +25,16 @@ Retrieves the error code. .Returns `const std::string_view` +[caption=""] +.Code examples +[source,cpp] +---- +try { ... } +catch (TypeDB::DriverException& e){ + if ("[CXN11]" == e.code()) { ... } +} +---- + [#_const_stdstring_view_TypeDBDriverExceptionmessage___] ==== message @@ -42,5 +52,16 @@ Retrieves the descriptive error message. .Returns `const std::string_view` +[caption=""] +.Code examples +[source,cpp] +---- +try { ... } +catch (TypeDB::DriverException& e){ + logError(e.message()); + throw e; +} +---- + // end::methods[] diff --git a/cpp/docs/logic/LogicManager.adoc b/cpp/docs/logic/LogicManager.adoc index f18fb6f4b8..87fee9ed03 100644 --- a/cpp/docs/logic/LogicManager.adoc +++ b/cpp/docs/logic/LogicManager.adoc @@ -34,6 +34,13 @@ a| `label` a| The label of the Rule to create or retrieve a| .Returns `OptionalRuleFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.logic.getRule(label).get(); +---- + [#_RuleIterable_TypeDBLogicManagergetRules_____const] ==== getRules @@ -51,6 +58,13 @@ Retrieves all rules. .Returns `RuleIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.logic.getRules() +---- + [#_RuleFuture_TypeDBLogicManagerputRule___const_stdstring__label__const_stdstring__when__const_stdstring__then___const] ==== putRule @@ -79,5 +93,12 @@ a| `then` a| The then body of the rule to create a| .Returns `RuleFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.logic.putRule(label, when, then).get(); +---- + // end::methods[] diff --git a/cpp/docs/logic/Rule.adoc b/cpp/docs/logic/Rule.adoc index 56929576b2..dbd2bb1b8f 100644 --- a/cpp/docs/logic/Rule.adoc +++ b/cpp/docs/logic/Rule.adoc @@ -36,6 +36,13 @@ a| `transaction` a| The current ``Transaction`` a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +rule.deleteRule(transaction).get(); +---- + [#_BoolFuture_TypeDBRuleisDeleted___Transaction__transaction_] ==== isDeleted @@ -62,6 +69,13 @@ a| `transaction` a| The current ``Transaction`` a| .Returns `BoolFuture` +[caption=""] +.Code examples +[source,cpp] +---- +rule.isDeleted(transaction).get(); +---- + [#_stdstring_TypeDBRulelabel___] ==== label @@ -105,6 +119,13 @@ a| `label` a| The new label to be given to the rule a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +rule.setLabel(transaction, newLabel).get(); +---- + [#_stdstring_TypeDBRulethen___] ==== then diff --git a/cpp/docs/schema/Annotation.adoc b/cpp/docs/schema/Annotation.adoc index 3a588017bb..72c12c3a9c 100644 --- a/cpp/docs/schema/Annotation.adoc +++ b/cpp/docs/schema/Annotation.adoc @@ -25,6 +25,13 @@ Checks if this ``Annotation`` is a ``@key`` annotation. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +annotation.isKey(); +---- + [#_bool_TypeDBAnnotationisUnique___] ==== isUnique @@ -42,6 +49,13 @@ Checks if this ``Annotation`` is a ``@unique`` annotation. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +annotation.isUnique(); +---- + [#_static_Annotation_TypeDBAnnotationkey___] ==== key @@ -59,6 +73,13 @@ Produces a ``@key`` annotation. .Returns `static Annotation` +[caption=""] +.Code examples +[source,cpp] +---- +ThingType.Annotation.key(); +---- + [#_stdstring_TypeDBAnnotationtoString___] ==== toString @@ -92,5 +113,12 @@ Produces a ``@unique`` annotation. .Returns `static Annotation` +[caption=""] +.Code examples +[source,cpp] +---- +Annotation.unique(); +---- + // end::methods[] diff --git a/cpp/docs/schema/AttributeType.adoc b/cpp/docs/schema/AttributeType.adoc index 0835218154..23abfd4c77 100644 --- a/cpp/docs/schema/AttributeType.adoc +++ b/cpp/docs/schema/AttributeType.adoc @@ -47,6 +47,13 @@ a| `value` a| ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__const_stdstring__value_] ==== get @@ -74,6 +81,13 @@ a| `value` a| ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__int64_t_value_] ==== get @@ -101,6 +115,13 @@ a| `value` a| ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__double_value_] ==== get @@ -128,6 +149,13 @@ a| `value` a| ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__bool_value_] ==== get @@ -155,6 +183,13 @@ a| `value` a| ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__DateTime_value_] ==== get @@ -182,6 +217,13 @@ a| `value` a| ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptIterable__Attribute___TypeDBAttributeTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getInstances @@ -209,6 +251,18 @@ a| `transaction` a| The current transaction a| .Returns `ConceptIterable< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getInstances(transaction); +attributeType.getInstances(transaction, transitivity); + Parameters + + transitivity Transitivity::TRANSITIVE for direct and indirect subtypes, Transitivity::EXPLICIT for direct subtypes only + transaction The current transaction +---- + [#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getOwners @@ -236,6 +290,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getOwners(transaction); +---- + [#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Transaction__transaction__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getOwners @@ -264,6 +325,35 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getOwners(transaction, {Annotation::key()}, transitivity); + */ +ConceptIterable getOwners(Transaction& transaction, const std::initializer_list& annotations, Transitivity transitivity = Transitivity::TRANSITIVE); + +/** + Retrieve all Things that own an attribute of this AttributeType, + filtered by Annotations, directly or through inheritance. + + Examples +---- + +[source,cpp] +---- +attributeType.getOwners(transaction, annotations); +---- + +[source,cpp] +---- +Parameters + + transaction The current transaction + annotations Only retrieve ThingTypes that have an attribute of this AttributeType with all given Annotations + transitivity Transitivity::TRANSITIVE for direct and indirect subtypes, Transitivity::EXPLICIT for direct subtypes only +---- + [#_OptionalStringFuture_TypeDBAttributeTypegetRegex___Transaction__transaction_] ==== getRegex @@ -290,6 +380,13 @@ a| `transaction` a| The current transaction a| .Returns `OptionalStringFuture` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getRegex(transaction).get(); +---- + [#_ConceptIterable__AttributeType___TypeDBAttributeTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -317,6 +414,14 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getSubtypes(transaction); +attributeType.getSubtypes(transaction, transitivity); +---- + [#_ConceptIterable__AttributeType___TypeDBAttributeTypegetSubtypes___Transaction__transaction__ValueType_valueType__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -345,6 +450,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getSubtypes(transaction, valueType, transitivity); +---- + [#_ValueType_TypeDBAttributeTypegetValueType___] ==== getValueType @@ -362,6 +474,13 @@ Retrieves the ``Value.Type`` of this ``AttributeType``. .Returns `ValueType` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getValueType(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__Value__ptr__value_] ==== put @@ -389,6 +508,13 @@ a| `value` a| New ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__const_stdstring__value_] ==== put @@ -416,6 +542,13 @@ a| `value` a| New ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__int64_t_value_] ==== put @@ -443,6 +576,13 @@ a| `value` a| New ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__double_value_] ==== put @@ -470,6 +610,13 @@ a| `value` a| New ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__bool_value_] ==== put @@ -497,6 +644,13 @@ a| `value` a| New ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__DateTime_value_] ==== put @@ -524,6 +678,13 @@ a| `value` a| New ``Attribute``’s value a| .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_VoidFuture_TypeDBAttributeTypesetRegex___Transaction__transaction__const_stdstring__regex_] ==== setRegex @@ -553,6 +714,13 @@ a| `regex` a| Regular expression a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.setRegex(transaction, regex).get(); +---- + [#_VoidFuture_TypeDBAttributeTypesetSupertype___Transaction__transaction__AttributeType__ptr__attributeType_] ==== setSupertype @@ -580,6 +748,13 @@ a| `attributeType` a| The ``AttributeType`` to set as the supertype of this ``At .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.setSupertype(transaction, superType).get(); +---- + [#_VoidFuture_TypeDBAttributeTypeunsetRegex___Transaction__transaction_] ==== unsetRegex @@ -606,5 +781,12 @@ a| `transaction` a| The current transaction a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.unsetRegex(transaction).get(); +---- + // end::methods[] diff --git a/cpp/docs/schema/EntityType.adoc b/cpp/docs/schema/EntityType.adoc index 840b098c40..83978b4c62 100644 --- a/cpp/docs/schema/EntityType.adoc +++ b/cpp/docs/schema/EntityType.adoc @@ -40,6 +40,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptPtrFuture< Entity >` +[caption=""] +.Code examples +[source,cpp] +---- +entityType.create(transaction).get(); +---- + [#_ConceptIterable__Entity___TypeDBEntityTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getInstances @@ -67,6 +74,13 @@ a| `transitivity` a| ``Transitivity::EXPLICIT`` for direct instances only, ``Tra .Returns `ConceptIterable< Entity >` +[caption=""] +.Code examples +[source,cpp] +---- +entityType.getInstances(transaction, transitivity); +---- + [#_ConceptIterable__EntityType___TypeDBEntityTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -94,6 +108,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< EntityType >` +[caption=""] +.Code examples +[source,cpp] +---- +entityType.getSubtypes(transaction, transitivity); +---- + [#_VoidFuture_TypeDBEntityTypesetSupertype___Transaction__transaction__EntityType__ptr__superEntityType_] ==== setSupertype @@ -121,5 +142,12 @@ a| `superEntityType` a| The ``EntityType`` to set as the supertype of this ``Ent .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +entityType.setSupertype(transaction, entityType).get(); +---- + // end::methods[] diff --git a/cpp/docs/schema/RelationType.adoc b/cpp/docs/schema/RelationType.adoc index c5b57586ee..6536988352 100644 --- a/cpp/docs/schema/RelationType.adoc +++ b/cpp/docs/schema/RelationType.adoc @@ -42,6 +42,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptPtrFuture< Relation >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.create(transaction).get(); +---- + [#_ConceptIterable__Relation___TypeDBRelationTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getInstances @@ -69,6 +76,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect instan .Returns `ConceptIterable< Relation >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getInstances(transaction, transitivity) +---- + [#_ConceptIterable__RoleType___TypeDBRelationTypegetRelates___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getRelates @@ -96,6 +110,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and inherited relat .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getRelates(transaction, transitivity); +---- + [#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelates___Transaction__transaction__const_stdstring__roleLabel_] ==== getRelates @@ -123,6 +144,13 @@ a| `roleLabel` a| Label of the role we wish to retrieve a| .Returns `ConceptPtrFuture< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getRelates(transaction, roleLabel).get(); +---- + [#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelatesOverridden___Transaction__transaction__RoleType__ptr__roleType_] ==== getRelatesOverridden @@ -150,6 +178,13 @@ a| `roleLabel` a| Label of the role that overrides an inherited role a| .Returns `ConceptPtrFuture< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getRelatesOverridden(transaction, roleLabel).get(); +---- + [#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelatesOverridden___Transaction__transaction__const_stdstring__roleLabel_] ==== getRelatesOverridden @@ -177,6 +212,13 @@ a| `roleLabel` a| Label of the role that overrides an inherited role a| .Returns `ConceptPtrFuture< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getRelatesOverridden(transaction, roleLabel).get(); +---- + [#_ConceptIterable__RelationType___TypeDBRelationTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -204,6 +246,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getSubtypes(transaction, transitivity); +---- + [#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel_] ==== setRelates @@ -264,6 +313,14 @@ a| `overriddenLabel` a| The label being overridden, if applicable a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.setRelates(transaction, roleLabel).get(); +relationType.setRelates(transaction, roleLabel, overriddenLabel).get(); +---- + [#_VoidFuture_TypeDBRelationTypesetSupertype___Transaction__transaction__RelationType__ptr__superRelationType_] ==== setSupertype @@ -291,6 +348,13 @@ a| `superRelationType` a| The ``RelationType`` to set as the supertype of this ` .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.setSupertype(transaction, superRelationType).get(); +---- + [#_VoidFuture_TypeDBRelationTypeunsetRelates___Transaction__transaction__RoleType__ptr__roleType_] ==== unsetRelates @@ -334,5 +398,12 @@ a| `roleLabel` a| The role to not relate to the relation type. a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.unsetRelates(transaction, roleLabel).get(); +---- + // end::methods[] diff --git a/cpp/docs/schema/RoleType.adoc b/cpp/docs/schema/RoleType.adoc index 586694c154..f7207353f1 100644 --- a/cpp/docs/schema/RoleType.adoc +++ b/cpp/docs/schema/RoleType.adoc @@ -45,6 +45,13 @@ a| `transaction` a| The current transaction a| .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.deleteType(transaction).get(); +---- + [#_virtual_stdstring_TypeDBRoleTypegetLabel___] ==== getLabel @@ -66,6 +73,13 @@ Implements TypeDB::Type. .Returns `virtual std::string` +[caption=""] +.Code examples +[source,cpp] +---- +type.getLabel(); +---- + [#_stdstring_TypeDBRoleTypegetName___] ==== getName @@ -83,6 +97,13 @@ Returns the name of this role type's label. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +label.getName(); +---- + [#_ConceptIterable__Thing___TypeDBRoleTypegetPlayerInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getPlayerInstances @@ -110,6 +131,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect playin .Returns `ConceptIterable< Thing >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getPlayerInstances(transaction, transitivity); +---- + [#_ConceptIterable__ThingType___TypeDBRoleTypegetPlayerTypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getPlayerTypes @@ -137,6 +165,13 @@ a| `transitivity` a| ``Transitivity.TRANSITIVE`` for direct and indirect playing .Returns `ConceptIterable< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getPlayerTypes(transaction, transitivity) +---- + [#_ConceptIterable__Relation___TypeDBRoleTypegetRelationInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getRelationInstances @@ -164,6 +199,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect relati .Returns `ConceptIterable< Relation >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getRelationInstances(transaction, transitivity) +---- + [#_ConceptPtrFuture__RelationType___TypeDBRoleTypegetRelationType___Transaction__transaction_] ==== getRelationType @@ -190,6 +232,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptPtrFuture< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getRelationType(transaction).get(); +---- + [#_ConceptIterable__RelationType___TypeDBRoleTypegetRelationTypes___Transaction__transaction_] ==== getRelationTypes @@ -216,6 +265,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptIterable< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getRelationTypes(transaction); +---- + [#_stdstring_TypeDBRoleTypegetScope___] ==== getScope @@ -233,6 +289,13 @@ Returns the scope part of this role type's label. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +label.getScope(); +---- + [#_ConceptIterable__RoleType___TypeDBRoleTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -260,6 +323,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getSubtypes(transaction, transitivity); +---- + [#_ConceptPtrFuture__RoleType___TypeDBRoleTypegetSupertype___Transaction__transaction_] ==== getSupertype @@ -286,6 +356,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptPtrFuture< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getSupertype(transaction).get(); +---- + [#_ConceptIterable__RoleType___TypeDBRoleTypegetSupertypes___Transaction__transaction_] ==== getSupertypes @@ -312,6 +389,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getSupertypes(transaction); +---- + [#_virtual_bool_TypeDBRoleTypeisAbstract___] ==== isAbstract @@ -333,6 +417,13 @@ Implements TypeDB::Type. .Returns `virtual bool` +[caption=""] +.Code examples +[source,cpp] +---- +type.isAbstract(); +---- + [#_virtual_BoolFuture_TypeDBRoleTypeisDeleted___Transaction__transaction_] ==== isDeleted @@ -363,6 +454,13 @@ a| `transaction` a| The current transaction a| .Returns `virtual BoolFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.isDeleted(transaction).get(); +---- + [#_bool_TypeDBRoleTypeisRoot___] ==== isRoot @@ -380,6 +478,13 @@ Checks if the type is a root type. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +type.isRoot(); +---- + [#_virtual_VoidFuture_TypeDBRoleTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] ==== setLabel @@ -411,5 +516,12 @@ a| `label` a| The new ``Label`` to be given to the type. a| .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.setLabel(transaction, newLabel).get(); +---- + // end::methods[] diff --git a/cpp/docs/schema/ThingType.adoc b/cpp/docs/schema/ThingType.adoc index d02a630798..169024cf9e 100644 --- a/cpp/docs/schema/ThingType.adoc +++ b/cpp/docs/schema/ThingType.adoc @@ -43,6 +43,13 @@ a| `transaction` a| The current transaction a| .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.deleteType(transaction).get(); +---- + [#_virtual_stdstring_TypeDBThingTypegetLabel___] ==== getLabel @@ -64,6 +71,13 @@ Implements TypeDB::Type. .Returns `virtual std::string` +[caption=""] +.Code examples +[source,cpp] +---- +type.getLabel(); +---- + [#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getOwns @@ -175,6 +189,14 @@ a| `annotations` a| Only retrieve attribute types owned with annotations. a| .Returns `ConceptIterable< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.getOwns(transaction); +thingType.getOwns(transaction, valueType, Transitivity::EXPLICIT, Collections.singleton(Annotation.key())); +---- + [#_ConceptPtrFuture__AttributeType___TypeDBThingTypegetOwnsOverridden___Transaction__transaction__AttributeType__ptr__attributeType_] ==== getOwnsOverridden @@ -202,6 +224,13 @@ a| `attributeType` a| The ``AttributeType`` that overrides requested ``Attribute .Returns `ConceptPtrFuture< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.getOwnsOverridden(transaction, attributeType).get(); +---- + [#_ConceptIterable__RoleType___TypeDBThingTypegetPlays___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getPlays @@ -229,6 +258,14 @@ a| `transitivity` a| transitivity: ``Transitivity::TRANSITIVE`` for direct and i .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.getPlays(transaction).get(); +thingType.getPlays(transaction, Transitivity::EXPLICIT).get(); +---- + [#_ConceptPtrFuture__RoleType___TypeDBThingTypegetPlaysOverridden___Transaction__transaction__RoleType__ptr__roleType_] ==== getPlaysOverridden @@ -256,6 +293,13 @@ a| `roleType` a| The ``RoleType`` that overrides an inherited role a| .Returns `ConceptPtrFuture< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.getPlaysOverridden(transaction, roleType).get(); +---- + [#_ConceptIterable__ThingType___TypeDBThingTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -285,6 +329,14 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSubtypes(transaction); +type.getSubtypes(transaction, Transitivity.EXPLICIT); +---- + [#_ConceptPtrFuture__ThingType___TypeDBThingTypegetSupertype___Transaction__transaction_] ==== getSupertype @@ -313,6 +365,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptPtrFuture< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSupertype(transaction).get(); +---- + [#_ConceptIterable__ThingType___TypeDBThingTypegetSupertypes___Transaction__transaction_] ==== getSupertypes @@ -341,6 +400,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptIterable< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSupertypes(transaction); +---- + [#_StringFuture_TypeDBThingTypegetSyntax___Transaction__transaction_] ==== getSyntax @@ -367,6 +433,13 @@ a| `transaction` a| The current transaction a| .Returns `StringFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.getSyntax(transaction).get(); +---- + [#_virtual_bool_TypeDBThingTypeisAbstract___] ==== isAbstract @@ -388,6 +461,13 @@ Implements TypeDB::Type. .Returns `virtual bool` +[caption=""] +.Code examples +[source,cpp] +---- +type.isAbstract(); +---- + [#_virtual_BoolFuture_TypeDBThingTypeisDeleted___Transaction__transaction_] ==== isDeleted @@ -418,6 +498,13 @@ a| `transaction` a| The current transaction a| .Returns `virtual BoolFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.isDeleted(transaction).get(); +---- + [#_bool_TypeDBThingTypeisRoot___] ==== isRoot @@ -435,6 +522,13 @@ Checks if the type is a root type. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +type.isRoot(); +---- + [#_VoidFuture_TypeDBThingTypesetAbstract___Transaction__transaction_] ==== setAbstract @@ -461,6 +555,13 @@ a| `transaction` a| The current transaction a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.setAbstract(transaction).get(); +---- + [#_virtual_VoidFuture_TypeDBThingTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] ==== setLabel @@ -492,6 +593,13 @@ a| `label` a| The new ``Label`` to be given to the type. a| .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.setLabel(transaction, newLabel).get(); +---- + [#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__const_stdinitializer_list__Annotation____annotations___] ==== setOwns @@ -571,6 +679,14 @@ a| `annotations` a| Adds annotations to the ownership. a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.setOwns(transaction, attributeType).get(); +thingType.setOwns(transaction, attributeType, overriddenType, Collections.singleton(Annotation.key())).get(); +---- + [#_VoidFuture_TypeDBThingTypesetPlays___Transaction__transaction__RoleType__ptr__roleType_] ==== setPlays @@ -615,6 +731,14 @@ a| `overriddenType` a| The role type that this role overrides, if applicable a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.setPlays(transaction, roleType).get(); +thingType.setPlays(transaction, roleType, overriddenType).get(); +---- + [#_VoidFuture_TypeDBThingTypeunsetAbstract___Transaction__transaction_] ==== unsetAbstract @@ -641,6 +765,13 @@ a| `transaction` a| The current transaction a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.unsetAbstract(transaction).get(); +---- + [#_VoidFuture_TypeDBThingTypeunsetOwns___Transaction__transaction__AttributeType__ptr__attributeType_] ==== unsetOwns @@ -668,6 +799,13 @@ a| `attributeType` a| The ``AttributeType`` to not be owned by the type. a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.unsetOwns(transaction, attributeType).get(); +---- + [#_VoidFuture_TypeDBThingTypeunsetPlays___Transaction__transaction__RoleType__ptr__roleType_] ==== unsetPlays @@ -695,5 +833,12 @@ a| `roleType` a| The role to not be played by the instances of this type. a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.unsetPlays(transaction, roleType).get(); +---- + // end::methods[] diff --git a/cpp/docs/schema/Type.adoc b/cpp/docs/schema/Type.adoc index c41b419dd6..b94cd7fa0b 100644 --- a/cpp/docs/schema/Type.adoc +++ b/cpp/docs/schema/Type.adoc @@ -40,6 +40,13 @@ a| `transaction` a| The current transaction a| .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.deleteType(transaction).get(); +---- + [#_virtual_stdstring_TypeDBTypegetLabel___] ==== getLabel @@ -59,6 +66,13 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. .Returns `virtual std::string` +[caption=""] +.Code examples +[source,cpp] +---- +type.getLabel(); +---- + [#_ConceptIterable__Type___TypeDBTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -86,6 +100,14 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< Type >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSubtypes(transaction); +type.getSubtypes(transaction, Transitivity.EXPLICIT); +---- + [#_ConceptPtrFuture__Type___TypeDBTypegetSupertype___Transaction__transaction_] ==== getSupertype @@ -112,6 +134,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptPtrFuture< Type >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSupertype(transaction).get(); +---- + [#_ConceptIterable__Type___TypeDBTypegetSupertypes___Transaction__transaction_] ==== getSupertypes @@ -138,6 +167,13 @@ a| `transaction` a| The current transaction a| .Returns `ConceptIterable< Type >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSupertypes(transaction); +---- + [#_virtual_bool_TypeDBTypeisAbstract___] ==== isAbstract @@ -157,6 +193,13 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. .Returns `virtual bool` +[caption=""] +.Code examples +[source,cpp] +---- +type.isAbstract(); +---- + [#_virtual_BoolFuture_TypeDBTypeisDeleted___Transaction__transaction_] ==== isDeleted @@ -185,6 +228,13 @@ a| `transaction` a| The current transaction a| .Returns `virtual BoolFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.isDeleted(transaction).get(); +---- + [#_virtual_VoidFuture_TypeDBTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] ==== setLabel @@ -214,5 +264,12 @@ a| `label` a| The new ``Label`` to be given to the type. a| .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.setLabel(transaction, newLabel).get(); +---- + // end::methods[] diff --git a/cpp/docs/session/Options.adoc b/cpp/docs/session/Options.adoc index d6937dabb9..b4b562e8ee 100644 --- a/cpp/docs/session/Options.adoc +++ b/cpp/docs/session/Options.adoc @@ -27,6 +27,13 @@ Produces a new ``Options`` object. .Returns `TypeDB::Options::Options` +[caption=""] +.Code examples +[source,cpp] +---- +TypeDBOptions options = TypeDBOptions(); +---- + [#_stdoptional__bool___TypeDBOptionsexplain___] ==== explain @@ -44,6 +51,13 @@ Returns the value set for the explanation in this ``TypeDBOptions`` object. If s .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.explain(); +---- + [#_Options__TypeDBOptionsexplain___bool_explain_] ==== explain @@ -70,6 +84,13 @@ a| `explain` a| Explicitly enable or disable explanations a| .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.explain(explain); +---- + [#_stdoptional__bool___TypeDBOptionsinfer___] ==== infer @@ -87,6 +108,13 @@ Returns the value set for the inference in this ``TypeDBOptions`` object. .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.infer(); +---- + [#_Options__TypeDBOptionsinfer___bool_infer_] ==== infer @@ -113,6 +141,13 @@ a| `infer` a| Explicitly enable or disable inference a| .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.infer(infer); +---- + [#_stdoptional__bool___TypeDBOptionsparallel___] ==== parallel @@ -130,6 +165,13 @@ Returns the value set for the parallel execution in this ``TypeDBOptions`` objec .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.parallel(); +---- + [#_Options__TypeDBOptionsparallel___bool_parallel_] ==== parallel @@ -156,6 +198,13 @@ a| `parallel` a| Explicitly enable or disable parallel execution a| .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.parallel(parallel); +---- + [#_stdoptional__bool___TypeDBOptionsprefetch___] ==== prefetch @@ -173,6 +222,13 @@ Returns the value set for the prefetching in this ``TypeDBOptions`` object. If s .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.prefetch(); +---- + [#_Options__TypeDBOptionsprefetch___bool_prefetch_] ==== prefetch @@ -199,6 +255,13 @@ a| `prefetch` a| Explicitly enable or disable prefetching a| .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.prefetch(prefetch); +---- + [#_stdoptional__int32_t___TypeDBOptionsprefetchSize___] ==== prefetchSize @@ -216,6 +279,13 @@ Returns the value set for the prefetch size in this ``TypeDBOptions`` object. If .Returns `std::optional< int32_t >` +[caption=""] +.Code examples +[source,cpp] +---- +options.prefetchSize(); +---- + [#_Options__TypeDBOptionsprefetchSize___int32_t_prefetchSize_] ==== prefetchSize @@ -242,6 +312,13 @@ a| `prefetchSize` a| Number of answers that the server should send before the dr .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.prefetchSize(prefetchSize); +---- + [#_stdoptional__bool___TypeDBOptionsreadAnyReplica___] ==== readAnyReplica @@ -259,6 +336,13 @@ Returns the value set for reading data from any replica in this ``TypeDBOptions` .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.readAnyReplica(); +---- + [#_Options__TypeDBOptionsreadAnyReplica___bool_readAnyReplica_] ==== readAnyReplica @@ -285,6 +369,13 @@ a| `readAnyReplica` a| Explicitly enable or disable reading data from any replic .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.readAnyReplica(readAnyReplica); +---- + [#_stdoptional__int64_t___TypeDBOptionsschemaLockAcquireTimeoutMillis___] ==== schemaLockAcquireTimeoutMillis @@ -302,6 +393,13 @@ Returns the value set for the schema lock acquire timeout in this ``TypeDBOption .Returns `std::optional< int64_t >` +[caption=""] +.Code examples +[source,cpp] +---- +options.schemaLockAcquireTimeoutMillis(); +---- + [#_Options__TypeDBOptionsschemaLockAcquireTimeoutMillis___int64_t_timeoutMillis_] ==== schemaLockAcquireTimeoutMillis @@ -328,6 +426,13 @@ a| `schemaLockAcquireTimeoutMillis` a| How long the driver should wait if openin .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.schemaLockAcquireTimeoutMillis(schemaLockAcquireTimeoutMillis); +---- + [#_stdoptional__int64_t___TypeDBOptionssessionIdleTimeoutMillis___] ==== sessionIdleTimeoutMillis @@ -345,6 +450,13 @@ Returns the value set for the session idle timeout in this ``TypeDBOptions`` obj .Returns `std::optional< int64_t >` +[caption=""] +.Code examples +[source,cpp] +---- +options.sessionIdleTimeoutMillis(); +---- + [#_Options__TypeDBOptionssessionIdleTimeoutMillis___int64_t_timeoutMillis_] ==== sessionIdleTimeoutMillis @@ -371,6 +483,13 @@ a| `sessionIdleTimeoutMillis` a| timeout that allows the server to close session .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.sessionIdleTimeoutMillis(sessionIdleTimeoutMillis); +---- + [#_stdoptional__bool___TypeDBOptionstraceInference___] ==== traceInference @@ -388,6 +507,13 @@ Returns the value set for reasoning tracing in this ``TypeDBOptions`` object. If .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.traceInference(); +---- + [#_Options__TypeDBOptionstraceInference___bool_traceInference_] ==== traceInference @@ -414,6 +540,13 @@ a| `traceInference` a| Explicitly enable or disable reasoning tracing a| .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.traceInference(traceInference); +---- + [#_stdoptional__int64_t___TypeDBOptionstransactionTimeoutMillis___] ==== transactionTimeoutMillis @@ -431,6 +564,13 @@ Returns the value set for the transaction timeout in this ``TypeDBOptions`` obje .Returns `std::optional< int64_t >` +[caption=""] +.Code examples +[source,cpp] +---- +options.transactionTimeoutMillis(); +---- + [#_Options__TypeDBOptionstransactionTimeoutMillis___int64_t_timeoutMillis_] ==== transactionTimeoutMillis @@ -457,5 +597,12 @@ a| `transactionTimeoutMillis` a| Timeout for killing transactions automatically .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.transactionTimeoutMillis(transactionTimeoutMillis); +---- + // end::methods[] diff --git a/cpp/docs/session/Session.adoc b/cpp/docs/session/Session.adoc index 66a95d7f14..89a47c9bbe 100644 --- a/cpp/docs/session/Session.adoc +++ b/cpp/docs/session/Session.adoc @@ -25,6 +25,13 @@ Closes the session. Before opening a new session, the session currently open sho .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +session.close(); +---- + [#_stdstring_TypeDBSessiondatabaseName_____const] ==== databaseName @@ -42,6 +49,13 @@ Returns the name of the database of the session. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +session.databaseName(); +---- + [#_bool_TypeDBSessionisOpen_____const] ==== isOpen @@ -59,6 +73,13 @@ Checks whether this session is open. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +session.isOpen(); +---- + [#_void_TypeDBSessiononClose___stdfunction__void____callback_] ==== onClose @@ -85,6 +106,13 @@ a| `function` a| The callback function. a| .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +session.onClose(function) +---- + [#_void_TypeDBSessiononReopen___stdfunction__void____callback_] ==== onReopen @@ -111,6 +139,13 @@ a| `function` a| The callback function. a| .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +session.onReopen(function) +---- + [#_Transaction_TypeDBSessiontransaction___TransactionType_type__const_Options__options__Options_____const] ==== transaction @@ -138,6 +173,13 @@ a| `options` a| Options for the session a| .Returns `Transaction` +[caption=""] +.Code examples +[source,cpp] +---- +session.transaction(transactionType, options); +---- + [#_SessionType_TypeDBSessiontype_____const] ==== type diff --git a/cpp/docs/transaction/QueryManager.adoc b/cpp/docs/transaction/QueryManager.adoc index 43780c656e..378bab038c 100644 --- a/cpp/docs/transaction/QueryManager.adoc +++ b/cpp/docs/transaction/QueryManager.adoc @@ -35,6 +35,13 @@ a| `options` a| Specify query options a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.define(query, options).get() +---- + [#_ExplanationIterable_TypeDBQueryManagerexplain___const_Explainable__explainable__const_Options___Options_____const] ==== explain @@ -62,6 +69,13 @@ a| `options` a| Specify query options a| .Returns `ExplanationIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.explain(explainable, options) +---- + [#_JSONIterable_TypeDBQueryManagerfetch___const_stdstring__query__const_Options__options__Options_____const] ==== fetch @@ -89,6 +103,13 @@ a| `options` a| Specify query options a| .Returns `JSONIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.fetch(query, options) +---- + [#_ConceptMapIterable_TypeDBQueryManagerget___const_stdstring__query__const_Options__options__Options_____const] ==== get @@ -116,6 +137,13 @@ a| `options` a| Specify query options a| .Returns `ConceptMapIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.get(query, options) +---- + [#_AggregateFuture_TypeDBQueryManagergetAggregate___const_stdstring__query__const_Options___Options_____const] ==== getAggregate @@ -143,6 +171,13 @@ a| `options` a| Specify query options a| .Returns `AggregateFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.getAggregate(query, options).get() +---- + [#_ConceptMapGroupIterable_TypeDBQueryManagergetGroup___const_stdstring__query__const_Options___Options_____const] ==== getGroup @@ -170,6 +205,13 @@ a| `options` a| Specify query options a| .Returns `ConceptMapGroupIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.getGroup(query, options) +---- + [#_ValueGroupIterable_TypeDBQueryManagergetGroupAggregate___const_stdstring__query__const_Options___Options_____const] ==== getGroupAggregate @@ -197,6 +239,13 @@ a| `options` a| Specify query options a| .Returns `ValueGroupIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.getGroupAggregate(query, options) +---- + [#_ConceptMapIterable_TypeDBQueryManagerinsert___const_stdstring__query__const_Options__options__Options_____const] ==== insert @@ -224,6 +273,13 @@ a| `options` a| Specify query options a| .Returns `ConceptMapIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.insert(query, options) +---- + [#_VoidFuture_TypeDBQueryManagermatchDelete___const_stdstring__query__const_Options__options__Options_____const] ==== matchDelete @@ -251,6 +307,13 @@ a| `options` a| Specify query options a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.matchDelete(query, options).get() +---- + [#_VoidFuture_TypeDBQueryManagerundefine___const_stdstring__query__const_Options__options__Options_____const] ==== undefine @@ -278,6 +341,13 @@ a| `options` a| Specify query options a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.undefine(query, options).get() +---- + [#_ConceptMapIterable_TypeDBQueryManagerupdate___const_stdstring__query__const_Options___Options_____const] ==== update @@ -305,5 +375,12 @@ a| `options` a| Specify query options a| .Returns `ConceptMapIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.update(query, options) +---- + // end::methods[] diff --git a/cpp/docs/transaction/Transaction.adoc b/cpp/docs/transaction/Transaction.adoc index 26f4c4fc8b..6ad3f7a15e 100644 --- a/cpp/docs/transaction/Transaction.adoc +++ b/cpp/docs/transaction/Transaction.adoc @@ -38,6 +38,13 @@ Closes the transaction. .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.close() +---- + [#_void_TypeDBTransactioncommit___] ==== commit @@ -55,6 +62,13 @@ Commits the changes made via this transaction to the TypeDB database. Whether or .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.commit() +---- + [#_void_TypeDBTransactionforceClose___] ==== forceClose @@ -72,6 +86,13 @@ Closes the transaction. .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.close() +---- + [#_bool_TypeDBTransactionisOpen_____const] ==== isOpen @@ -89,6 +110,13 @@ Checks whether this transaction is open. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.isOpen(); +---- + [#_void_TypeDBTransactiononClose___stdfunction__void_const_stdoptional__DriverException______callback_] ==== onClose @@ -115,6 +143,13 @@ a| `function` a| The callback function. a| .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.onClose(function); +---- + [#_void_TypeDBTransactionrollback___] ==== rollback @@ -132,6 +167,13 @@ Rolls back the uncommitted changes made via this transaction. .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.rollback() +---- + [#_TypeDBTransactionType_TypeDBTransactiontype_____const] ==== type From 710b49ac89f5c13f61be8fce7066899f41504757 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Fri, 22 Mar 2024 12:29:35 +0000 Subject: [PATCH 033/118] Refactor enums parsing, add basic docs --- csharp/docs/answer/IConceptMap.adoc | 89 +++ csharp/docs/answer/IConceptMapGroup.adoc | 29 + csharp/docs/answer/IExplainable.adoc | 9 + csharp/docs/answer/IExplainables.adoc | 142 ++++ csharp/docs/answer/IExplanation.adoc | 55 ++ csharp/docs/answer/IValueGroup.adoc | 9 + csharp/docs/answer/Promise__T__.adoc | 86 ++ csharp/docs/answer/VoidPromise.adoc | 63 ++ csharp/docs/concept/IConcept.adoc | 426 ++++++++++ csharp/docs/concept/IConceptManager.adoc | 264 +++++++ csharp/docs/concept/Transitivity.adoc | 29 + csharp/docs/connection/IDatabase.adoc | 93 +++ csharp/docs/connection/IDatabaseManager.adoc | 107 +++ csharp/docs/connection/IReplica.adoc | 44 ++ csharp/docs/connection/ITypeDBDriver.adoc | 111 +++ csharp/docs/connection/IUser.adoc | 57 ++ csharp/docs/connection/IUserManager.adoc | 161 ++++ csharp/docs/connection/TypeDBCredential.adoc | 118 +++ csharp/docs/data/IAttribute.adoc | 110 +++ csharp/docs/data/IEntity.adoc | 55 ++ csharp/docs/data/IRelation.adoc | 190 +++++ csharp/docs/data/IThing.adoc | 280 +++++++ csharp/docs/data/IValue.adoc | 241 ++++++ csharp/docs/data/ValueType.adoc | 33 + csharp/docs/errors/TypeDBDriverException.adoc | 93 +++ csharp/docs/logic/ILogicManager.adoc | 83 ++ csharp/docs/logic/IRule.adoc | 91 +++ csharp/docs/schema/Annotation.adoc | 139 ++++ csharp/docs/schema/IAttributeType.adoc | 746 ++++++++++++++++++ csharp/docs/schema/IEntityType.adoc | 113 +++ csharp/docs/schema/IRelationType.adoc | 369 +++++++++ csharp/docs/schema/IRoleType.adoc | 238 ++++++ csharp/docs/schema/IThingType.adoc | 693 ++++++++++++++++ csharp/docs/schema/IType.adoc | 270 +++++++ csharp/docs/schema/Label.adoc | 152 ++++ csharp/docs/session/ITypeDBSession.adoc | 145 ++++ csharp/docs/session/SessionType.adoc | 29 + csharp/docs/session/TypeDBOptions.adoc | 459 +++++++++++ csharp/docs/transaction/IQueryManager.adoc | 573 ++++++++++++++ .../docs/transaction/ITypeDBTransaction.adoc | 102 +++ csharp/docs/transaction/TransactionType.adoc | 29 + tool/docs/csharp/DoxygenParserCsharp.kt | 60 +- 42 files changed, 7149 insertions(+), 36 deletions(-) create mode 100644 csharp/docs/answer/IConceptMap.adoc create mode 100644 csharp/docs/answer/IConceptMapGroup.adoc create mode 100644 csharp/docs/answer/IExplainable.adoc create mode 100644 csharp/docs/answer/IExplainables.adoc create mode 100644 csharp/docs/answer/IExplanation.adoc create mode 100644 csharp/docs/answer/IValueGroup.adoc create mode 100644 csharp/docs/answer/Promise__T__.adoc create mode 100644 csharp/docs/answer/VoidPromise.adoc create mode 100644 csharp/docs/concept/IConcept.adoc create mode 100644 csharp/docs/concept/IConceptManager.adoc create mode 100644 csharp/docs/concept/Transitivity.adoc create mode 100644 csharp/docs/connection/IDatabase.adoc create mode 100644 csharp/docs/connection/IDatabaseManager.adoc create mode 100644 csharp/docs/connection/IReplica.adoc create mode 100644 csharp/docs/connection/ITypeDBDriver.adoc create mode 100644 csharp/docs/connection/IUser.adoc create mode 100644 csharp/docs/connection/IUserManager.adoc create mode 100644 csharp/docs/connection/TypeDBCredential.adoc create mode 100644 csharp/docs/data/IAttribute.adoc create mode 100644 csharp/docs/data/IEntity.adoc create mode 100644 csharp/docs/data/IRelation.adoc create mode 100644 csharp/docs/data/IThing.adoc create mode 100644 csharp/docs/data/IValue.adoc create mode 100644 csharp/docs/data/ValueType.adoc create mode 100644 csharp/docs/errors/TypeDBDriverException.adoc create mode 100644 csharp/docs/logic/ILogicManager.adoc create mode 100644 csharp/docs/logic/IRule.adoc create mode 100644 csharp/docs/schema/Annotation.adoc create mode 100644 csharp/docs/schema/IAttributeType.adoc create mode 100644 csharp/docs/schema/IEntityType.adoc create mode 100644 csharp/docs/schema/IRelationType.adoc create mode 100644 csharp/docs/schema/IRoleType.adoc create mode 100644 csharp/docs/schema/IThingType.adoc create mode 100644 csharp/docs/schema/IType.adoc create mode 100644 csharp/docs/schema/Label.adoc create mode 100644 csharp/docs/session/ITypeDBSession.adoc create mode 100644 csharp/docs/session/SessionType.adoc create mode 100644 csharp/docs/session/TypeDBOptions.adoc create mode 100644 csharp/docs/transaction/IQueryManager.adoc create mode 100644 csharp/docs/transaction/ITypeDBTransaction.adoc create mode 100644 csharp/docs/transaction/TransactionType.adoc diff --git a/csharp/docs/answer/IConceptMap.adoc b/csharp/docs/answer/IConceptMap.adoc new file mode 100644 index 0000000000..7b166e7ce0 --- /dev/null +++ b/csharp/docs/answer/IConceptMap.adoc @@ -0,0 +1,89 @@ +[#_IConceptMap] +=== IConceptMap + +*Package*: `TypeDB.Driver.Api` + + + +Contains a mapping of variables to concepts. + +// tag::methods[] +[#_IConcept_TypeDB_Driver_Api_IConceptMap_Get___string_variable_] +==== Get + +[source,csharp] +---- +IConcept Get(string variable) +---- + + + +Retrieves a concept for a given variable name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `variable` a| The string representation of a variable a| +|=== + +[caption=""] +.Returns +`IConcept` + +[#_IEnumerable__IConcept___TypeDB_Driver_Api_IConceptMap_GetConcepts___] +==== GetConcepts + +[source,csharp] +---- +IEnumerable< IConcept > GetConcepts() +---- + + + +Returns a collection of all concepts in this ``IConceptMap``. + + +[caption=""] +.Returns +`IEnumerable< IConcept >` + +[#_Dictionary__string__IConcept___TypeDB_Driver_Api_IConceptMap_GetMap___] +==== GetMap + +[source,csharp] +---- +Dictionary< string, IConcept > GetMap() +---- + + + +Returns the inner ``Dictionary`` (``Map`` as a common TypeDB term) where keys are query variables, and values are concepts. + + +[caption=""] +.Returns +`Dictionary< string, IConcept >` + +[#_IEnumerable__string___TypeDB_Driver_Api_IConceptMap_GetVariables___] +==== GetVariables + +[source,csharp] +---- +IEnumerable< string > GetVariables() +---- + + + +Returns a collection of all variables in this ``IConceptMap``. + + +[caption=""] +.Returns +`IEnumerable< string >` + +// end::methods[] + diff --git a/csharp/docs/answer/IConceptMapGroup.adoc b/csharp/docs/answer/IConceptMapGroup.adoc new file mode 100644 index 0000000000..9d9a151bfc --- /dev/null +++ b/csharp/docs/answer/IConceptMapGroup.adoc @@ -0,0 +1,29 @@ +[#_IConceptMapGroup] +=== IConceptMapGroup + +*Package*: `TypeDB.Driver.Api` + + + +Contains an element of the group query result. + +// tag::methods[] +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IConceptMapGroup_GetConceptMaps___] +==== GetConceptMaps + +[source,csharp] +---- +IEnumerable< IConceptMap > GetConceptMaps() +---- + + + +Retrieves the ``IConceptMap``s of the group. + + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +// end::methods[] + diff --git a/csharp/docs/answer/IExplainable.adoc b/csharp/docs/answer/IExplainable.adoc new file mode 100644 index 0000000000..98ec92193b --- /dev/null +++ b/csharp/docs/answer/IExplainable.adoc @@ -0,0 +1,9 @@ +[#_IExplainable] +=== IExplainable + +*Package*: `TypeDB.Driver.Api.IConceptMap` + + + +Contains an explainable object. + diff --git a/csharp/docs/answer/IExplainables.adoc b/csharp/docs/answer/IExplainables.adoc new file mode 100644 index 0000000000..2338ec484f --- /dev/null +++ b/csharp/docs/answer/IExplainables.adoc @@ -0,0 +1,142 @@ +[#_IExplainables] +=== IExplainables + +*Package*: `TypeDB.Driver.Api.IConceptMap` + + + +Contains explainable objects. + +// tag::methods[] +[#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Attribute___string_variable_] +==== Attribute + +[source,csharp] +---- +IExplainable Attribute(string variable) +---- + + + +Retrieves the explainable attribute with the given variable name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `variable` a| The string representation of a variable a| +|=== + +[caption=""] +.Returns +`IExplainable` + +[#_IEnumerable__KeyValuePair__string__IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetAttributes___] +==== GetAttributes + +[source,csharp] +---- +IEnumerable< KeyValuePair< string, IExplainable > > GetAttributes() +---- + + + +Retrieves all of this ``IConceptMap``’s explainable attributes. + + +[caption=""] +.Returns +`IEnumerable< KeyValuePair< string, IExplainable > >` + +[#_IEnumerable__KeyValuePair__KeyValuePair__string__string____IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetOwnerships___] +==== GetOwnerships + +[source,csharp] +---- +IEnumerable< KeyValuePair< KeyValuePair< string, string >, IExplainable > > GetOwnerships() +---- + + + +Retrieves all of this ``IConceptMap``’s explainable ownerships. + + +[caption=""] +.Returns +`IEnumerable< KeyValuePair< KeyValuePair< string, string >, IExplainable > >` + +[#_IEnumerable__KeyValuePair__string__IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetRelations___] +==== GetRelations + +[source,csharp] +---- +IEnumerable< KeyValuePair< string, IExplainable > > GetRelations() +---- + + + +Retrieves all of this ``IConceptMap``’s explainable relations. + + +[caption=""] +.Returns +`IEnumerable< KeyValuePair< string, IExplainable > >` + +[#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Ownership___string_owner__string_attribute_] +==== Ownership + +[source,csharp] +---- +IExplainable Ownership(string owner, string attribute) +---- + + + +Retrieves the explainable attribute ownership with the pair of (owner, attribute) variable names. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `owner` a| The string representation of the owner variable a| +a| `attribute` a| The string representation of the attribute variable a| +|=== + +[caption=""] +.Returns +`IExplainable` + +[#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Relation___string_variable_] +==== Relation + +[source,csharp] +---- +IExplainable Relation(string variable) +---- + + + +Retrieves the explainable relation with the given variable name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `variable` a| The string representation of a variable a| +|=== + +[caption=""] +.Returns +`IExplainable` + +// end::methods[] + diff --git a/csharp/docs/answer/IExplanation.adoc b/csharp/docs/answer/IExplanation.adoc new file mode 100644 index 0000000000..a394f9d7f7 --- /dev/null +++ b/csharp/docs/answer/IExplanation.adoc @@ -0,0 +1,55 @@ +[#_IExplanation] +=== IExplanation + +*Package*: `TypeDB.Driver.Api` + + + +An explanation of which rule was used for inferring the explained concept, the condition of the rule, the conclusion of the rule, and the mapping of variables between the query and the rule’s conclusion. + +// tag::methods[] +[#_ISet__string___TypeDB_Driver_Api_IExplanation_GetQueryVariables___] +==== GetQueryVariables + +[source,csharp] +---- +ISet< string > GetQueryVariables() +---- + + + +Retrieves the query variables for this ``Explanation``. + + +[caption=""] +.Returns +`ISet< string >` + +[#_ISet__string___TypeDB_Driver_Api_IExplanation_QueryVariableMapping___string_variable_] +==== QueryVariableMapping + +[source,csharp] +---- +ISet< string > QueryVariableMapping(string variable) +---- + + + +Retrieves the rule variables corresponding to the query variable var for this ``Explanation``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `variable` a| The query variable to map to rule variables. a| +|=== + +[caption=""] +.Returns +`ISet< string >` + +// end::methods[] + diff --git a/csharp/docs/answer/IValueGroup.adoc b/csharp/docs/answer/IValueGroup.adoc new file mode 100644 index 0000000000..1731be72fc --- /dev/null +++ b/csharp/docs/answer/IValueGroup.adoc @@ -0,0 +1,9 @@ +[#_IValueGroup] +=== IValueGroup + +*Package*: `TypeDB.Driver.Api` + + + +Contains an element of the group aggregate query result. + diff --git a/csharp/docs/answer/Promise__T__.adoc b/csharp/docs/answer/Promise__T__.adoc new file mode 100644 index 0000000000..e5fc0c6058 --- /dev/null +++ b/csharp/docs/answer/Promise__T__.adoc @@ -0,0 +1,86 @@ +[#_Promise__T_] +=== Promise< T > + +*Package*: `TypeDB.Driver.Common` + + + +A ``Promise`` represents an asynchronous network operation. + +The request it represents is performed immediately. The response is only retrieved once the ``Promise`` is ``Resolve``d. + +. + +// tag::methods[] +[#_static_Promise__TTo___TypeDB_Driver_Common_Promise__T___Map__TFrom__TTo_____Func__TFrom__resolver__Func__TFrom__TTo___selector_] +==== Map< TFrom, TTo > + +[source,csharp] +---- +static Promise< TTo > TypeDB.Driver.Common.Promise< T >.Map< TFrom, TTo >(Func< TFrom?> resolver, Func< TFrom, TTo > selector) +---- + + + +Helper function to map promises. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `promise` a| The function to wrap into the promise a| +a| `fn` a| The mapping function a| +|=== + +[caption=""] +.Returns +`static Promise< TTo >` + +[#_TypeDB_Driver_Common_Promise__T___Promise___Func__T__resolver_] +==== Promise + +[source,csharp] +---- +TypeDB.Driver.Common.Promise< T Promise(Func< T?> resolver) +---- + + + +Promise constructor + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `promise` a| The function to wrap into the promise a| +|=== + +[caption=""] +.Returns +`TypeDB.Driver.Common.Promise< T` + +[#_T_TypeDB_Driver_Common_Promise__T___Resolve___] +==== Resolve + +[source,csharp] +---- +T? TypeDB.Driver.Common.Promise< T Resolve() +---- + + + +Retrieves the result of the Promise. + + +[caption=""] +.Returns +`T? TypeDB.Driver.Common.Promise< T` + +// end::methods[] + diff --git a/csharp/docs/answer/VoidPromise.adoc b/csharp/docs/answer/VoidPromise.adoc new file mode 100644 index 0000000000..35c124e901 --- /dev/null +++ b/csharp/docs/answer/VoidPromise.adoc @@ -0,0 +1,63 @@ +[#_VoidPromise] +=== VoidPromise + +*Package*: `TypeDB.Driver.Common` + + + +A ``VoidPromise`` represents a ``Promise`` without an operation's result. + + + See also + + + Promise + + + +// tag::methods[] +[#_void_TypeDB_Driver_Common_VoidPromise_Resolve___] +==== Resolve + +[source,csharp] +---- +void Resolve() +---- + + + +Retrieves the result of the Promise. + + +[caption=""] +.Returns +`void` + +[#_TypeDB_Driver_Common_VoidPromise_VoidPromise___Action_resolver_] +==== VoidPromise + +[source,csharp] +---- +VoidPromise(Action resolver) +---- + + + +Promise constructor + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `promise` a| The function to wrap into the promise a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/concept/IConcept.adoc b/csharp/docs/concept/IConcept.adoc new file mode 100644 index 0000000000..1e3c0b2eaf --- /dev/null +++ b/csharp/docs/concept/IConcept.adoc @@ -0,0 +1,426 @@ +[#_IConcept] +=== IConcept + +*Package*: `TypeDB.Driver.Api` + +// tag::methods[] +[#_IAttribute_TypeDB_Driver_Api_IConcept_AsAttribute___] +==== AsAttribute + +[source,csharp] +---- +IAttribute AsAttribute() +---- + + + +Casts the concept to ``IAttribute``. + + +Implemented in TypeDB.Driver.Api.IAttribute. + +[caption=""] +.Returns +`IAttribute` + +[#_IAttributeType_TypeDB_Driver_Api_IConcept_AsAttributeType___] +==== AsAttributeType + +[source,csharp] +---- +IAttributeType AsAttributeType() +---- + + + +Casts the concept to ``IAttributeType``. + + +Implemented in TypeDB.Driver.Api.IAttributeType. + +[caption=""] +.Returns +`IAttributeType` + +[#_IEntity_TypeDB_Driver_Api_IConcept_AsEntity___] +==== AsEntity + +[source,csharp] +---- +IEntity AsEntity() +---- + + + +Casts the concept to ``IEntity``. + + +Implemented in TypeDB.Driver.Api.IEntity. + +[caption=""] +.Returns +`IEntity` + +[#_IEntityType_TypeDB_Driver_Api_IConcept_AsEntityType___] +==== AsEntityType + +[source,csharp] +---- +IEntityType AsEntityType() +---- + + + +Casts the concept to ``IEntityType``. + + +Implemented in TypeDB.Driver.Api.IEntityType. + +[caption=""] +.Returns +`IEntityType` + +[#_IRelation_TypeDB_Driver_Api_IConcept_AsRelation___] +==== AsRelation + +[source,csharp] +---- +IRelation AsRelation() +---- + + + +Casts the concept to ``IRelation``. + + +Implemented in TypeDB.Driver.Api.IRelation. + +[caption=""] +.Returns +`IRelation` + +[#_IRelationType_TypeDB_Driver_Api_IConcept_AsRelationType___] +==== AsRelationType + +[source,csharp] +---- +IRelationType AsRelationType() +---- + + + +Casts the concept to ``IRelationType``. + + +Implemented in TypeDB.Driver.Api.IRelationType. + +[caption=""] +.Returns +`IRelationType` + +[#_IRoleType_TypeDB_Driver_Api_IConcept_AsRoleType___] +==== AsRoleType + +[source,csharp] +---- +IRoleType AsRoleType() +---- + + + +Casts the concept to ``IRoleType``. + + +Implemented in TypeDB.Driver.Api.IRoleType. + +[caption=""] +.Returns +`IRoleType` + +[#_IThing_TypeDB_Driver_Api_IConcept_AsThing___] +==== AsThing + +[source,csharp] +---- +IThing AsThing() +---- + + + +Casts the concept to ``IThing``. + + +Implemented in TypeDB.Driver.Api.IThing. + +[caption=""] +.Returns +`IThing` + +[#_IThingType_TypeDB_Driver_Api_IConcept_AsThingType___] +==== AsThingType + +[source,csharp] +---- +IThingType AsThingType() +---- + + + +Casts the concept to ``IThingType``. + + +Implemented in TypeDB.Driver.Api.IThingType. + +[caption=""] +.Returns +`IThingType` + +[#_IType_TypeDB_Driver_Api_IConcept_AsType___] +==== AsType + +[source,csharp] +---- +IType AsType() +---- + + + +Casts the concept to ``IType``. + + +Implemented in TypeDB.Driver.Api.IType. + +[caption=""] +.Returns +`IType` + +[#_IValue_TypeDB_Driver_Api_IConcept_AsValue___] +==== AsValue + +[source,csharp] +---- +IValue AsValue() +---- + + + +Casts the concept to ``IValue``. + + +Implemented in TypeDB.Driver.Api.IValue. + +[caption=""] +.Returns +`IValue` + +[#_bool_TypeDB_Driver_Api_IConcept_IsAttribute___] +==== IsAttribute + +[source,csharp] +---- +bool IsAttribute() +---- + + + +Checks if the concept is an ``IAttribute``. + + +Implemented in TypeDB.Driver.Api.IAttribute. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsAttributeType___] +==== IsAttributeType + +[source,csharp] +---- +bool IsAttributeType() +---- + + + +Checks if the concept is an ``IAttributeType``. + + +Implemented in TypeDB.Driver.Api.IAttributeType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsEntity___] +==== IsEntity + +[source,csharp] +---- +bool IsEntity() +---- + + + +Checks if the concept is an ``IEntity``. + + +Implemented in TypeDB.Driver.Api.IEntity. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsEntityType___] +==== IsEntityType + +[source,csharp] +---- +bool IsEntityType() +---- + + + +Checks if the concept is an ``IEntityType``. + + +Implemented in TypeDB.Driver.Api.IEntityType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsRelation___] +==== IsRelation + +[source,csharp] +---- +bool IsRelation() +---- + + + +Checks if the concept is a ``IRelation``. + + +Implemented in TypeDB.Driver.Api.IRelation. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsRelationType___] +==== IsRelationType + +[source,csharp] +---- +bool IsRelationType() +---- + + + +Checks if the concept is a ``IRelationType``. + + +Implemented in TypeDB.Driver.Api.IRelationType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsRoleType___] +==== IsRoleType + +[source,csharp] +---- +bool IsRoleType() +---- + + + +Checks if the concept is a ``IRoleType``. + + +Implemented in TypeDB.Driver.Api.IRoleType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsThing___] +==== IsThing + +[source,csharp] +---- +bool IsThing() +---- + + + +Checks if the concept is a ``IThing``. + + +Implemented in TypeDB.Driver.Api.IThing. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsThingType___] +==== IsThingType + +[source,csharp] +---- +bool IsThingType() +---- + + + +Checks if the concept is a ``IThingType``. + + +Implemented in TypeDB.Driver.Api.IThingType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsType___] +==== IsType + +[source,csharp] +---- +bool IsType() +---- + + + +Checks if the concept is a ``IType``. + + +Implemented in TypeDB.Driver.Api.IType. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IConcept_IsValue___] +==== IsValue + +[source,csharp] +---- +bool IsValue() +---- + + + +Checks if the concept is a ``IValue``. + + +Implemented in TypeDB.Driver.Api.IValue. + +[caption=""] +.Returns +`bool` + +// end::methods[] + diff --git a/csharp/docs/concept/IConceptManager.adoc b/csharp/docs/concept/IConceptManager.adoc new file mode 100644 index 0000000000..eaf2ef1ee3 --- /dev/null +++ b/csharp/docs/concept/IConceptManager.adoc @@ -0,0 +1,264 @@ +[#_IConceptManager] +=== IConceptManager + +*Package*: `TypeDB.Driver.Api` + + + +Provides access for all Concept API methods. + +// tag::methods[] +[#_Promise__IAttribute___TypeDB_Driver_Api_IConceptManager_GetAttribute___string_iid_] +==== GetAttribute + +[source,csharp] +---- +Promise< IAttribute > GetAttribute(string iid) +---- + + + +Retrieves an ``IAttribute`` by its iid. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `iid` a| The iid of the ``Attribute`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttributeType___TypeDB_Driver_Api_IConceptManager_GetAttributeType___string_label_] +==== GetAttributeType + +[source,csharp] +---- +Promise< IAttributeType > GetAttributeType(string label) +---- + + + +Retrieves an ``IAttributeType`` by its label. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``AttributeType`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IAttributeType >` + +[#_Promise__IEntity___TypeDB_Driver_Api_IConceptManager_GetEntity___string_iid_] +==== GetEntity + +[source,csharp] +---- +Promise< IEntity > GetEntity(string iid) +---- + + + +Retrieves an ``IEntity`` by its iid. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `iid` a| The iid of the ``Entity`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IEntity >` + +[#_Promise__IEntityType___TypeDB_Driver_Api_IConceptManager_GetEntityType___string_label_] +==== GetEntityType + +[source,csharp] +---- +Promise< IEntityType > GetEntityType(string label) +---- + + + +Retrieves an ``IEntityType`` by its label. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``IEntityType`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IEntityType >` + +[#_Promise__IRelation___TypeDB_Driver_Api_IConceptManager_GetRelation___string_iid_] +==== GetRelation + +[source,csharp] +---- +Promise< IRelation > GetRelation(string iid) +---- + + + +Retrieves a ``IRelation`` by its iid. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `iid` a| The iid of the ``Relation`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IRelation >` + +[#_Promise__IRelationType___TypeDB_Driver_Api_IConceptManager_GetRelationType___string_label_] +==== GetRelationType + +[source,csharp] +---- +Promise< IRelationType > GetRelationType(string label) +---- + + + +Retrieves a ``IRelationType`` by its label. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``IRelationType`` to retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IRelationType >` + +[#_IList__TypeDBException___TypeDB_Driver_Api_IConceptManager_GetSchemaExceptions___] +==== GetSchemaExceptions + +[source,csharp] +---- +IList< TypeDBException > GetSchemaExceptions() +---- + + + +A list of all schema exceptions for the current transaction. + + +[caption=""] +.Returns +`IList< TypeDBException >` + +[#_Promise__IAttributeType___TypeDB_Driver_Api_IConceptManager_PutAttributeType___string_label__IValue_ValueType_valueType_] +==== PutAttributeType + +[source,csharp] +---- +Promise< IAttributeType > PutAttributeType(string label, IValue.ValueType valueType) +---- + + + +Creates a new ``IAttributeType`` if none exists with the given label, or retrieves the existing one. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``IAttributeType`` to create or retrieve. a| +a| `valueType` a| The value type of the ``IAttributeType`` to create. a| +|=== + +[caption=""] +.Returns +`Promise< IAttributeType >` + +[#_Promise__IEntityType___TypeDB_Driver_Api_IConceptManager_PutEntityType___string_label_] +==== PutEntityType + +[source,csharp] +---- +Promise< IEntityType > PutEntityType(string label) +---- + + + +Creates a new ``IEntityType`` if none exists with the given label, otherwise retrieves the existing one. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``IEntityType`` to create or retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IEntityType >` + +[#_Promise__IRelationType___TypeDB_Driver_Api_IConceptManager_PutRelationType___string_label_] +==== PutRelationType + +[source,csharp] +---- +Promise< IRelationType > PutRelationType(string label) +---- + + + +Creates a new ``IRelationType`` if none exists with the given label, otherwise retrieves the existing one. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the ``IRelationType`` to create or retrieve. a| +|=== + +[caption=""] +.Returns +`Promise< IRelationType >` + +// end::methods[] + diff --git a/csharp/docs/concept/Transitivity.adoc b/csharp/docs/concept/Transitivity.adoc new file mode 100644 index 0000000000..3dade242a9 --- /dev/null +++ b/csharp/docs/concept/Transitivity.adoc @@ -0,0 +1,29 @@ +[#_Transitivity] +=== Transitivity + +*Package*: `TypeDB.Driver.Api.IConcept` + + + +This class is used for specifying whether we need explicit or transitive subtyping, instances, etc. + + +[caption=""] +.Examples +[source,csharp] +---- +attributeType.GetOwners(transaction, annotation, Explicit); +---- + +[caption=""] +.Enum constants +// tag::enum_constants[] +[cols="~"] +[options="header"] +|=== +|Name +a| `Explicit` +a| `Transitive` +|=== +// end::enum_constants[] + diff --git a/csharp/docs/connection/IDatabase.adoc b/csharp/docs/connection/IDatabase.adoc new file mode 100644 index 0000000000..136e2e7812 --- /dev/null +++ b/csharp/docs/connection/IDatabase.adoc @@ -0,0 +1,93 @@ +[#_IDatabase] +=== IDatabase + +*Package*: `TypeDB.Driver.Api` + +// tag::methods[] +[#_void_TypeDB_Driver_Api_IDatabase_Delete___] +==== Delete + +[source,csharp] +---- +void Delete() +---- + + + +Deletes this database. + + +[caption=""] +.Returns +`void` + +[#_ISet__IReplica___TypeDB_Driver_Api_IDatabase_GetReplicas___] +==== GetReplicas + +[source,csharp] +---- +ISet< IReplica > GetReplicas() +---- + + + +Set of ``Replica`` instances for this database. Only works in TypeDB Cloud + + +[caption=""] +.Returns +`ISet< IReplica >` + +[#_string_TypeDB_Driver_Api_IDatabase_GetRuleSchema___] +==== GetRuleSchema + +[source,csharp] +---- +string GetRuleSchema() +---- + + + +The rules in the schema as a valid TypeQL define query string. + + +[caption=""] +.Returns +`string` + +[#_string_TypeDB_Driver_Api_IDatabase_GetSchema___] +==== GetSchema + +[source,csharp] +---- +string GetSchema() +---- + + + +A full schema text as a valid TypeQL define query string. + + +[caption=""] +.Returns +`string` + +[#_string_TypeDB_Driver_Api_IDatabase_GetTypeSchema___] +==== GetTypeSchema + +[source,csharp] +---- +string GetTypeSchema() +---- + + + +The types in the schema as a valid TypeQL define query string. + + +[caption=""] +.Returns +`string` + +// end::methods[] + diff --git a/csharp/docs/connection/IDatabaseManager.adoc b/csharp/docs/connection/IDatabaseManager.adoc new file mode 100644 index 0000000000..edfc57f4c7 --- /dev/null +++ b/csharp/docs/connection/IDatabaseManager.adoc @@ -0,0 +1,107 @@ +[#_IDatabaseManager] +=== IDatabaseManager + +*Package*: `TypeDB.Driver.Api` + + + +Provides access to all database management methods. + +// tag::methods[] +[#_bool_TypeDB_Driver_Api_IDatabaseManager_Contains___string_name_] +==== Contains + +[source,csharp] +---- +bool Contains(string name) +---- + + + +Checks if a database with the given name exists. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `name` a| The database name to be checked a| +|=== + +[caption=""] +.Returns +`bool` + +[#_void_TypeDB_Driver_Api_IDatabaseManager_Create___string_name_] +==== Create + +[source,csharp] +---- +void Create(string name) +---- + + + +Create a database with the given name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `name` a| The name of the database to be created a| +|=== + +[caption=""] +.Returns +`void` + +[#_IDatabase_TypeDB_Driver_Api_IDatabaseManager_Get___string_name_] +==== Get + +[source,csharp] +---- +IDatabase Get(string name) +---- + + + +Retrieve the database with the given name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `name` a| The name of the database to retrieve a| +|=== + +[caption=""] +.Returns +`IDatabase` + +[#_IList__IDatabase___TypeDB_Driver_Api_IDatabaseManager_GetAll___] +==== GetAll + +[source,csharp] +---- +IList< IDatabase > GetAll() +---- + + + +Retrieves all databases present on the TypeDB server. + + +[caption=""] +.Returns +`IList< IDatabase >` + +// end::methods[] + diff --git a/csharp/docs/connection/IReplica.adoc b/csharp/docs/connection/IReplica.adoc new file mode 100644 index 0000000000..aae081f027 --- /dev/null +++ b/csharp/docs/connection/IReplica.adoc @@ -0,0 +1,44 @@ +[#_IReplica] +=== IReplica + +*Package*: `TypeDB.Driver.Api.IDatabase` + + + +The metadata and state of an individual raft replica of a database. + +// tag::methods[] +[#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPreferred___] +==== IsPreferred + +[source,csharp] +---- +bool IsPreferred() +---- + + + +Checks whether this is the preferred replica of the raft cluster. If true, Operations which can be run on any replica will prefer to use this replica. + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPrimary___] +==== IsPrimary + +[source,csharp] +---- +bool IsPrimary() +---- + + + +Checks whether this is the primary replica of the raft cluster. + +[caption=""] +.Returns +`bool` + +// end::methods[] + diff --git a/csharp/docs/connection/ITypeDBDriver.adoc b/csharp/docs/connection/ITypeDBDriver.adoc new file mode 100644 index 0000000000..556c706291 --- /dev/null +++ b/csharp/docs/connection/ITypeDBDriver.adoc @@ -0,0 +1,111 @@ +[#_ITypeDBDriver] +=== ITypeDBDriver + +*Package*: `TypeDB.Driver.Api` + +// tag::methods[] +[#_void_TypeDB_Driver_Api_ITypeDBDriver_Close___] +==== Close + +[source,csharp] +---- +void Close() +---- + + + +Closes the driver. Before instantiating a new driver, the driver that’s currently open should first be closed. + + +[caption=""] +.Returns +`void` + +[#_IUser_TypeDB_Driver_Api_ITypeDBDriver_GetCurrentUser___] +==== GetCurrentUser + +[source,csharp] +---- +IUser GetCurrentUser() +---- + + + +Returns the logged-in user for the connection. Only for TypeDB Cloud. + + +[caption=""] +.Returns +`IUser` + +[#_bool_TypeDB_Driver_Api_ITypeDBDriver_IsOpen___] +==== IsOpen + +[source,csharp] +---- +bool IsOpen() +---- + + + +Checks whether this connection is presently open. + + +[caption=""] +.Returns +`bool` + +[#_ITypeDBSession_TypeDB_Driver_Api_ITypeDBDriver_Session___string_database__SessionType_type_] +==== Session + +[source,csharp] +---- +ITypeDBSession Session(string database, SessionType type) +---- + + + +Opens a session to the given database with default options. + + + See also + + + TypeDBDriver::Session(string, SessionType, TypeDBOptions); + + + +[caption=""] +.Returns +`ITypeDBSession` + +[#_ITypeDBSession_TypeDB_Driver_Api_ITypeDBDriver_Session___string_database__SessionType_type__TypeDBOptions_options_] +==== Session + +[source,csharp] +---- +ITypeDBSession Session(string database, SessionType type, TypeDBOptions options) +---- + + + +Opens a communication tunnel (session) to the given database on the running TypeDB server. For more information on the methods, available with sessions, see the ``ITypeDBSession`` section. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `database` a| The name of the database with which the session connects a| +a| `type` a| The type of session to be created (Data or Schema) a| +a| `options` a| ``TypeDBOptions`` for the session a| +|=== + +[caption=""] +.Returns +`ITypeDBSession` + +// end::methods[] + diff --git a/csharp/docs/connection/IUser.adoc b/csharp/docs/connection/IUser.adoc new file mode 100644 index 0000000000..8d978f17cc --- /dev/null +++ b/csharp/docs/connection/IUser.adoc @@ -0,0 +1,57 @@ +[#_IUser] +=== IUser + +*Package*: `TypeDB.Driver.Api` + + + +TypeDB user information + +// tag::methods[] +[#_void_TypeDB_Driver_Api_IUser_UpdatePassword___string_passwordOld__string_passwordNew_] +==== UpdatePassword + +[source,csharp] +---- +void UpdatePassword(string passwordOld, string passwordNew) +---- + + + +Updates the password for this user. + + + Parameters + + + + + + passwordOld + The current password of this user + + + passwordNew + The new password + + + + + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `passwordOld` a| The current password of this user a| +a| `passwordNew` a| The new password a| +|=== + +[caption=""] +.Returns +`void` + +// end::methods[] + diff --git a/csharp/docs/connection/IUserManager.adoc b/csharp/docs/connection/IUserManager.adoc new file mode 100644 index 0000000000..d9de8e084f --- /dev/null +++ b/csharp/docs/connection/IUserManager.adoc @@ -0,0 +1,161 @@ +[#_IUserManager] +=== IUserManager + +*Package*: `TypeDB.Driver.Api` + + + +Provides access to all user management methods. + +// tag::methods[] +[#_bool_TypeDB_Driver_Api_IUserManager_Contains___string_username_] +==== Contains + +[source,csharp] +---- +bool Contains(string username) +---- + + + +Checks if a user with the given name exists. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The user name to be checked a| +|=== + +[caption=""] +.Returns +`bool` + +[#_void_TypeDB_Driver_Api_IUserManager_Create___string_username__string_password_] +==== Create + +[source,csharp] +---- +void Create(string username, string password) +---- + + + +Creates a user with the given name & password. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to be created a| +a| `password` a| The password of the user to be created a| +|=== + +[caption=""] +.Returns +`void` + +[#_void_TypeDB_Driver_Api_IUserManager_Delete___string_username_] +==== Delete + +[source,csharp] +---- +void Delete(string username) +---- + + + +Deletes a user with the given name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to be deleted a| +|=== + +[caption=""] +.Returns +`void` + +[#_IUser_TypeDB_Driver_Api_IUserManager_Get___string_username_] +==== Get + +[source,csharp] +---- +IUser? Get(string username) +---- + + + +Retrieves a user with the given name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to retrieve a| +|=== + +[caption=""] +.Returns +`IUser?` + +[#_ISet__IUser___TypeDB_Driver_Api_IUserManager_GetAll___] +==== GetAll + +[source,csharp] +---- +ISet< IUser > GetAll() +---- + + + +Retrieves all users which exist on the TypeDB server. + + +[caption=""] +.Returns +`ISet< IUser >` + +[#_void_TypeDB_Driver_Api_IUserManager_SetPassword___string_username__string_password_] +==== SetPassword + +[source,csharp] +---- +void SetPassword(string username, string password) +---- + + + +Sets a new password for a user. This operation can only be performed by administrators. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to set the password of a| +a| `password` a| The new password a| +|=== + +[caption=""] +.Returns +`void` + +// end::methods[] + diff --git a/csharp/docs/connection/TypeDBCredential.adoc b/csharp/docs/connection/TypeDBCredential.adoc new file mode 100644 index 0000000000..c013370fa1 --- /dev/null +++ b/csharp/docs/connection/TypeDBCredential.adoc @@ -0,0 +1,118 @@ +[#_TypeDBCredential] +=== TypeDBCredential + +*Package*: `TypeDB.Driver.Api` + + + +User credentials and TLS encryption settings for connecting to TypeDB Cloud. + + +[caption=""] +.Examples +[source,csharp] +---- +// Creates a credential as above, but the connection will be made over TLS. +TypeDBCredential credential = new TypeDBCredential(username, password, true); + +// Creates a credential as above, but TLS will use the specified CA to authenticate server certificates. +TypeDBCredential credential = new TypeDBCredential(username, password, Path.of("path/to/ca-certificate.pem")); +---- + +// tag::methods[] +[#_TypeDB_Driver_Api_TypeDBCredential_TypeDBCredential___string_username__string_password__bool_tlsEnabled_] +==== TypeDBCredential + +[source,csharp] +---- +TypeDBCredential(string username, string password, bool tlsEnabled) +---- + + + + Parameters + + + + + + username + The name of the user to connect as + + + password + The password for the user + + + tlsEnabled + Specify whether the connection to TypeDB Cloud must be done over TLS + + + + + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to connect as a| +a| `password` a| The password for the user a| +a| `tlsEnabled` a| Specify whether the connection to TypeDB Cloud must be done over TLS a| +|=== + +[caption=""] +.Returns +`TypeDBCredential` + +[#_TypeDB_Driver_Api_TypeDBCredential_TypeDBCredential___string_username__string_password__string_tlsRootCAPath_] +==== TypeDBCredential + +[source,csharp] +---- +TypeDBCredential(string username, string password, string? tlsRootCAPath) +---- + + + + Parameters + + + + + + username + The name of the user to connect as + + + password + The password for the user + + + tlsRootCAPath + Path to the CA certificate to use for authenticating server certificates + + + + + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to connect as a| +a| `password` a| The password for the user a| +a| `tlsRootCAPath` a| Path to the CA certificate to use for authenticating server certificates a| +|=== + +[caption=""] +.Returns +`TypeDBCredential` + +// end::methods[] + diff --git a/csharp/docs/data/IAttribute.adoc b/csharp/docs/data/IAttribute.adoc new file mode 100644 index 0000000000..6a5e99e65c --- /dev/null +++ b/csharp/docs/data/IAttribute.adoc @@ -0,0 +1,110 @@ +[#_IAttribute] +=== IAttribute + +*Package*: `TypeDB.Driver.Api` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThing` +* `TypeDB.Driver.Api.IConcept` + + + +Attribute is an instance of the attribute type and has a value. This value is fixed and unique for every given instance of the attribute type. + +Attributes can be uniquely addressed by their type and value. + +// tag::methods[] +[#_IAttribute_IConcept__TypeDB_Driver_Api_IAttribute_AsAttribute___] +==== AsAttribute + +[source,csharp] +---- +IAttribute IConcept. AsAttribute() +---- + + + +Casts the concept to ``IAttribute``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IAttribute IConcept.` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IAttribute_GetOwners___ITypeDBTransaction_transaction_] +==== GetOwners + +[source,csharp] +---- +IEnumerable< IThing > GetOwners(ITypeDBTransaction transaction) +---- + + + +Retrieves the instances that own this ``IAttribute``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IAttribute_GetOwners___ITypeDBTransaction_transaction__IThingType_ownerType_] +==== GetOwners + +[source,csharp] +---- +IEnumerable< IThing > GetOwners(ITypeDBTransaction transaction, IThingType ownerType) +---- + + + +Retrieves the instances that own this ``IAttribute``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `ownerType` a| Filter results for only owners of the given type a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_bool_IConcept__TypeDB_Driver_Api_IAttribute_IsAttribute___] +==== IsAttribute + +[source,csharp] +---- +bool IConcept. IsAttribute() +---- + + + +Checks if the concept is an ``IAttribute``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +// end::methods[] + diff --git a/csharp/docs/data/IEntity.adoc b/csharp/docs/data/IEntity.adoc new file mode 100644 index 0000000000..596b57aaf5 --- /dev/null +++ b/csharp/docs/data/IEntity.adoc @@ -0,0 +1,55 @@ +[#_IEntity] +=== IEntity + +*Package*: `TypeDB.Driver.Api` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThing` +* `TypeDB.Driver.Api.IConcept` + + + +Instance of data of an entity type, representing a standalone object that exists in the data model independently. Entity does not have a value. It is usually addressed by its ownership over attribute instances and/or roles played in relation instances. + +// tag::methods[] +[#_IEntity_IConcept__TypeDB_Driver_Api_IEntity_AsEntity___] +==== AsEntity + +[source,csharp] +---- +IEntity IConcept. AsEntity() +---- + + + +Casts the concept to ``IEntity``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IEntity IConcept.` + +[#_bool_IConcept__TypeDB_Driver_Api_IEntity_IsEntity___] +==== IsEntity + +[source,csharp] +---- +bool IConcept. IsEntity() +---- + + + +Checks if the concept is an ``IEntity``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +// end::methods[] + diff --git a/csharp/docs/data/IRelation.adoc b/csharp/docs/data/IRelation.adoc new file mode 100644 index 0000000000..1875c1d0b6 --- /dev/null +++ b/csharp/docs/data/IRelation.adoc @@ -0,0 +1,190 @@ +[#_IRelation] +=== IRelation + +*Package*: `TypeDB.Driver.Api` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThing` +* `TypeDB.Driver.Api.IConcept` + + + +Relation is an instance of a relation type and can be uniquely addressed by a combination of its type, owned attributes and role players. + +// tag::methods[] +[#_VoidPromise_TypeDB_Driver_Api_IRelation_AddPlayer___ITypeDBTransaction_transaction__IRoleType_roleType__IThing_player_] +==== AddPlayer + +[source,csharp] +---- +VoidPromise AddPlayer(ITypeDBTransaction transaction, IRoleType roleType, IThing player) +---- + + + +Adds a new role player to play the given role in this ``IRelation``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleType` a| The role to be played by the ``player`` a| +a| `player` a| The thing to play the role a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_IRelation_IConcept__TypeDB_Driver_Api_IRelation_AsRelation___] +==== AsRelation + +[source,csharp] +---- +IRelation IConcept. AsRelation() +---- + + + +Casts the concept to ``IRelation``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IRelation IConcept.` + +[#_Dictionary__IRoleType__ICollection__IThing_____TypeDB_Driver_Api_IRelation_GetPlayers___ITypeDBTransaction_transaction_] +==== GetPlayers + +[source,csharp] +---- +Dictionary< IRoleType, ICollection< IThing > > GetPlayers(ITypeDBTransaction transaction) +---- + + + +Retrieves a mapping of all instances involved in the ``IRelation`` and the role each play. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Dictionary< IRoleType, ICollection< IThing > >` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IRelation_GetPlayersByRoleType___ITypeDBTransaction_transaction__params_IRoleType___roleTypes_] +==== GetPlayersByRoleType + +[source,csharp] +---- +IEnumerable< IThing > GetPlayersByRoleType(ITypeDBTransaction transaction, params IRoleType[] roleTypes) +---- + + + +Retrieves all role players of this ``IRelation``, optionally filtered by given role types. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleTypes` a| 0 or more role types a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelation_GetRelating___ITypeDBTransaction_transaction_] +==== GetRelating + +[source,csharp] +---- +IEnumerable< IRoleType > GetRelating(ITypeDBTransaction transaction) +---- + + + +Retrieves all role types currently played in this ``IRelation``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_bool_IConcept__TypeDB_Driver_Api_IRelation_IsRelation___] +==== IsRelation + +[source,csharp] +---- +bool IConcept. IsRelation() +---- + + + +Checks if the concept is a ``IRelation``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IRelation_RemovePlayer___ITypeDBTransaction_transaction__IRoleType_roleType__IThing_player_] +==== RemovePlayer + +[source,csharp] +---- +VoidPromise RemovePlayer(ITypeDBTransaction transaction, IRoleType roleType, IThing player) +---- + + + +Removes the association of the given instance that plays the given role in this ``IRelation``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleType` a| The role to no longer be played by the thing in this ``IRelation`` a| +a| `player` a| The instance to no longer play the role in this ``IRelation`` a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/data/IThing.adoc b/csharp/docs/data/IThing.adoc new file mode 100644 index 0000000000..73b20efbcd --- /dev/null +++ b/csharp/docs/data/IThing.adoc @@ -0,0 +1,280 @@ +[#_IThing] +=== IThing + +*Package*: `TypeDB.Driver.Api` + +*Supertypes:* + +* `TypeDB.Driver.Api.IConcept` + +// tag::methods[] +[#_IThing_IConcept__TypeDB_Driver_Api_IThing_AsThing___] +==== AsThing + +[source,csharp] +---- +IThing IConcept. AsThing() +---- + + + +Casts the concept to ``IThing``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IThing IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IThing_Delete___ITypeDBTransaction_transaction_] +==== Delete + +[source,csharp] +---- +VoidPromise Delete(ITypeDBTransaction transaction) +---- + + + +Deletes this ``IThing``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_IEnumerable__IAttribute___TypeDB_Driver_Api_IThing_GetHas___ITypeDBTransaction_transaction__params_IAttributeType___attributeTypes_] +==== GetHas + +[source,csharp] +---- +IEnumerable< IAttribute > GetHas(ITypeDBTransaction transaction, params IAttributeType[] attributeTypes) +---- + + + +Retrieves the ``IAttribute``s that this ``IThing`` owns, optionally filtered by ``IAttributeType``s. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attributeTypes` a| The ``IAttributeType``s to filter the attributes by a| +|=== + +[caption=""] +.Returns +`IEnumerable< IAttribute >` + +[#_IEnumerable__IAttribute___TypeDB_Driver_Api_IThing_GetHas___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] +==== GetHas + +[source,csharp] +---- +IEnumerable< IAttribute > GetHas(ITypeDBTransaction transaction, ICollection< Annotation > annotations) +---- + + + +Retrieves the ``IAttribute``s that this ``IThing`` owns, filtered by ``Annotation``s. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `annotations` a| Only retrieve attributes with all given ``Annotation``s a| +|=== + +[caption=""] +.Returns +`IEnumerable< IAttribute >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThing_GetPlaying___ITypeDBTransaction_transaction_] +==== GetPlaying + +[source,csharp] +---- +IEnumerable< IRoleType > GetPlaying(ITypeDBTransaction transaction) +---- + + + +Retrieves the roles that this ``IThing`` is currently playing. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_IEnumerable__IRelation___TypeDB_Driver_Api_IThing_GetRelations___ITypeDBTransaction_transaction__params_IRoleType___roleTypes_] +==== GetRelations + +[source,csharp] +---- +IEnumerable< IRelation > GetRelations(ITypeDBTransaction transaction, params IRoleType[] roleTypes) +---- + + + +Retrieves all the ``Relations`` which this ``IThing`` plays a role in, optionally filtered by one or more given roles. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleTypes` a| The array of roles to filter the relations by. a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRelation >` + +[#_Promise__bool___TypeDB_Driver_Api_IThing_IsDeleted___ITypeDBTransaction_transaction_] +==== IsDeleted + +[source,csharp] +---- +Promise< bool > IsDeleted(ITypeDBTransaction transaction) +---- + + + +Checks if this ``IThing`` is deleted. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< bool >` + +[#_bool_TypeDB_Driver_Api_IThing_IsInferred___] +==== IsInferred + +[source,csharp] +---- +bool IsInferred() +---- + + + +Checks if this ``IThing`` is inferred by a [Reasoning Rule]. + + +[caption=""] +.Returns +`bool` + +[#_bool_IConcept__TypeDB_Driver_Api_IThing_IsThing___] +==== IsThing + +[source,csharp] +---- +bool IConcept. IsThing() +---- + + + +Checks if the concept is a ``IThing``. + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IThing_SetHas___ITypeDBTransaction_transaction__IAttribute_attribute_] +==== SetHas + +[source,csharp] +---- +VoidPromise SetHas(ITypeDBTransaction transaction, IAttribute attribute) +---- + + + +Assigns an ``IAttribute`` to be owned by this ``IThing``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attribute` a| The ``IAttribute`` to be owned by this ``IThing``. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThing_UnsetHas___ITypeDBTransaction_transaction__IAttribute_attribute_] +==== UnsetHas + +[source,csharp] +---- +VoidPromise UnsetHas(ITypeDBTransaction transaction, IAttribute attribute) +---- + + + +Unassigns an ``IAttribute`` from this ``IThing``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attribute` a| The ``IAttribute`` to be disowned from this ``IThing``. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/data/IValue.adoc b/csharp/docs/data/IValue.adoc new file mode 100644 index 0000000000..c0686271c6 --- /dev/null +++ b/csharp/docs/data/IValue.adoc @@ -0,0 +1,241 @@ +[#_IValue] +=== IValue + +*Package*: `TypeDB.Driver.Api` + +*Supertypes:* + +* `TypeDB.Driver.Api.IConcept` + +// tag::methods[] +[#_bool_TypeDB_Driver_Api_IValue_AsBool___] +==== AsBool + +[source,csharp] +---- +bool AsBool() +---- + + + +Returns a ``bool`` value of this value concept. If the value has another type, raises an exception. + + +[caption=""] +.Returns +`bool` + +[#_System_DateTime_TypeDB_Driver_Api_IValue_AsDateTime___] +==== AsDateTime + +[source,csharp] +---- +System.DateTime AsDateTime() +---- + + + +Returns a ``datetime`` value of this value concept. This value contains raw date and time without considering your time zone (Kind = Unspecified). If the value has another type, raises an exception. + + +[caption=""] +.Returns +`System.DateTime` + +[#_double_TypeDB_Driver_Api_IValue_AsDouble___] +==== AsDouble + +[source,csharp] +---- +double AsDouble() +---- + + + +Returns a ``double`` value of this value concept. If the value has another type, raises an exception. + + +[caption=""] +.Returns +`double` + +[#_long_TypeDB_Driver_Api_IValue_AsLong___] +==== AsLong + +[source,csharp] +---- +long AsLong() +---- + + + +Returns a ``long`` value of this value concept. If the value has another type, raises an exception. + + +[caption=""] +.Returns +`long` + +[#_string_TypeDB_Driver_Api_IValue_AsString___] +==== AsString + +[source,csharp] +---- +string AsString() +---- + + + +Returns a ``string`` value of this value concept. If the value has another type, raises an exception. + + +[caption=""] +.Returns +`string` + +[#_object_TypeDB_Driver_Api_IValue_AsUntyped___] +==== AsUntyped + +[source,csharp] +---- +object AsUntyped() +---- + + + +Returns an untyped ``object`` value of this value concept. This is useful for value equality or printing without having to switch on the actual contained value. + + +[caption=""] +.Returns +`object` + +[#_IValue_IConcept__TypeDB_Driver_Api_IValue_AsValue___] +==== AsValue + +[source,csharp] +---- +IValue IConcept. AsValue() +---- + + + +Casts the concept to ``IValue``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IValue IConcept.` + +[#_bool_TypeDB_Driver_Api_IValue_IsBool___] +==== IsBool + +[source,csharp] +---- +bool IsBool() +---- + + + +Returns ``True`` if the value which this value concept holds is of type ``bool``. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IValue_IsDateTime___] +==== IsDateTime + +[source,csharp] +---- +bool IsDateTime() +---- + + + +Returns ``True`` if the value which this value concept holds is of type ``datetime``. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IValue_IsDouble___] +==== IsDouble + +[source,csharp] +---- +bool IsDouble() +---- + + + +Returns ``True`` if the value which this value concept holds is of type ``double``. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IValue_IsLong___] +==== IsLong + +[source,csharp] +---- +bool IsLong() +---- + + + +Returns ``True`` if the value which this value concept holds is of type ``long``. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IValue_IsString___] +==== IsString + +[source,csharp] +---- +bool IsString() +---- + + + +Returns ``True`` if the value which this value concept holds is of type ``string``. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`bool` + +[#_bool_IConcept__TypeDB_Driver_Api_IValue_IsValue___] +==== IsValue + +[source,csharp] +---- +bool IConcept. IsValue() +---- + + + +Checks if the concept is a ``IValue``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +// end::methods[] + diff --git a/csharp/docs/data/ValueType.adoc b/csharp/docs/data/ValueType.adoc new file mode 100644 index 0000000000..f8c48e0115 --- /dev/null +++ b/csharp/docs/data/ValueType.adoc @@ -0,0 +1,33 @@ +[#_ValueType] +=== ValueType + +*Package*: `TypeDB.Driver.Api.IValue` + + + +Used to specify the type of the value. + + +[caption=""] +.Examples +[source,csharp] +---- +thingType.GetOwns(transaction, IValue.ValueType.String); +---- + +[caption=""] +.Enum constants +// tag::enum_constants[] +[cols="~"] +[options="header"] +|=== +|Name +a| `Bool` +a| `DateTime` +a| `Double` +a| `Long` +a| `Object` +a| `String` +|=== +// end::enum_constants[] + diff --git a/csharp/docs/errors/TypeDBDriverException.adoc b/csharp/docs/errors/TypeDBDriverException.adoc new file mode 100644 index 0000000000..07d6e293c4 --- /dev/null +++ b/csharp/docs/errors/TypeDBDriverException.adoc @@ -0,0 +1,93 @@ +[#_TypeDBDriverException] +=== TypeDBDriverException + +*Package*: `TypeDB.Driver.Common` + + + +Exceptions raised by the driver. + +// tag::methods[] +[#_bool_TypeDB_Driver_Common_TypeDBDriverException_Contains___string_subString_] +==== Contains + +[source,csharp] +---- +bool Contains(string subString) +---- + + + +Checks whether a substring is a part of this exception's message. + + +[caption=""] +.Returns +`bool` + +[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___ErrorMessage_error__params_object___errorParams_] +==== TypeDBDriverException + +[source,csharp] +---- +TypeDBDriverException(ErrorMessage error, params object?[] errorParams) +---- + + + +@hidden + +[caption=""] +.Returns +`TypeDBDriverException` + +[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___string_message_] +==== TypeDBDriverException + +[source,csharp] +---- +TypeDBDriverException(string message) +---- + + + +@hidden + +[caption=""] +.Returns +`TypeDBDriverException` + +[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___SystemException_error_] +==== TypeDBDriverException + +[source,csharp] +---- +TypeDBDriverException(System::Exception error) +---- + + + +@hidden + +[caption=""] +.Returns +`TypeDBDriverException` + +[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___PinvokeError_nativeError_] +==== TypeDBDriverException + +[source,csharp] +---- +TypeDBDriverException(Pinvoke::Error nativeError) +---- + + + +@hidden + +[caption=""] +.Returns +`TypeDBDriverException` + +// end::methods[] + diff --git a/csharp/docs/logic/ILogicManager.adoc b/csharp/docs/logic/ILogicManager.adoc new file mode 100644 index 0000000000..e1fe1373b2 --- /dev/null +++ b/csharp/docs/logic/ILogicManager.adoc @@ -0,0 +1,83 @@ +[#_ILogicManager] +=== ILogicManager + +*Package*: `TypeDB.Driver.Api` + + + +Provides methods for manipulating rules in the database. + +// tag::methods[] +[#_Promise__IRule___TypeDB_Driver_Api_ILogicManager_GetRule___string_label_] +==== GetRule + +[source,csharp] +---- +Promise< IRule > GetRule(string label) +---- + + + +Retrieves the Rule that has the given label. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the Rule to create or retrieve a| +|=== + +[caption=""] +.Returns +`Promise< IRule >` + +[#_IEnumerable__IRule___TypeDB_Driver_Api_ILogicManager_GetRules___] +==== GetRules + +[source,csharp] +---- +IEnumerable< IRule > GetRules() +---- + + + +Retrieves all rules. + + +[caption=""] +.Returns +`IEnumerable< IRule >` + +[#_Promise__IRule___TypeDB_Driver_Api_ILogicManager_PutRule___string_label__string_when__string_then_] +==== PutRule + +[source,csharp] +---- +Promise< IRule > PutRule(string label, string when, string then) +---- + + + +Creates a new Rule if none exists with the given label, or replaces the existing one. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the IRule to create or replace a| +a| `when` a| The when body of the rule to create a| +a| `then` a| The then body of the rule to create a| +|=== + +[caption=""] +.Returns +`Promise< IRule >` + +// end::methods[] + diff --git a/csharp/docs/logic/IRule.adoc b/csharp/docs/logic/IRule.adoc new file mode 100644 index 0000000000..519f08e2b6 --- /dev/null +++ b/csharp/docs/logic/IRule.adoc @@ -0,0 +1,91 @@ +[#_IRule] +=== IRule + +*Package*: `TypeDB.Driver.Api` + + + +Rules are a part of schema and define embedded logic. The reasoning engine uses rules as a set of logic to infer new data. A rule consists of a condition and a conclusion, and is uniquely identified by a label. + +// tag::methods[] +[#_VoidPromise_TypeDB_Driver_Api_IRule_Delete___ITypeDBTransaction_transaction_] +==== Delete + +[source,csharp] +---- +VoidPromise Delete(ITypeDBTransaction transaction) +---- + + + +Deletes this rule. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current ``Transaction`` a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_Promise__bool___TypeDB_Driver_Api_IRule_IsDeleted___ITypeDBTransaction_transaction_] +==== IsDeleted + +[source,csharp] +---- +Promise< bool > IsDeleted(ITypeDBTransaction transaction) +---- + + + +Check if this rule has been deleted. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current ``Transaction`` a| +|=== + +[caption=""] +.Returns +`Promise< bool >` + +[#_VoidPromise_TypeDB_Driver_Api_IRule_SetLabel___ITypeDBTransaction_transaction__string_label_] +==== SetLabel + +[source,csharp] +---- +VoidPromise SetLabel(ITypeDBTransaction transaction, string label) +---- + + + +Renames the label of the rule. The new label must remain unique. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current ``Transaction`` a| +a| `label` a| The new label to be given to the rule a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/schema/Annotation.adoc b/csharp/docs/schema/Annotation.adoc new file mode 100644 index 0000000000..af08651c30 --- /dev/null +++ b/csharp/docs/schema/Annotation.adoc @@ -0,0 +1,139 @@ +[#_Annotation] +=== Annotation + +*Package*: `TypeDB.Driver.Api.IThingType` + + + +Annotation + +// tag::methods[] +[#_override_bool_TypeDB_Driver_Api_IThingType_Annotation_Equals___object_obj_] +==== Equals + +[source,csharp] +---- +override bool Equals(object? obj) +---- + + + +Checks if this ``Annotation`` is equal to another object. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `obj` a| Object to compare with a| +|=== + +[caption=""] +.Returns +`override bool` + +[#_override_int_TypeDB_Driver_Api_IThingType_Annotation_GetHashCode___] +==== GetHashCode + +[source,csharp] +---- +override int GetHashCode() +---- + + + +@hidden + +[caption=""] +.Returns +`override int` + +[#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsKey___] +==== IsKey + +[source,csharp] +---- +bool IsKey() +---- + + + +Checks if this ``Annotation`` is a ``@key`` annotation. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsUnique___] +==== IsUnique + +[source,csharp] +---- +bool IsUnique() +---- + + + +Checks if this ``Annotation`` is a ``@unique`` annotation. + + +[caption=""] +.Returns +`bool` + +[#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewKey___] +==== NewKey + +[source,csharp] +---- +static Annotation NewKey() +---- + + + +Produces a ``@key`` annotation. + + +[caption=""] +.Returns +`static Annotation` + +[#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewUnique___] +==== NewUnique + +[source,csharp] +---- +static Annotation NewUnique() +---- + + + +Produces a ``@unique`` annotation. + + +[caption=""] +.Returns +`static Annotation` + +[#_override_string_TypeDB_Driver_Api_IThingType_Annotation_ToString___] +==== ToString + +[source,csharp] +---- +override string ToString() +---- + + + +Retrieves a string representation of this ``Annotation``. + + +[caption=""] +.Returns +`override string` + +// end::methods[] + diff --git a/csharp/docs/schema/IAttributeType.adoc b/csharp/docs/schema/IAttributeType.adoc new file mode 100644 index 0000000000..935795a1ae --- /dev/null +++ b/csharp/docs/schema/IAttributeType.adoc @@ -0,0 +1,746 @@ +[#_IAttributeType] +=== IAttributeType + +*Package*: `TypeDB.Driver.Api` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThingType` +* `TypeDB.Driver.Api.IType` +* `TypeDB.Driver.Api.IConcept` + + + +Attribute types represent properties that other types can own. + +IAttribute types have a value type. This value type is fixed and unique for every given instance of the attribute type. + +Other types can own an attribute type. That means that instances of these other types can own an instance of this attribute type. This usually means that an object in our domain has a property with the matching value. + +Multiple types can own the same attribute type, and different instances of the same type or different types can share ownership of the same attribute instance. + +// tag::methods[] +[#_IAttributeType_IConcept__TypeDB_Driver_Api_IAttributeType_AsAttributeType___] +==== AsAttributeType + +[source,csharp] +---- +IAttributeType IConcept. AsAttributeType() +---- + + + +Casts the concept to ``IAttributeType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IAttributeType IConcept.` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__IValue_value_] +==== Get + +[source,csharp] +---- +Promise< IAttribute > Get(ITypeDBTransaction transaction, IValue value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__string_value_] +==== Get + +[source,csharp] +---- +Promise< IAttribute > Get(ITypeDBTransaction transaction, string value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__long_value_] +==== Get + +[source,csharp] +---- +Promise< IAttribute > Get(ITypeDBTransaction transaction, long value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__double_value_] +==== Get + +[source,csharp] +---- +Promise< IAttribute > Get(ITypeDBTransaction transaction, double value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__bool_value_] +==== Get + +[source,csharp] +---- +Promise< IAttribute > Get(ITypeDBTransaction transaction, bool value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__System_DateTime_value_] +==== Get + +[source,csharp] +---- +Promise< IAttribute > Get(ITypeDBTransaction transaction, System.DateTime value) +---- + + + +Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if such ``IAttribute`` exists. Otherwise, returns ``None``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction_] +==== GetOwners + +[source,csharp] +---- +IEnumerable< IThingType > GetOwners(ITypeDBTransaction transaction) +---- + + + +Retrieve all ``Things`` that own an attribute of this ``IAttributeType`` directly or through inheritance. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] +==== GetOwners + +[source,csharp] +---- +IEnumerable< IThingType > GetOwners(ITypeDBTransaction transaction, ICollection< Annotation > annotations) +---- + + + +Retrieve all ``Things`` that own an attribute of this ``IAttributeType``, filtered by ``Annotation``s, directly or through inheritance. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``IAttributeType`` with all given ``Annotation``s a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetOwners + +[source,csharp] +---- +IEnumerable< IThingType > GetOwners(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieve all ``Things`` that own an attribute of this ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] +==== GetOwners + +[source,csharp] +---- +IEnumerable< IThingType > GetOwners(ITypeDBTransaction transaction, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) +---- + + + +Retrieve all ``Things`` that own an attribute of this ``IAttributeType``, filtered by ``Annotation``s. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``IAttributeType`` with all given ``Annotation``s a| +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_Promise__string___TypeDB_Driver_Api_IAttributeType_GetRegex___ITypeDBTransaction_transaction_] +==== GetRegex + +[source,csharp] +---- +Promise< string > GetRegex(ITypeDBTransaction transaction) +---- + + + +Retrieves the regular expression that is defined for this ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< string >` + +[#_IEnumerable__IType___TypeDB_Driver_Api_IAttributeType_GetSubtypes___ITypeDBTransaction_transaction__IValue_ValueType_valueType_] +==== GetSubtypes + +[source,csharp] +---- +IEnumerable< IType > GetSubtypes(ITypeDBTransaction transaction, IValue.ValueType valueType) +---- + + + +Retrieves all direct and indirect subtypes of this ``IAttributeType`` with given ``IValue.ValueType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| +|=== + +[caption=""] +.Returns +`IEnumerable< IType >` + +[#_IEnumerable__IType___TypeDB_Driver_Api_IAttributeType_GetSubtypes___ITypeDBTransaction_transaction__IValue_ValueType_valueType__IConcept_Transitivity_transitivity_] +==== GetSubtypes + +[source,csharp] +---- +IEnumerable< IType > GetSubtypes(ITypeDBTransaction transaction, IValue.ValueType valueType, IConcept.Transitivity transitivity) +---- + + + +Retrieves all direct and indirect (or direct only) subtypes of this ``IAttributeType`` with given ``IValue.ValueType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| +a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IType >` + +[#_bool_IConcept__TypeDB_Driver_Api_IAttributeType_IsAttributeType___] +==== IsAttributeType + +[source,csharp] +---- +bool IConcept. IsAttributeType() +---- + + + +Checks if the concept is an ``IAttributeType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_bool_TypeDB_Driver_Api_IAttributeType_IsBool___] +==== IsBool + +[source,csharp] +---- +bool IsBool() +---- + + + +Returns ``True`` if the value for attributes of this type is of type ``bool``. Otherwise, returns ``False``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IAttributeType_IsDateTime___] +==== IsDateTime + +[source,csharp] +---- +bool IsDateTime() +---- + + + +Returns ``True`` if the value for attributes of this type is of type ``datetime``. Otherwise, returns ``False``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IAttributeType_IsDouble___] +==== IsDouble + +[source,csharp] +---- +bool IsDouble() +---- + + + +Returns ``True`` if the value for attributes of this type is of type ``double``. Otherwise, returns ``False``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IAttributeType_IsLong___] +==== IsLong + +[source,csharp] +---- +bool IsLong() +---- + + + +Returns ``True`` if the value for attributes of this type is of type ``long``. Otherwise, returns ``False``. + + +[caption=""] +.Returns +`bool` + +[#_bool_TypeDB_Driver_Api_IAttributeType_IsString___] +==== IsString + +[source,csharp] +---- +bool IsString() +---- + + + +Returns ``True`` if the value for attributes of this type is of type ``string``. Otherwise, returns ``False``. + + +[caption=""] +.Returns +`bool` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__IValue_value_] +==== Put + +[source,csharp] +---- +Promise< IAttribute > Put(ITypeDBTransaction transaction, IValue value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given value. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__string_value_] +==== Put + +[source,csharp] +---- +Promise< IAttribute > Put(ITypeDBTransaction transaction, string value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``string`` value. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__long_value_] +==== Put + +[source,csharp] +---- +Promise< IAttribute > Put(ITypeDBTransaction transaction, long value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``long`` value. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__double_value_] +==== Put + +[source,csharp] +---- +Promise< IAttribute > Put(ITypeDBTransaction transaction, double value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``double`` value. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__bool_value_] +==== Put + +[source,csharp] +---- +Promise< IAttribute > Put(ITypeDBTransaction transaction, bool value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``bool`` value. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__System_DateTime_value_] +==== Put + +[source,csharp] +---- +Promise< IAttribute > Put(ITypeDBTransaction transaction, System.DateTime value) +---- + + + +Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``DateTime`` value. The input DateTime value is treated as timezone naive, with DateTimeKind being ignored. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `value` a| New ``IAttribute``’s value a| +|=== + +[caption=""] +.Returns +`Promise< IAttribute >` + +[#_VoidPromise_TypeDB_Driver_Api_IAttributeType_SetRegex___ITypeDBTransaction_transaction__string_regex_] +==== SetRegex + +[source,csharp] +---- +VoidPromise SetRegex(ITypeDBTransaction transaction, string regex) +---- + + + +Sets a regular expression as a constraint for this ``IAttributeType``. ``Values`` of all ``IAttribute``s of this type (inserted earlier or later) should match this regex. + +Can only be applied for ``IAttributeType``s with a ``string`` value type. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `regex` a| Regular expression a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IAttributeType_SetSupertype___ITypeDBTransaction_transaction__IAttributeType_attributeType_] +==== SetSupertype + +[source,csharp] +---- +VoidPromise SetSupertype(ITypeDBTransaction transaction, IAttributeType attributeType) +---- + + + +Sets the supplied ``IAttributeType`` as the supertype of the current ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attributeType` a| The ``IAttributeType`` to set as the supertype of this ``IAttributeType`` a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IAttributeType_UnsetRegex___ITypeDBTransaction_transaction_] +==== UnsetRegex + +[source,csharp] +---- +VoidPromise UnsetRegex(ITypeDBTransaction transaction) +---- + + + +Removes the regular expression that is defined for this ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/schema/IEntityType.adoc b/csharp/docs/schema/IEntityType.adoc new file mode 100644 index 0000000000..0eefd02558 --- /dev/null +++ b/csharp/docs/schema/IEntityType.adoc @@ -0,0 +1,113 @@ +[#_IEntityType] +=== IEntityType + +*Package*: `TypeDB.Driver.Api` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThingType` +* `TypeDB.Driver.Api.IType` +* `TypeDB.Driver.Api.IConcept` + + + +Entity types represent the classification of independent objects in the data model of the business domain. + +// tag::methods[] +[#_IEntityType_IConcept__TypeDB_Driver_Api_IEntityType_AsEntityType___] +==== AsEntityType + +[source,csharp] +---- +IEntityType IConcept. AsEntityType() +---- + + + +Casts the concept to ``IEntityType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IEntityType IConcept.` + +[#_Promise__IEntity___TypeDB_Driver_Api_IEntityType_Create___ITypeDBTransaction_transaction_] +==== Create + +[source,csharp] +---- +Promise< IEntity > Create(ITypeDBTransaction transaction) +---- + + + +Creates and returns a new instance of this ``IEntityType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< IEntity >` + +[#_bool_IConcept__TypeDB_Driver_Api_IEntityType_IsEntityType___] +==== IsEntityType + +[source,csharp] +---- +bool IConcept. IsEntityType() +---- + + + +Checks if the concept is an ``IEntityType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IEntityType_SetSupertype___ITypeDBTransaction_transaction__IEntityType_superEntityType_] +==== SetSupertype + +[source,csharp] +---- +VoidPromise SetSupertype(ITypeDBTransaction transaction, IEntityType superEntityType) +---- + + + +Sets the supplied ``IEntityType`` as the supertype of the current ``IEntityType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `superEntityType` a| The ``IEntityType`` to set as the supertype of this ``IEntityType`` a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/schema/IRelationType.adoc b/csharp/docs/schema/IRelationType.adoc new file mode 100644 index 0000000000..82ee806e57 --- /dev/null +++ b/csharp/docs/schema/IRelationType.adoc @@ -0,0 +1,369 @@ +[#_IRelationType] +=== IRelationType + +*Package*: `TypeDB.Driver.Api` + +*Supertypes:* + +* `TypeDB.Driver.Api.IThingType` +* `TypeDB.Driver.Api.IType` +* `TypeDB.Driver.Api.IConcept` + + + +Relation types (or subtypes of the relation root type) represent relationships between types. Relation types have roles. Other types can play roles in relations if it’s mentioned in their definition. A relation type must specify at least one role. + +// tag::methods[] +[#_IRelationType_IConcept__TypeDB_Driver_Api_IRelationType_AsRelationType___] +==== AsRelationType + +[source,csharp] +---- +IRelationType IConcept. AsRelationType() +---- + + + +Casts the concept to ``IRelationType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IRelationType IConcept.` + +[#_Promise__IRelation___TypeDB_Driver_Api_IRelationType_Create___ITypeDBTransaction_transaction_] +==== Create + +[source,csharp] +---- +Promise< IRelation > Create(ITypeDBTransaction transaction) +---- + + + +Creates and returns an instance of this ``IRelationType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< IRelation >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction_] +==== GetRelates + +[source,csharp] +---- +IEnumerable< IRoleType > GetRelates(ITypeDBTransaction transaction) +---- + + + +Retrieves roles that this ``IRelationType`` relates to directly or via inheritance. + + + See also + + + IRelationType::getRelates(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetRelates + +[source,csharp] +---- +IEnumerable< IRoleType > GetRelates(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves roles that this ``IRelationType`` relates to directly or via inheritance. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and inherited relates, ``Explicit`` for direct relates only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction__string_roleLabel_] +==== GetRelates + +[source,csharp] +---- +Promise< IRoleType > GetRelates(ITypeDBTransaction transaction, string roleLabel) +---- + + + +Retrieves roles that this ``IRelationType`` relates to directly or via inheritance. If ``role_label`` is given, returns a corresponding ``IRoleType`` or ``null``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleLabel` a| Label of the role we wish to retrieve a| +|=== + +[caption=""] +.Returns +`Promise< IRoleType >` + +[#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__IRoleType_roleType_] +==== GetRelatesOverridden + +[source,csharp] +---- +Promise< IRoleType > GetRelatesOverridden(ITypeDBTransaction transaction, IRoleType roleType) +---- + + + +Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label``. + + + See also + + + <<#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__string_roleLabel_,IRelationType::GetRelatesOverridden(ITypeDBTransaction, string)>> + + + +[caption=""] +.Returns +`Promise< IRoleType >` + +[#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__string_roleLabel_] +==== GetRelatesOverridden + +[source,csharp] +---- +Promise< IRoleType > GetRelatesOverridden(ITypeDBTransaction transaction, string roleLabel) +---- + + + +Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleLabel` a| Label of the role that overrides an inherited role a| +|=== + +[caption=""] +.Returns +`Promise< IRoleType >` + +[#_bool_IConcept__TypeDB_Driver_Api_IRelationType_IsRelationType___] +==== IsRelationType + +[source,csharp] +---- +bool IConcept. IsRelationType() +---- + + + +Checks if the concept is a ``IRelationType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel_] +==== SetRelates + +[source,csharp] +---- +VoidPromise SetRelates(ITypeDBTransaction transaction, string roleLabel) +---- + + + +Sets the new role that this ``IRelationType`` relates to. + + + See also + + + IRelationType::SetRelates(ITypeDBTransaction, string, string) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel__IRoleType_overriddenType_] +==== SetRelates + +[source,csharp] +---- +VoidPromise SetRelates(ITypeDBTransaction transaction, string roleLabel, IRoleType overriddenType) +---- + + + +Sets the new role that this ``IRelationType`` relates to. + + + See also + + + IRelationType::SetRelates(ITypeDBTransaction, string, string) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel__string_overriddenLabel_] +==== SetRelates + +[source,csharp] +---- +VoidPromise SetRelates(ITypeDBTransaction transaction, string roleLabel, string? overriddenLabel) +---- + + + +Sets the new role that this ``IRelationType`` relates to. If we are setting an overriding type this way, we have to also pass the overridden type as a second argument. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleLabel` a| The new role for the ``IRelationType`` to relate to a| +a| `overriddenLabel` a| The label being overridden, if applicable a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetSupertype___ITypeDBTransaction_transaction__IRelationType_superRelationType_] +==== SetSupertype + +[source,csharp] +---- +VoidPromise SetSupertype(ITypeDBTransaction transaction, IRelationType superRelationType) +---- + + + +Sets the supplied ``IRelationType`` as the supertype of the current ``IRelationType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `superRelationType` a| The ``IRelationType`` to set as the supertype of this ``IRelationType`` a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__IRoleType_roleType_] +==== UnsetRelates + +[source,csharp] +---- +VoidPromise UnsetRelates(ITypeDBTransaction transaction, IRoleType roleType) +---- + + + +Disallows this ``IRelationType`` from relating to the given role. + + + See also + + + <<#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__string_roleLabel_,IRelationType::UnsetRelates(ITypeDBTransaction, string)>> + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__string_roleLabel_] +==== UnsetRelates + +[source,csharp] +---- +VoidPromise UnsetRelates(ITypeDBTransaction transaction, string roleLabel) +---- + + + +Disallows this ``IRelationType`` from relating to the given role. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleLabel` a| The role to not relate to the relation type. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/schema/IRoleType.adoc b/csharp/docs/schema/IRoleType.adoc new file mode 100644 index 0000000000..c369e43b13 --- /dev/null +++ b/csharp/docs/schema/IRoleType.adoc @@ -0,0 +1,238 @@ +[#_IRoleType] +=== IRoleType + +*Package*: `TypeDB.Driver.Api` + +*Supertypes:* + +* `TypeDB.Driver.Api.IType` +* `TypeDB.Driver.Api.IConcept` + + + +Roles are special internal types used by relations. We can not create an instance of a role in a database. But we can set an instance of another type (role player) to play a role in a particular instance of a relation type. Roles allow a schema to enforce logical constraints on types of role players. + +// tag::methods[] +[#_IRoleType_IConcept__TypeDB_Driver_Api_IRoleType_AsRoleType___] +==== AsRoleType + +[source,csharp] +---- +IRoleType IConcept. AsRoleType() +---- + + + +Casts the concept to ``IRoleType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IRoleType IConcept.` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction_] +==== GetPlayerInstances + +[source,csharp] +---- +IEnumerable< IThing > GetPlayerInstances(ITypeDBTransaction transaction) +---- + + + +Retrieves the ``Thing`` instances that play this role. + + + See also + + + <<#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction_,IRoleType::GetPlayerInstances>>(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetPlayerInstances + +[source,csharp] +---- +IEnumerable< IThing > GetPlayerInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves the ``Thing`` instances that play this role. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction_] +==== GetPlayerTypes + +[source,csharp] +---- +IEnumerable< IThingType > GetPlayerTypes(ITypeDBTransaction transaction) +---- + + + +Retrieves the ``ThingType``s whose instances play this role. Equivalent to ``GetPlayerTypes(transaction, Transitive)``. + + + See also + + + <<#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction_,IRoleType::GetPlayerTypes>>(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetPlayerTypes + +[source,csharp] +---- +IEnumerable< IThingType > GetPlayerTypes(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves the ``ThingType``s whose instances play this role. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThingType >` + +[#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction_] +==== GetRelationInstances + +[source,csharp] +---- +IEnumerable< IRelation > GetRelationInstances(ITypeDBTransaction transaction) +---- + + + +Retrieves the ``Relation`` instances that this role is related to. Equivalent to ``GetRelationInstances(transaction, Transitive)`` + + + See also + + + <<#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction_,IRoleType::GetRelationInstances>>(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IRelation >` + +[#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetRelationInstances + +[source,csharp] +---- +IEnumerable< IRelation > GetRelationInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves the ``Relation`` instances that this role is related to. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and indirect relation, ``Explicit`` for direct relation only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRelation >` + +[#_IEnumerable__IRelationType___TypeDB_Driver_Api_IRoleType_GetRelationTypes___ITypeDBTransaction_transaction_] +==== GetRelationTypes + +[source,csharp] +---- +IEnumerable< IRelationType > GetRelationTypes(ITypeDBTransaction transaction) +---- + + + +Retrieves ``RelationType``s that this role is related to (directly or indirectly). + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRelationType >` + +[#_bool_IConcept__TypeDB_Driver_Api_IRoleType_IsRoleType___] +==== IsRoleType + +[source,csharp] +---- +bool IConcept. IsRoleType() +---- + + + +Checks if the concept is a ``IRoleType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +// end::methods[] + diff --git a/csharp/docs/schema/IThingType.adoc b/csharp/docs/schema/IThingType.adoc new file mode 100644 index 0000000000..e968da09c3 --- /dev/null +++ b/csharp/docs/schema/IThingType.adoc @@ -0,0 +1,693 @@ +[#_IThingType] +=== IThingType + +*Package*: `TypeDB.Driver.Api` + +*Supertypes:* + +* `TypeDB.Driver.Api.IType` +* `TypeDB.Driver.Api.IConcept` + +// tag::methods[] +[#_IThingType_IConcept__TypeDB_Driver_Api_IThingType_AsThingType___] +==== AsThingType + +[source,csharp] +---- +IThingType IConcept. AsThingType() +---- + + + +Casts the concept to ``IThingType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IThingType IConcept.` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IThingType_GetInstances___ITypeDBTransaction_transaction_] +==== GetInstances + +[source,csharp] +---- +IEnumerable< IThing > GetInstances(ITypeDBTransaction transaction) +---- + + + +Retrieves all ``IThing`` objects that are instances of this ``IThingType`` or its subtypes. Equivalent to ``GetInstances(transaction, Transitive)`` + + + See also + + + ThingType::GetInstances(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IThing___TypeDB_Driver_Api_IThingType_GetInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetInstances + +[source,csharp] +---- +IEnumerable< IThing > GetInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves ``IThing`` objects that are instances of this exact ``IThingType``, OR this ``IThingType`` and any of its subtypes + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Explicit`` for direct instances only, ``Transitive`` to include instances of subtypes a| +|=== + +[caption=""] +.Returns +`IEnumerable< IThing >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction_] +==== GetOwns + +[source,csharp] +---- +IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType_] +==== GetOwns + +[source,csharp] +---- +IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IValue.ValueType valueType) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] +==== GetOwns + +[source,csharp] +---- +IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, ICollection< Annotation > annotations) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__ICollection__Annotation___annotations_] +==== GetOwns + +[source,csharp] +---- +IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, ICollection< Annotation > annotations) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetOwns + +[source,csharp] +---- +IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__IConcept_Transitivity_transitivity_] +==== GetOwns + +[source,csharp] +---- +IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, IConcept.Transitivity transitivity) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] +==== GetOwns + +[source,csharp] +---- +IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + + See also + + + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] +==== GetOwns + +[source,csharp] +---- +IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) +---- + + + +Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `valueType` a| If specified, only attribute types of this ``ValueType`` will be retrieved. a| +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| +a| `annotations` a| Only retrieve attribute types owned with annotations. a| +|=== + +[caption=""] +.Returns +`IEnumerable< IAttributeType >` + +[#_Promise__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwnsOverridden___ITypeDBTransaction_transaction__IAttributeType_attributeType_] +==== GetOwnsOverridden + +[source,csharp] +---- +Promise< IAttributeType > GetOwnsOverridden(ITypeDBTransaction transaction, IAttributeType attributeType) +---- + + + +Retrieves an ``IAttributeType``, ownership of which is overridden for this ``IThingType`` by a given ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attributeType` a| The ``IAttributeType`` that overrides requested ``IAttributeType`` a| +|=== + +[caption=""] +.Returns +`Promise< IAttributeType >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThingType_GetPlays___ITypeDBTransaction_transaction_] +==== GetPlays + +[source,csharp] +---- +IEnumerable< IRoleType > GetPlays(ITypeDBTransaction transaction) +---- + + + +Retrieves all direct and inherited roles that are allowed to be played by the instances of this ``IThingType``. + + + See also + + + ThingType::GetPlays(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThingType_GetPlays___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetPlays + +[source,csharp] +---- +IEnumerable< IRoleType > GetPlays(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves all direct and inherited (or direct only) roles that are allowed to be played by the instances of this ``IThingType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| transitivity: ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IRoleType >` + +[#_Promise__IRoleType___TypeDB_Driver_Api_IThingType_GetPlaysOverridden___ITypeDBTransaction_transaction__IRoleType_roleType_] +==== GetPlaysOverridden + +[source,csharp] +---- +Promise< IRoleType > GetPlaysOverridden(ITypeDBTransaction transaction, IRoleType roleType) +---- + + + +Retrieves a ``IRoleType`` that is overridden by the given ``role_type`` for this ``IThingType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleType` a| The ``IRoleType`` that overrides an inherited role a| +|=== + +[caption=""] +.Returns +`Promise< IRoleType >` + +[#_Promise__string___TypeDB_Driver_Api_IThingType_GetSyntax___ITypeDBTransaction_transaction_] +==== GetSyntax + +[source,csharp] +---- +Promise< string > GetSyntax(ITypeDBTransaction transaction) +---- + + + +Produces a pattern for creating this ``IThingType`` in a ``define`` query. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< string >` + +[#_bool_IConcept__TypeDB_Driver_Api_IThingType_IsThingType___] +==== IsThingType + +[source,csharp] +---- +bool IConcept. IsThingType() +---- + + + +Checks if the concept is a ``IThingType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetAbstract___ITypeDBTransaction_transaction_] +==== SetAbstract + +[source,csharp] +---- +VoidPromise SetAbstract(ITypeDBTransaction transaction) +---- + + + +Set a ``IThingType`` to be abstract, meaning it cannot have instances. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__IAttributeType_overriddenType__ICollection__Annotation___annotations_] +==== SetOwns + +[source,csharp] +---- +VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, IAttributeType? overriddenType, ICollection< Annotation > annotations) +---- + + + +Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. Optionally, overriding a previously declared ownership. Optionally, adds annotations to the ownership. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attributeType` a| The ``IAttributeType`` to be owned by the instances of this type. a| +a| `overriddenType` a| The ``IAttributeType`` that this attribute ownership overrides, if applicable. a| +a| `annotations` a| Adds annotations to the ownership. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__IAttributeType_overriddenType_] +==== SetOwns + +[source,csharp] +---- +VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, IAttributeType overriddenType) +---- + + + +Allows the instances of this ``IThingType`` to own the given ``IAttributeType``, + + + See also + + + ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__ICollection__Annotation___annotations_] +==== SetOwns + +[source,csharp] +---- +VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, ICollection< Annotation > annotations) +---- + + + +Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. + + + See also + + + ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType_] +==== SetOwns + +[source,csharp] +---- +VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType) +---- + + + +Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. + + + See also + + + ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetPlays___ITypeDBTransaction_transaction__IRoleType_roleType_] +==== SetPlays + +[source,csharp] +---- +VoidPromise SetPlays(ITypeDBTransaction transaction, IRoleType roleType) +---- + + + +Allows the instances of this ``IThingType`` to play the given role. + + + See also + + + ThingType::SetPlays(ITypeDBTransaction, IRoleType, IRoleType) + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_SetPlays___ITypeDBTransaction_transaction__IRoleType_roleType__IRoleType_overriddenType_] +==== SetPlays + +[source,csharp] +---- +VoidPromise SetPlays(ITypeDBTransaction transaction, IRoleType roleType, IRoleType overriddenType) +---- + + + +Allows the instances of this ``IThingType`` to play the given role. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleType` a| The role to be played by the instances of this type a| +a| `overriddenType` a| The role type that this role overrides, if applicable a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetAbstract___ITypeDBTransaction_transaction_] +==== UnsetAbstract + +[source,csharp] +---- +VoidPromise UnsetAbstract(ITypeDBTransaction transaction) +---- + + + +Set a ``IThingType`` to be non-abstract, meaning it can have instances. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType_] +==== UnsetOwns + +[source,csharp] +---- +VoidPromise UnsetOwns(ITypeDBTransaction transaction, IAttributeType attributeType) +---- + + + +Disallows the instances of this ``IThingType`` from owning the given ``IAttributeType``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `attributeType` a| The ``IAttributeType`` to not be owned by the type. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetPlays___ITypeDBTransaction_transaction__IRoleType_roleType_] +==== UnsetPlays + +[source,csharp] +---- +VoidPromise UnsetPlays(ITypeDBTransaction transaction, IRoleType roleType) +---- + + + +Disallows the instances of this ``IThingType`` from playing the given role. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `roleType` a| The role to not be played by the instances of this type. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/schema/IType.adoc b/csharp/docs/schema/IType.adoc new file mode 100644 index 0000000000..c98ac38454 --- /dev/null +++ b/csharp/docs/schema/IType.adoc @@ -0,0 +1,270 @@ +[#_IType] +=== IType + +*Package*: `TypeDB.Driver.Api` + +*Supertypes:* + +* `TypeDB.Driver.Api.IConcept` + +// tag::methods[] +[#_IType_IConcept__TypeDB_Driver_Api_IType_AsType___] +==== AsType + +[source,csharp] +---- +IType IConcept. AsType() +---- + + + +Casts the concept to ``IType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`IType IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IType_Delete___ITypeDBTransaction_transaction_] +==== Delete + +[source,csharp] +---- +VoidPromise Delete(ITypeDBTransaction transaction) +---- + + + +Deletes this type from the database. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSubtypes___ITypeDBTransaction_transaction_] +==== GetSubtypes + +[source,csharp] +---- +IEnumerable< IType > GetSubtypes(ITypeDBTransaction transaction) +---- + + + +Retrieves all direct and indirect subtypes of the type. Equivalent to ``GetSubtypes(transaction, Transitive)`` + + + See also + + + Type::GetSubtypes(ITypeDBTransaction, IConcept.Transitivity) + + + +[caption=""] +.Returns +`IEnumerable< IType >` + +[#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSubtypes___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] +==== GetSubtypes + +[source,csharp] +---- +IEnumerable< IType > GetSubtypes(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) +---- + + + +Retrieves all direct and indirect (or direct only) subtypes of the type. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| +|=== + +[caption=""] +.Returns +`IEnumerable< IType >` + +[#_Promise__IType___TypeDB_Driver_Api_IType_GetSupertype___ITypeDBTransaction_transaction_] +==== GetSupertype + +[source,csharp] +---- +Promise< IType > GetSupertype(ITypeDBTransaction transaction) +---- + + + +Retrieves the most immediate supertype of the type. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< IType >` + +[#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSupertypes___ITypeDBTransaction_transaction_] +==== GetSupertypes + +[source,csharp] +---- +IEnumerable< IType > GetSupertypes(ITypeDBTransaction transaction) +---- + + + +Retrieves all supertypes of the type. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`IEnumerable< IType >` + +[#_bool_TypeDB_Driver_Api_IType_IsAbstract___] +==== IsAbstract + +[source,csharp] +---- +bool IsAbstract() +---- + + + +Checks if the type is prevented from having data instances (i.e., ``abstract``). + + +[caption=""] +.Returns +`bool` + +[#_Promise__bool___TypeDB_Driver_Api_IType_IsDeleted___ITypeDBTransaction_transaction_] +==== IsDeleted + +[source,csharp] +---- +Promise< bool > IsDeleted(ITypeDBTransaction transaction) +---- + + + +Check if the concept has been deleted. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +|=== + +[caption=""] +.Returns +`Promise< bool >` + +[#_bool_TypeDB_Driver_Api_IType_IsRoot___] +==== IsRoot + +[source,csharp] +---- +bool IsRoot() +---- + + + +Checks if the type is a root type. + + +[caption=""] +.Returns +`bool` + +[#_bool_IConcept__TypeDB_Driver_Api_IType_IsType___] +==== IsType + +[source,csharp] +---- +bool IConcept. IsType() +---- + + + +Checks if the concept is a ``IType``. + + + + +Implements TypeDB.Driver.Api.IConcept. + +[caption=""] +.Returns +`bool IConcept.` + +[#_VoidPromise_TypeDB_Driver_Api_IType_SetLabel___ITypeDBTransaction_transaction__string_label_] +==== SetLabel + +[source,csharp] +---- +VoidPromise SetLabel(ITypeDBTransaction transaction, string label) +---- + + + +Renames the label of the type. The new label must remain unique. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| +a| `label` a| The new ``Label`` to be given to the type. a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +// end::methods[] + diff --git a/csharp/docs/schema/Label.adoc b/csharp/docs/schema/Label.adoc new file mode 100644 index 0000000000..4ab4233409 --- /dev/null +++ b/csharp/docs/schema/Label.adoc @@ -0,0 +1,152 @@ +[#_Label] +=== Label + +*Package*: `TypeDB.Driver.Common` + + + +A ``Label`` holds the uniquely identifying name of a type. + +It consists of an optional ``scope``, and a ``name``, represented ``scope:name``. The scope is used only used to distinguish between role-types of the same name declared in different relation types. + +[caption=""] +.Fields +// tag::properties[] +[cols="~,~,~"] +[options="header"] +|=== +|Name |Type |Description +a| `readonly string TypeDB.Driver.Common.Label.Name` a| `readonly string TypeDB.Driver.Common.Label.Name` a| Returns the name of this Label. +Examples +[source,java] +---- +label.Name; + +---- + +a| `readonly? string TypeDB.Driver.Common.Label.Scope` a| `readonly? string TypeDB.Driver.Common.Label.Scope` a| Returns the scope of this Label. +Examples +[source,java] +---- +label.Scope; + +---- + +|=== +// end::properties[] + +// tag::methods[] +[#_override_bool_TypeDB_Driver_Common_Label_Equals___object_obj_] +==== Equals + +[source,csharp] +---- +override bool Equals(object? obj) +---- + + + +Checks if this Label is equal to another object. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `obj` a| Object to compare with a| +|=== + +[caption=""] +.Returns +`override bool` + +[#_override_int_TypeDB_Driver_Common_Label_GetHashCode___] +==== GetHashCode + +[source,csharp] +---- +override int GetHashCode() +---- + + + +@hidden + +[caption=""] +.Returns +`override int` + +[#_TypeDB_Driver_Common_Label_Label___string_scope__string_name_] +==== Label + +[source,csharp] +---- +Label(string? scope, string name) +---- + + + +Creates a Label from a specified scope and name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `scope` a| Label scope a| +a| `name` a| Label name a| +|=== + +[caption=""] +.Returns +`Label` + +[#_TypeDB_Driver_Common_Label_Label___string_name_] +==== Label + +[source,csharp] +---- +Label(string name) +---- + + + +Creates a Label from a specified name. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `name` a| Label name a| +|=== + +[caption=""] +.Returns +`Label` + +[#_override_string_TypeDB_Driver_Common_Label_ToString___] +==== ToString + +[source,csharp] +---- +override string ToString() +---- + + + +Returns the string representation of the scoped name. + + +[caption=""] +.Returns +`override string` + +// end::methods[] + diff --git a/csharp/docs/session/ITypeDBSession.adoc b/csharp/docs/session/ITypeDBSession.adoc new file mode 100644 index 0000000000..7791fc6a46 --- /dev/null +++ b/csharp/docs/session/ITypeDBSession.adoc @@ -0,0 +1,145 @@ +[#_ITypeDBSession] +=== ITypeDBSession + +*Package*: `TypeDB.Driver.Api` + +// tag::methods[] +[#_void_TypeDB_Driver_Api_ITypeDBSession_Close___] +==== Close + +[source,csharp] +---- +void Close() +---- + + + +Closes the session. Before opening a new session, the session currently open should first be closed. + + +[caption=""] +.Returns +`void` + +[#_bool_TypeDB_Driver_Api_ITypeDBSession_IsOpen___] +==== IsOpen + +[source,csharp] +---- +bool IsOpen() +---- + + + +Checks whether this session is open. + + +[caption=""] +.Returns +`bool` + +[#_void_TypeDB_Driver_Api_ITypeDBSession_OnClose___Action_function_] +==== OnClose + +[source,csharp] +---- +void OnClose(Action function) +---- + + + +Registers a callback function which will be executed when this session is closed. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `function` a| The callback function. a| +|=== + +[caption=""] +.Returns +`void` + +[#_void_TypeDB_Driver_Api_ITypeDBSession_OnReopen___Action_function_] +==== OnReopen + +[source,csharp] +---- +void OnReopen(Action function) +---- + + + +Registers a callback function which will be executed when this session is reopened. A session may be closed if it times out, or loses the connection to the database. In such situations, the session is reopened automatically when opening a new transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `function` a| The callback function. a| +|=== + +[caption=""] +.Returns +`void` + +[#_ITypeDBTransaction_TypeDB_Driver_Api_ITypeDBSession_Transaction___TransactionType_type_] +==== Transaction + +[source,csharp] +---- +ITypeDBTransaction Transaction(TransactionType type) +---- + + + +Opens a transaction on the database connected to the session with default options. + + + See also + + + ITypeDBSession::Transaction(TransactionType, TypeDBOptions) + + + +[caption=""] +.Returns +`ITypeDBTransaction` + +[#_ITypeDBTransaction_TypeDB_Driver_Api_ITypeDBSession_Transaction___TransactionType_type__TypeDBOptions_options_] +==== Transaction + +[source,csharp] +---- +ITypeDBTransaction Transaction(TransactionType type, TypeDBOptions options) +---- + + + +Opens a transaction to perform read or write queries on the database connected to the session. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `type` a| The type of transaction to be created (Read or Write) a| +a| `options` a| Options for the session a| +|=== + +[caption=""] +.Returns +`ITypeDBTransaction` + +// end::methods[] + diff --git a/csharp/docs/session/SessionType.adoc b/csharp/docs/session/SessionType.adoc new file mode 100644 index 0000000000..4f654782f8 --- /dev/null +++ b/csharp/docs/session/SessionType.adoc @@ -0,0 +1,29 @@ +[#_SessionType] +=== SessionType + +*Package*: `TypeDB.Driver.Api` + + + +Used to specify the type of the session. + + +[caption=""] +.Examples +[source,csharp] +---- +driver.Session(database, SessionType.Schema); +---- + +[caption=""] +.Enum constants +// tag::enum_constants[] +[cols="~"] +[options="header"] +|=== +|Name +a| `Data` +a| `Schema` +|=== +// end::enum_constants[] + diff --git a/csharp/docs/session/TypeDBOptions.adoc b/csharp/docs/session/TypeDBOptions.adoc new file mode 100644 index 0000000000..5ce607d6f3 --- /dev/null +++ b/csharp/docs/session/TypeDBOptions.adoc @@ -0,0 +1,459 @@ +[#_TypeDBOptions] +=== TypeDBOptions + +*Package*: `TypeDB.Driver.Api` + + + +TypeDB session and transaction options. ``TypeDBOptions`` object can be used to override the default server behaviour. + +// tag::methods[] +[#_bool_TypeDB_Driver_Api_TypeDBOptions_Explain___] +==== Explain + +[source,csharp] +---- +bool? Explain() +---- + + + +Returns the value set for the explanation in this ``TypeDBOptions`` object. If set to ``true``, explanations for queries are enabled. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Explain___bool_explain_] +==== Explain + +[source,csharp] +---- +TypeDBOptions Explain(bool explain) +---- + + + +Explicitly enables or disables explanations. If set to ``true``, enables explanations for queries. Only affects read transactions. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `explain` a| Explicitly enable or disable explanations a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_bool_TypeDB_Driver_Api_TypeDBOptions_Infer___] +==== Infer + +[source,csharp] +---- +bool? Infer() +---- + + + +Returns the value set for the inference in this ``TypeDBOptions`` object. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Infer___bool_infer_] +==== Infer + +[source,csharp] +---- +TypeDBOptions Infer(bool infer) +---- + + + +Explicitly enables or disables inference. Only settable at transaction level and above. Only affects read transactions. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `infer` a| Explicitly enable or disable inference a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_bool_TypeDB_Driver_Api_TypeDBOptions_Parallel___] +==== Parallel + +[source,csharp] +---- +bool? Parallel() +---- + + + +Returns the value set for the parallel execution in this ``TypeDBOptions`` object. If set to ``true``, the server uses parallel instead of single-threaded execution. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Parallel___bool_parallel_] +==== Parallel + +[source,csharp] +---- +TypeDBOptions Parallel(bool parallel) +---- + + + +Explicitly enables or disables parallel execution. If set to ``true``, the server uses parallel instead of single-threaded execution. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `parallel` a| Explicitly enable or disable parallel execution a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_bool_TypeDB_Driver_Api_TypeDBOptions_Prefetch___] +==== Prefetch + +[source,csharp] +---- +bool? Prefetch() +---- + + + +Returns the value set for the prefetching in this ``TypeDBOptions`` object. If set to ``true``, the first batch of answers is streamed to the driver even without an explicit request for it. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Prefetch___bool_prefetch_] +==== Prefetch + +[source,csharp] +---- +TypeDBOptions Prefetch(bool prefetch) +---- + + + +Explicitly enables or disables prefetching. If set to ``true``, the first batch of answers is streamed to the driver even without an explicit request for it. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `prefetch` a| Explicitly enable or disable prefetching a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_int_TypeDB_Driver_Api_TypeDBOptions_PrefetchSize___] +==== PrefetchSize + +[source,csharp] +---- +int? PrefetchSize() +---- + + + +Returns the value set for the prefetch size in this ``TypeDBOptions`` object. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request. + + +[caption=""] +.Returns +`int?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_PrefetchSize___int_prefetchSize_] +==== PrefetchSize + +[source,csharp] +---- +TypeDBOptions PrefetchSize(int prefetchSize) +---- + + + +Explicitly sets a prefetch size. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `prefetchSize` a| Number of answers that the server should send before the driver issues a fresh request a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_bool_TypeDB_Driver_Api_TypeDBOptions_ReadAnyReplica___] +==== ReadAnyReplica + +[source,csharp] +---- +bool? ReadAnyReplica() +---- + + + +Returns the value set for reading data from any replica in this ``TypeDBOptions`` object. If set to ``True``, enables reading data from any replica, potentially boosting read throughput. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_ReadAnyReplica___bool_readAnyReplica_] +==== ReadAnyReplica + +[source,csharp] +---- +TypeDBOptions ReadAnyReplica(bool readAnyReplica) +---- + + + +Explicitly enables or disables reading data from any replica. If set to ``True``, enables reading data from any replica, potentially boosting read throughput. Only settable in TypeDB Cloud. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `readAnyReplica` a| Explicitly enable or disable reading data from any replica a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_int_TypeDB_Driver_Api_TypeDBOptions_SchemaLockAcquireTimeoutMillis___] +==== SchemaLockAcquireTimeoutMillis + +[source,csharp] +---- +int? SchemaLockAcquireTimeoutMillis() +---- + + + +Returns the value set for the schema lock acquire timeout in this ``TypeDBOptions`` object. If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock. + + +[caption=""] +.Returns +`int?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_SchemaLockAcquireTimeoutMillis___int_schemaLockAcquireTimeoutMillis_] +==== SchemaLockAcquireTimeoutMillis + +[source,csharp] +---- +TypeDBOptions SchemaLockAcquireTimeoutMillis(int schemaLockAcquireTimeoutMillis) +---- + + + +Explicitly sets schema lock acquire timeout. If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `schemaLockAcquireTimeoutMillis` a| How long the driver should wait if opening a session or transaction is blocked by a schema write lock. a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_int_TypeDB_Driver_Api_TypeDBOptions_SessionIdleTimeoutMillis___] +==== SessionIdleTimeoutMillis + +[source,csharp] +---- +int? SessionIdleTimeoutMillis() +---- + + + +Returns the value set for the session idle timeout in this ``TypeDBOptions`` object. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. + + +[caption=""] +.Returns +`int?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_SessionIdleTimeoutMillis___int_sessionIdleTimeoutMillis_] +==== SessionIdleTimeoutMillis + +[source,csharp] +---- +TypeDBOptions SessionIdleTimeoutMillis(int sessionIdleTimeoutMillis) +---- + + + +Explicitly sets a session idle timeout. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `sessionIdleTimeoutMillis` a| timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_bool_TypeDB_Driver_Api_TypeDBOptions_TraceInference___] +==== TraceInference + +[source,csharp] +---- +bool? TraceInference() +---- + + + +Returns the value set for reasoning tracing in this ``TypeDBOptions`` object. If set to ``true``, reasoning tracing graphs are output in the logging directory. + + +[caption=""] +.Returns +`bool?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_TraceInference___bool_traceInference_] +==== TraceInference + +[source,csharp] +---- +TypeDBOptions TraceInference(bool traceInference) +---- + + + +Explicitly enables or disables reasoning tracing. If set to ``true``, reasoning tracing graphs are output in the logging directory. Should be used with ``parallel = False``. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `traceInference` a| Explicitly enable or disable reasoning tracing a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_int_TypeDB_Driver_Api_TypeDBOptions_TransactionTimeoutMillis___] +==== TransactionTimeoutMillis + +[source,csharp] +---- +int? TransactionTimeoutMillis() +---- + + + +Returns the value set for the transaction timeout in this ``TypeDBOptions`` object. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions. + + +[caption=""] +.Returns +`int?` + +[#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_TransactionTimeoutMillis___int_transactionTimeoutMillis_] +==== TransactionTimeoutMillis + +[source,csharp] +---- +TypeDBOptions TransactionTimeoutMillis(int transactionTimeoutMillis) +---- + + + +Explicitly set a transaction timeout. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `transactionTimeoutMillis` a| Timeout for killing transactions automatically. a| +|=== + +[caption=""] +.Returns +`TypeDBOptions` + +[#_TypeDB_Driver_Api_TypeDBOptions_TypeDBOptions___] +==== TypeDBOptions + +[source,csharp] +---- +TypeDBOptions() +---- + + + +Produces a new ``TypeDBOptions`` object. + + +[caption=""] +.Returns +`TypeDBOptions` + +// end::methods[] + diff --git a/csharp/docs/transaction/IQueryManager.adoc b/csharp/docs/transaction/IQueryManager.adoc new file mode 100644 index 0000000000..4c095c27bc --- /dev/null +++ b/csharp/docs/transaction/IQueryManager.adoc @@ -0,0 +1,573 @@ +[#_IQueryManager] +=== IQueryManager + +*Package*: `TypeDB.Driver.Api` + + + +Provides methods for executing TypeQL queries in the transaction. + +// tag::methods[] +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query_] +==== Define + +[source,csharp] +---- +VoidPromise Define(string query) +---- + + + +Performs a TypeQL Define query with default options. + + + See also + + + <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query__TypeDBOptions_options_,IQueryManager::Define(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query__TypeDBOptions_options_] +==== Define + +[source,csharp] +---- +VoidPromise Define(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Define query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Define query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query_] +==== Delete + +[source,csharp] +---- +VoidPromise Delete(string query) +---- + + + +Performs a TypeQL Delete query with default options. + + + See also + + + <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query__TypeDBOptions_options_,IQueryManager::Delete(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query__TypeDBOptions_options_] +==== Delete + +[source,csharp] +---- +VoidPromise Delete(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Delete query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Delete query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable_] +==== Explain + +[source,csharp] +---- +IEnumerable< IExplanation > IExplainable explainable) +---- + + + +Performs a TypeQL Explain query with default options. + + + See also + + + <<#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable_,IQueryManager::Explain>>(IConceptMap.IExplainable, TypeDBOptions) + + + +[caption=""] +.Returns +`IEnumerable< IExplanation > IExplainable` + +[#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable__TypeDBOptions_options_] +==== Explain + +[source,csharp] +---- +IEnumerable< IExplanation > IExplainable explainable, TypeDBOptions options) +---- + + + +Performs a TypeQL Explain query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `explainable` a| The IExplainable to be explained a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IExplanation > IExplainable explainable, TypeDBOptions` + +[#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query_] +==== Fetch + +[source,csharp] +---- +IEnumerable< JObject > Fetch(string query) +---- + + + +Performs a TypeQL Fetch (Fetch) with default options. + + + See also + + + <<#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query__TypeDBOptions_options_,IQueryManager::Fetch(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< JObject >` + +[#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query__TypeDBOptions_options_] +==== Fetch + +[source,csharp] +---- +IEnumerable< JObject > Fetch(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Fetch (Fetch) query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Fetch (Fetch) query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< JObject >` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query_] +==== Get + +[source,csharp] +---- +IEnumerable< IConceptMap > Get(string query) +---- + + + +Performs a TypeQL Get (Get) with default options. + + + See also + + + <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query__TypeDBOptions_options_,IQueryManager::Get(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query__TypeDBOptions_options_] +==== Get + +[source,csharp] +---- +IEnumerable< IConceptMap > Get(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Get (Get) query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Get (Get) query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +[#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query_] +==== GetAggregate + +[source,csharp] +---- +Promise< IValue > GetAggregate(string query) +---- + + + +Performs a TypeQL Get Aggregate query with default options. + + + See also + + + <<#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query__TypeDBOptions_options_,IQueryManager::GetAggregate(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`Promise< IValue >` + +[#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query__TypeDBOptions_options_] +==== GetAggregate + +[source,csharp] +---- +Promise< IValue > GetAggregate(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Get Aggregate query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Get Aggregate query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`Promise< IValue >` + +[#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query_] +==== GetGroup + +[source,csharp] +---- +IEnumerable< IConceptMapGroup > GetGroup(string query) +---- + + + +Performs a TypeQL Get Group query with default options. + + + See also + + + <<#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query__TypeDBOptions_options_,IQueryManager::GetGroup(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< IConceptMapGroup >` + +[#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query__TypeDBOptions_options_] +==== GetGroup + +[source,csharp] +---- +IEnumerable< IConceptMapGroup > GetGroup(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Get Group query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Get Group query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IConceptMapGroup >` + +[#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query_] +==== GetGroupAggregate + +[source,csharp] +---- +IEnumerable< IValueGroup > GetGroupAggregate(string query) +---- + + + +Performs a TypeQL Get Group Aggregate query with default options. + + + See also + + + <<#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query__TypeDBOptions_options_,IQueryManager::GetGroupAggregate(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< IValueGroup >` + +[#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query__TypeDBOptions_options_] +==== GetGroupAggregate + +[source,csharp] +---- +IEnumerable< IValueGroup > GetGroupAggregate(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Get Group Aggregate query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Get Group Aggregate query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IValueGroup >` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query_] +==== Insert + +[source,csharp] +---- +IEnumerable< IConceptMap > Insert(string query) +---- + + + +Performs a TypeQL Insert query with default options. + + + See also + + + <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query__TypeDBOptions_options_,IQueryManager::Insert(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query__TypeDBOptions_options_] +==== Insert + +[source,csharp] +---- +IEnumerable< IConceptMap > Insert(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Insert query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Insert query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query_] +==== Undefine + +[source,csharp] +---- +VoidPromise Undefine(string query) +---- + + + +Performs a TypeQL Undefine query with default options. + + + See also + + + <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query__TypeDBOptions_options_,IQueryManager::Undefine(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`VoidPromise` + +[#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query__TypeDBOptions_options_] +==== Undefine + +[source,csharp] +---- +VoidPromise Undefine(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Undefine query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Undefine query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`VoidPromise` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query_] +==== Update + +[source,csharp] +---- +IEnumerable< IConceptMap > Update(string query) +---- + + + +Performs a TypeQL Update query with default options. + + + See also + + + <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query__TypeDBOptions_options_,IQueryManager::Update(string, TypeDBOptions)>> + + + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +[#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query__TypeDBOptions_options_] +==== Update + +[source,csharp] +---- +IEnumerable< IConceptMap > Update(string query, TypeDBOptions options) +---- + + + +Performs a TypeQL Update query in the transaction. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `query` a| The TypeQL Update query to be executed a| +a| `options` a| Specify query options a| +|=== + +[caption=""] +.Returns +`IEnumerable< IConceptMap >` + +// end::methods[] + diff --git a/csharp/docs/transaction/ITypeDBTransaction.adoc b/csharp/docs/transaction/ITypeDBTransaction.adoc new file mode 100644 index 0000000000..f28ece3e22 --- /dev/null +++ b/csharp/docs/transaction/ITypeDBTransaction.adoc @@ -0,0 +1,102 @@ +[#_ITypeDBTransaction] +=== ITypeDBTransaction + +*Package*: `TypeDB.Driver.Api` + +// tag::methods[] +[#_void_TypeDB_Driver_Api_ITypeDBTransaction_Close___] +==== Close + +[source,csharp] +---- +void Close() +---- + + + +Closes the transaction. + + +[caption=""] +.Returns +`void` + +[#_void_TypeDB_Driver_Api_ITypeDBTransaction_Commit___] +==== Commit + +[source,csharp] +---- +void Commit() +---- + + + +Commits the changes made via this transaction to the TypeDB database. Whether or not the transaction is committed successfully, it gets closed after the commit call. + + +[caption=""] +.Returns +`void` + +[#_bool_TypeDB_Driver_Api_ITypeDBTransaction_IsOpen___] +==== IsOpen + +[source,csharp] +---- +bool IsOpen() +---- + + + +Checks whether this transaction is open. + + +[caption=""] +.Returns +`bool` + +[#_void_TypeDB_Driver_Api_ITypeDBTransaction_OnClose___Action__Exception___function_] +==== OnClose + +[source,csharp] +---- +void OnClose(Action< Exception > function) +---- + + + +Registers a callback function which will be executed when this transaction is closed. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `function` a| The callback function. a| +|=== + +[caption=""] +.Returns +`void` + +[#_void_TypeDB_Driver_Api_ITypeDBTransaction_Rollback___] +==== Rollback + +[source,csharp] +---- +void Rollback() +---- + + + +Rolls back the uncommitted changes made via this transaction. + + +[caption=""] +.Returns +`void` + +// end::methods[] + diff --git a/csharp/docs/transaction/TransactionType.adoc b/csharp/docs/transaction/TransactionType.adoc new file mode 100644 index 0000000000..4c5590c546 --- /dev/null +++ b/csharp/docs/transaction/TransactionType.adoc @@ -0,0 +1,29 @@ +[#_TransactionType] +=== TransactionType + +*Package*: `TypeDB.Driver.Api` + + + +Used to specify the type of transaction. + + +[caption=""] +.Examples +[source,csharp] +---- +session.Transaction(TransactionType.Read); +---- + +[caption=""] +.Enum constants +// tag::enum_constants[] +[cols="~"] +[options="header"] +|=== +|Name +a| `Read` +a| `Write` +|=== +// end::enum_constants[] + diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index 6c3334c138..2fdc7a8d51 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -3,7 +3,7 @@ * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information + * distributed with this work for nested information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance @@ -67,22 +67,16 @@ class DoxygenParserCsharp : Callable { } val classes: MutableList = ArrayList() - // Enums that are not a part of a class - run { - val namespaceFiles = Files.walk(Paths.get(htmlDocsDirectoryName)) - .filter { Files.isRegularFile(it) } - .filter { it.toString().startsWith(htmlDocsDirectoryName + "namespace_type_d_b_1_1_driver_") } - .forEach { - val html = File(it.toAbsolutePath().toString()).readText(Charsets.UTF_8) - val parsed = Jsoup.parse(html) - - // Enums - val (_, _, parsedEnums) = parseMemberDecls(parsed, true) // enumsOnly - parsedEnums.forEach{ element -> classes.add(element) } - } - - - } + // Enums that are not members of a class + Files.walk(Paths.get(htmlDocsDirectoryName)) + .filter { Files.isRegularFile(it) } + .filter { it.toString().startsWith(htmlDocsDirectoryName + "namespace_type_d_b_1_1_driver_") } + .forEach { + val html = File(it.toAbsolutePath().toString()).readText(Charsets.UTF_8) + val parsed = Jsoup.parse(html) + val (_, _, parsedEnums) = parseMemberDecls(parsed) + classes += parsedEnums + } // class files File(inputDirectoryName).walkTopDown().filter { @@ -95,10 +89,10 @@ class DoxygenParserCsharp : Callable { val html = File(it.path).readText(Charsets.UTF_8) val parsed = Jsoup.parse(html) - val (parsedClass, additionalParsedClasses) = parseClass(parsed) + val (parsedClass, nestedParsedClasses) = parseClass(parsed) if (parsedClass.isNotEmpty()) classes.add(parsedClass) - additionalParsedClasses.forEach{ element -> classes.add(element) } + nestedParsedClasses.forEach{ element -> classes.add(element) } } classes.forEach { parsedClass -> @@ -121,11 +115,12 @@ class DoxygenParserCsharp : Callable { return outputFile } - private fun parseMemberDecls(document: Element, enumsOnly: Boolean = false): Triple>, Map, List> { + private fun parseMemberDecls(document: Element): + Triple>, Map, List> { val missingDeclarations: MutableList = ArrayList() val map: MutableMap> = HashMap() val idToAnchor: MutableMap = HashMap() - val additionalClasses: MutableList = ArrayList() + val nestedClasses: MutableList = ArrayList() document.select("table.memberdecls").forEach { table -> val heading: String = table.selectFirst("tr.heading > td > h2 > a")!!.attr("name") @@ -147,27 +142,23 @@ class DoxygenParserCsharp : Callable { } else { if (type == "enum") { - additionalClasses.add(parseEnum(element, memberDetails)) - + nestedClasses.add(parseEnum(element, memberDetails)) } - else if (!enumsOnly) { - println("Not enum....") + else { members.add(memberDetails) idToAnchor[id] = replaceSymbolsForAnchor(memberDetails.select("table.memname").text()) - } else { - } } } + map[heading] = members -// print("Result for now: $map") } if (missingDeclarations.isNotEmpty()) { println("Missing some member declarations:\n\t-" + missingDeclarations.joinToString("\n\t-")) } - return Triple(map, idToAnchor, additionalClasses) + return Triple(map, idToAnchor, nestedClasses) } private fun parseClass(document: Element): Pair> { @@ -181,7 +172,7 @@ class DoxygenParserCsharp : Callable { .map { it.text().substringAfter("inherited from ") } .toSet().toList() - val (memberDecls, idToAnchor, additionalClasses) = parseMemberDecls(document) + val (memberDecls, idToAnchor, nestedClasses) = parseMemberDecls(document) val classDescr: List = document.selectFirst("div.textblock") ?.let { splitToParagraphs(it.html()) }?.map { reformatTextWithCode(it.substringBefore(" { methods = methods, packagePath = packagePath, superClasses = superClasses), - additionalClasses) + nestedClasses) } private fun parseEnum(constantsElement: Element, detailsElement: Element): Class { - println("ELEMENT:" + constantsElement + "\nDETAILS: " + detailsElement + "\n") val typeAndName = detailsElement ?.selectFirst("div.memitem > div.memproto > table.memname > tbody > tr > td.memname") ?.text()?.split(" ")!! @@ -222,7 +212,7 @@ class DoxygenParserCsharp : Callable { val classDescr: List = detailsElement.selectFirst("div.memdoc") ?.let { splitToParagraphs(it.html()) }?.map { reformatTextWithCode(it.substringBefore(" pre").map { replaceSpaces(it.text()) } + val classExamples = detailsElement.select("div.memdoc > pre").map { replaceSpaces(it.text()) } val enumConstantsText = constantsElement ?.selectFirst("td.memItemRight") @@ -235,10 +225,8 @@ class DoxygenParserCsharp : Callable { anchor = classAnchor, description = classDescr, enumConstants = enumConstants, -// examples = classExamples, + examples = classExamples, packagePath = packagePath, - - examples = listOf("awklfawlkfl"), ) } From 5159b645ce5734b183d9d72d998342b4faaa86f6 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Fri, 22 Mar 2024 12:59:57 +0000 Subject: [PATCH 034/118] Fix lang ref. Add examples for methods --- csharp/docs/answer/IConceptMap.adoc | 36 ++- csharp/docs/answer/IConceptMapGroup.adoc | 9 +- csharp/docs/answer/IExplainables.adoc | 54 +++- csharp/docs/answer/IExplanation.adoc | 18 +- csharp/docs/answer/Promise__T__.adoc | 27 +- csharp/docs/answer/VoidPromise.adoc | 18 +- csharp/docs/concept/IConcept.adoc | 198 +++++++++++-- csharp/docs/concept/IConceptManager.adoc | 90 +++++- csharp/docs/concept/Transitivity.adoc | 2 +- csharp/docs/connection/IDatabase.adoc | 45 ++- csharp/docs/connection/IDatabaseManager.adoc | 36 ++- csharp/docs/connection/IReplica.adoc | 4 +- csharp/docs/connection/ITypeDBDriver.adoc | 38 ++- csharp/docs/connection/IUser.adoc | 2 +- csharp/docs/connection/IUserManager.adoc | 54 +++- csharp/docs/connection/TypeDBCredential.adoc | 6 +- csharp/docs/data/IAttribute.adoc | 36 ++- csharp/docs/data/IEntity.adoc | 18 +- csharp/docs/data/IRelation.adoc | 63 ++++- csharp/docs/data/IThing.adoc | 101 ++++++- csharp/docs/data/IValue.adoc | 117 +++++++- csharp/docs/data/ValueType.adoc | 2 +- csharp/docs/errors/TypeDBDriverException.adoc | 31 ++- csharp/docs/logic/ILogicManager.adoc | 27 +- csharp/docs/logic/IRule.adoc | 27 +- csharp/docs/schema/Annotation.adoc | 57 +++- csharp/docs/schema/IAttributeType.adoc | 261 ++++++++++++++++-- csharp/docs/schema/IEntityType.adoc | 36 ++- csharp/docs/schema/IRelationType.adoc | 92 +++++- csharp/docs/schema/IRoleType.adoc | 60 +++- csharp/docs/schema/IThingType.adoc | 157 +++++++++-- csharp/docs/schema/IType.adoc | 93 ++++++- csharp/docs/schema/Label.adoc | 38 ++- csharp/docs/session/ITypeDBSession.adoc | 47 +++- csharp/docs/session/SessionType.adoc | 2 +- csharp/docs/session/TypeDBOptions.adoc | 189 +++++++++++-- csharp/docs/transaction/IQueryManager.adoc | 121 ++++++-- .../docs/transaction/ITypeDBTransaction.adoc | 45 ++- csharp/docs/transaction/TransactionType.adoc | 2 +- tool/docs/csharp/DoxygenParserCsharp.kt | 18 +- 40 files changed, 1982 insertions(+), 295 deletions(-) diff --git a/csharp/docs/answer/IConceptMap.adoc b/csharp/docs/answer/IConceptMap.adoc index 7b166e7ce0..9f1ab81112 100644 --- a/csharp/docs/answer/IConceptMap.adoc +++ b/csharp/docs/answer/IConceptMap.adoc @@ -11,7 +11,7 @@ Contains a mapping of variables to concepts. [#_IConcept_TypeDB_Driver_Api_IConceptMap_Get___string_variable_] ==== Get -[source,csharp] +[source,cs] ---- IConcept Get(string variable) ---- @@ -34,10 +34,17 @@ a| `variable` a| The string representation of a variable a| .Returns `IConcept` +[caption=""] +.Code examples +[source,cs] +---- +conceptMap.Get(variable); +---- + [#_IEnumerable__IConcept___TypeDB_Driver_Api_IConceptMap_GetConcepts___] ==== GetConcepts -[source,csharp] +[source,cs] ---- IEnumerable< IConcept > GetConcepts() ---- @@ -51,10 +58,17 @@ Returns a collection of all concepts in this ``IConceptMap``. .Returns `IEnumerable< IConcept >` +[caption=""] +.Code examples +[source,cs] +---- +conceptMap.GetConcepts(); +---- + [#_Dictionary__string__IConcept___TypeDB_Driver_Api_IConceptMap_GetMap___] ==== GetMap -[source,csharp] +[source,cs] ---- Dictionary< string, IConcept > GetMap() ---- @@ -68,10 +82,17 @@ Returns the inner ``Dictionary`` (``Map`` as a common TypeDB term) where keys ar .Returns `Dictionary< string, IConcept >` +[caption=""] +.Code examples +[source,cs] +---- +conceptMap.GetMap(); +---- + [#_IEnumerable__string___TypeDB_Driver_Api_IConceptMap_GetVariables___] ==== GetVariables -[source,csharp] +[source,cs] ---- IEnumerable< string > GetVariables() ---- @@ -85,5 +106,12 @@ Returns a collection of all variables in this ``IConceptMap``. .Returns `IEnumerable< string >` +[caption=""] +.Code examples +[source,cs] +---- +conceptMap.GetVariables(); +---- + // end::methods[] diff --git a/csharp/docs/answer/IConceptMapGroup.adoc b/csharp/docs/answer/IConceptMapGroup.adoc index 9d9a151bfc..4d7944b9db 100644 --- a/csharp/docs/answer/IConceptMapGroup.adoc +++ b/csharp/docs/answer/IConceptMapGroup.adoc @@ -11,7 +11,7 @@ Contains an element of the group query result. [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IConceptMapGroup_GetConceptMaps___] ==== GetConceptMaps -[source,csharp] +[source,cs] ---- IEnumerable< IConceptMap > GetConceptMaps() ---- @@ -25,5 +25,12 @@ Retrieves the ``IConceptMap``s of the group. .Returns `IEnumerable< IConceptMap >` +[caption=""] +.Code examples +[source,cs] +---- +conceptMapGroup.GetConceptMaps(); +---- + // end::methods[] diff --git a/csharp/docs/answer/IExplainables.adoc b/csharp/docs/answer/IExplainables.adoc index 2338ec484f..1401678157 100644 --- a/csharp/docs/answer/IExplainables.adoc +++ b/csharp/docs/answer/IExplainables.adoc @@ -11,7 +11,7 @@ Contains explainable objects. [#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Attribute___string_variable_] ==== Attribute -[source,csharp] +[source,cs] ---- IExplainable Attribute(string variable) ---- @@ -34,10 +34,17 @@ a| `variable` a| The string representation of a variable a| .Returns `IExplainable` +[caption=""] +.Code examples +[source,cs] +---- +conceptMap.AllExplainables.Attribute(variable); +---- + [#_IEnumerable__KeyValuePair__string__IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetAttributes___] ==== GetAttributes -[source,csharp] +[source,cs] ---- IEnumerable< KeyValuePair< string, IExplainable > > GetAttributes() ---- @@ -51,10 +58,17 @@ Retrieves all of this ``IConceptMap``’s explainable attributes. .Returns `IEnumerable< KeyValuePair< string, IExplainable > >` +[caption=""] +.Code examples +[source,cs] +---- +conceptMap.AllExplainables.GetAttributes(); +---- + [#_IEnumerable__KeyValuePair__KeyValuePair__string__string____IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetOwnerships___] ==== GetOwnerships -[source,csharp] +[source,cs] ---- IEnumerable< KeyValuePair< KeyValuePair< string, string >, IExplainable > > GetOwnerships() ---- @@ -68,10 +82,17 @@ Retrieves all of this ``IConceptMap``’s explainable ownerships. .Returns `IEnumerable< KeyValuePair< KeyValuePair< string, string >, IExplainable > >` +[caption=""] +.Code examples +[source,cs] +---- +conceptMap.AllExplainables.GetOwnerships(); +---- + [#_IEnumerable__KeyValuePair__string__IExplainable_____TypeDB_Driver_Api_IConceptMap_IExplainables_GetRelations___] ==== GetRelations -[source,csharp] +[source,cs] ---- IEnumerable< KeyValuePair< string, IExplainable > > GetRelations() ---- @@ -85,10 +106,17 @@ Retrieves all of this ``IConceptMap``’s explainable relations. .Returns `IEnumerable< KeyValuePair< string, IExplainable > >` +[caption=""] +.Code examples +[source,cs] +---- +conceptMap.AllExplainables.GetRelations(); +---- + [#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Ownership___string_owner__string_attribute_] ==== Ownership -[source,csharp] +[source,cs] ---- IExplainable Ownership(string owner, string attribute) ---- @@ -112,10 +140,17 @@ a| `attribute` a| The string representation of the attribute variable a| .Returns `IExplainable` +[caption=""] +.Code examples +[source,cs] +---- +conceptMap.AllExplainables.Ownership(owner, attribute); +---- + [#_IExplainable_TypeDB_Driver_Api_IConceptMap_IExplainables_Relation___string_variable_] ==== Relation -[source,csharp] +[source,cs] ---- IExplainable Relation(string variable) ---- @@ -138,5 +173,12 @@ a| `variable` a| The string representation of a variable a| .Returns `IExplainable` +[caption=""] +.Code examples +[source,cs] +---- +conceptMap.AllExplainables.Relation(variable); +---- + // end::methods[] diff --git a/csharp/docs/answer/IExplanation.adoc b/csharp/docs/answer/IExplanation.adoc index a394f9d7f7..66b5bf0b30 100644 --- a/csharp/docs/answer/IExplanation.adoc +++ b/csharp/docs/answer/IExplanation.adoc @@ -11,7 +11,7 @@ An explanation of which rule was used for inferring the explained concept, the c [#_ISet__string___TypeDB_Driver_Api_IExplanation_GetQueryVariables___] ==== GetQueryVariables -[source,csharp] +[source,cs] ---- ISet< string > GetQueryVariables() ---- @@ -25,10 +25,17 @@ Retrieves the query variables for this ``Explanation``. .Returns `ISet< string >` +[caption=""] +.Code examples +[source,cs] +---- +explanation.GetQueryVariables() +---- + [#_ISet__string___TypeDB_Driver_Api_IExplanation_QueryVariableMapping___string_variable_] ==== QueryVariableMapping -[source,csharp] +[source,cs] ---- ISet< string > QueryVariableMapping(string variable) ---- @@ -51,5 +58,12 @@ a| `variable` a| The query variable to map to rule variables. a| .Returns `ISet< string >` +[caption=""] +.Code examples +[source,cs] +---- +explanation.VariableMapping(variable) +---- + // end::methods[] diff --git a/csharp/docs/answer/Promise__T__.adoc b/csharp/docs/answer/Promise__T__.adoc index e5fc0c6058..a9d980b869 100644 --- a/csharp/docs/answer/Promise__T__.adoc +++ b/csharp/docs/answer/Promise__T__.adoc @@ -15,7 +15,7 @@ The request it represents is performed immediately. The response is only retriev [#_static_Promise__TTo___TypeDB_Driver_Common_Promise__T___Map__TFrom__TTo_____Func__TFrom__resolver__Func__TFrom__TTo___selector_] ==== Map< TFrom, TTo > -[source,csharp] +[source,cs] ---- static Promise< TTo > TypeDB.Driver.Common.Promise< T >.Map< TFrom, TTo >(Func< TFrom?> resolver, Func< TFrom, TTo > selector) ---- @@ -39,10 +39,17 @@ a| `fn` a| The mapping function a| .Returns `static Promise< TTo >` +[caption=""] +.Code examples +[source,cs] +---- +Promise.Map(supplier, selector); +---- + [#_TypeDB_Driver_Common_Promise__T___Promise___Func__T__resolver_] ==== Promise -[source,csharp] +[source,cs] ---- TypeDB.Driver.Common.Promise< T Promise(Func< T?> resolver) ---- @@ -65,10 +72,17 @@ a| `promise` a| The function to wrap into the promise a| .Returns `TypeDB.Driver.Common.Promise< T` +[caption=""] +.Code examples +[source,cs] +---- +new Promise(supplier); +---- + [#_T_TypeDB_Driver_Common_Promise__T___Resolve___] ==== Resolve -[source,csharp] +[source,cs] ---- T? TypeDB.Driver.Common.Promise< T Resolve() ---- @@ -82,5 +96,12 @@ Retrieves the result of the Promise. .Returns `T? TypeDB.Driver.Common.Promise< T` +[caption=""] +.Code examples +[source,cs] +---- +promise.Resolve(); +---- + // end::methods[] diff --git a/csharp/docs/answer/VoidPromise.adoc b/csharp/docs/answer/VoidPromise.adoc index 35c124e901..10de5b486a 100644 --- a/csharp/docs/answer/VoidPromise.adoc +++ b/csharp/docs/answer/VoidPromise.adoc @@ -19,7 +19,7 @@ A ``VoidPromise`` represents a ``Promise`` without an operation's result. [#_void_TypeDB_Driver_Common_VoidPromise_Resolve___] ==== Resolve -[source,csharp] +[source,cs] ---- void Resolve() ---- @@ -33,10 +33,17 @@ Retrieves the result of the Promise. .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +promise.Resolve(); +---- + [#_TypeDB_Driver_Common_VoidPromise_VoidPromise___Action_resolver_] ==== VoidPromise -[source,csharp] +[source,cs] ---- VoidPromise(Action resolver) ---- @@ -59,5 +66,12 @@ a| `promise` a| The function to wrap into the promise a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +new Promise(action); +---- + // end::methods[] diff --git a/csharp/docs/concept/IConcept.adoc b/csharp/docs/concept/IConcept.adoc index 1e3c0b2eaf..8c9c01f5e6 100644 --- a/csharp/docs/concept/IConcept.adoc +++ b/csharp/docs/concept/IConcept.adoc @@ -7,7 +7,7 @@ [#_IAttribute_TypeDB_Driver_Api_IConcept_AsAttribute___] ==== AsAttribute -[source,csharp] +[source,cs] ---- IAttribute AsAttribute() ---- @@ -23,10 +23,17 @@ Implemented in TypeDB.Driver.Api.IAttribute. .Returns `IAttribute` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsAttribute(); +---- + [#_IAttributeType_TypeDB_Driver_Api_IConcept_AsAttributeType___] ==== AsAttributeType -[source,csharp] +[source,cs] ---- IAttributeType AsAttributeType() ---- @@ -42,10 +49,17 @@ Implemented in TypeDB.Driver.Api.IAttributeType. .Returns `IAttributeType` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsAttributeType(); +---- + [#_IEntity_TypeDB_Driver_Api_IConcept_AsEntity___] ==== AsEntity -[source,csharp] +[source,cs] ---- IEntity AsEntity() ---- @@ -61,10 +75,17 @@ Implemented in TypeDB.Driver.Api.IEntity. .Returns `IEntity` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsEntity(); +---- + [#_IEntityType_TypeDB_Driver_Api_IConcept_AsEntityType___] ==== AsEntityType -[source,csharp] +[source,cs] ---- IEntityType AsEntityType() ---- @@ -80,10 +101,17 @@ Implemented in TypeDB.Driver.Api.IEntityType. .Returns `IEntityType` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsEntityType(); +---- + [#_IRelation_TypeDB_Driver_Api_IConcept_AsRelation___] ==== AsRelation -[source,csharp] +[source,cs] ---- IRelation AsRelation() ---- @@ -99,10 +127,17 @@ Implemented in TypeDB.Driver.Api.IRelation. .Returns `IRelation` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsRelation(); +---- + [#_IRelationType_TypeDB_Driver_Api_IConcept_AsRelationType___] ==== AsRelationType -[source,csharp] +[source,cs] ---- IRelationType AsRelationType() ---- @@ -118,10 +153,17 @@ Implemented in TypeDB.Driver.Api.IRelationType. .Returns `IRelationType` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsRelationType(); +---- + [#_IRoleType_TypeDB_Driver_Api_IConcept_AsRoleType___] ==== AsRoleType -[source,csharp] +[source,cs] ---- IRoleType AsRoleType() ---- @@ -137,10 +179,17 @@ Implemented in TypeDB.Driver.Api.IRoleType. .Returns `IRoleType` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsRoleType(); +---- + [#_IThing_TypeDB_Driver_Api_IConcept_AsThing___] ==== AsThing -[source,csharp] +[source,cs] ---- IThing AsThing() ---- @@ -156,10 +205,17 @@ Implemented in TypeDB.Driver.Api.IThing. .Returns `IThing` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsThing(); +---- + [#_IThingType_TypeDB_Driver_Api_IConcept_AsThingType___] ==== AsThingType -[source,csharp] +[source,cs] ---- IThingType AsThingType() ---- @@ -175,10 +231,17 @@ Implemented in TypeDB.Driver.Api.IThingType. .Returns `IThingType` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsThingType(); +---- + [#_IType_TypeDB_Driver_Api_IConcept_AsType___] ==== AsType -[source,csharp] +[source,cs] ---- IType AsType() ---- @@ -194,10 +257,17 @@ Implemented in TypeDB.Driver.Api.IType. .Returns `IType` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsType(); +---- + [#_IValue_TypeDB_Driver_Api_IConcept_AsValue___] ==== AsValue -[source,csharp] +[source,cs] ---- IValue AsValue() ---- @@ -213,10 +283,17 @@ Implemented in TypeDB.Driver.Api.IValue. .Returns `IValue` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsValue(); +---- + [#_bool_TypeDB_Driver_Api_IConcept_IsAttribute___] ==== IsAttribute -[source,csharp] +[source,cs] ---- bool IsAttribute() ---- @@ -232,10 +309,17 @@ Implemented in TypeDB.Driver.Api.IAttribute. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsAttribute(); +---- + [#_bool_TypeDB_Driver_Api_IConcept_IsAttributeType___] ==== IsAttributeType -[source,csharp] +[source,cs] ---- bool IsAttributeType() ---- @@ -251,10 +335,17 @@ Implemented in TypeDB.Driver.Api.IAttributeType. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsAttributeType(); +---- + [#_bool_TypeDB_Driver_Api_IConcept_IsEntity___] ==== IsEntity -[source,csharp] +[source,cs] ---- bool IsEntity() ---- @@ -270,10 +361,17 @@ Implemented in TypeDB.Driver.Api.IEntity. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsEntity(); +---- + [#_bool_TypeDB_Driver_Api_IConcept_IsEntityType___] ==== IsEntityType -[source,csharp] +[source,cs] ---- bool IsEntityType() ---- @@ -289,10 +387,17 @@ Implemented in TypeDB.Driver.Api.IEntityType. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsEntityType(); +---- + [#_bool_TypeDB_Driver_Api_IConcept_IsRelation___] ==== IsRelation -[source,csharp] +[source,cs] ---- bool IsRelation() ---- @@ -308,10 +413,17 @@ Implemented in TypeDB.Driver.Api.IRelation. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsRelation(); +---- + [#_bool_TypeDB_Driver_Api_IConcept_IsRelationType___] ==== IsRelationType -[source,csharp] +[source,cs] ---- bool IsRelationType() ---- @@ -327,10 +439,17 @@ Implemented in TypeDB.Driver.Api.IRelationType. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsRelationType(); +---- + [#_bool_TypeDB_Driver_Api_IConcept_IsRoleType___] ==== IsRoleType -[source,csharp] +[source,cs] ---- bool IsRoleType() ---- @@ -346,10 +465,17 @@ Implemented in TypeDB.Driver.Api.IRoleType. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsRoleType(); +---- + [#_bool_TypeDB_Driver_Api_IConcept_IsThing___] ==== IsThing -[source,csharp] +[source,cs] ---- bool IsThing() ---- @@ -365,10 +491,17 @@ Implemented in TypeDB.Driver.Api.IThing. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsThing(); +---- + [#_bool_TypeDB_Driver_Api_IConcept_IsThingType___] ==== IsThingType -[source,csharp] +[source,cs] ---- bool IsThingType() ---- @@ -384,10 +517,17 @@ Implemented in TypeDB.Driver.Api.IThingType. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsThingType(); +---- + [#_bool_TypeDB_Driver_Api_IConcept_IsType___] ==== IsType -[source,csharp] +[source,cs] ---- bool IsType() ---- @@ -403,10 +543,17 @@ Implemented in TypeDB.Driver.Api.IType. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsType(); +---- + [#_bool_TypeDB_Driver_Api_IConcept_IsValue___] ==== IsValue -[source,csharp] +[source,cs] ---- bool IsValue() ---- @@ -422,5 +569,12 @@ Implemented in TypeDB.Driver.Api.IValue. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsValue(); +---- + // end::methods[] diff --git a/csharp/docs/concept/IConceptManager.adoc b/csharp/docs/concept/IConceptManager.adoc index eaf2ef1ee3..02353eab46 100644 --- a/csharp/docs/concept/IConceptManager.adoc +++ b/csharp/docs/concept/IConceptManager.adoc @@ -11,7 +11,7 @@ Provides access for all Concept API methods. [#_Promise__IAttribute___TypeDB_Driver_Api_IConceptManager_GetAttribute___string_iid_] ==== GetAttribute -[source,csharp] +[source,cs] ---- Promise< IAttribute > GetAttribute(string iid) ---- @@ -34,10 +34,17 @@ a| `iid` a| The iid of the ``Attribute`` to retrieve. a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.GetAttribute(iid).Resolve(); +---- + [#_Promise__IAttributeType___TypeDB_Driver_Api_IConceptManager_GetAttributeType___string_label_] ==== GetAttributeType -[source,csharp] +[source,cs] ---- Promise< IAttributeType > GetAttributeType(string label) ---- @@ -60,10 +67,17 @@ a| `label` a| The label of the ``AttributeType`` to retrieve. a| .Returns `Promise< IAttributeType >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.GetAttributeType(label).Resolve(); +---- + [#_Promise__IEntity___TypeDB_Driver_Api_IConceptManager_GetEntity___string_iid_] ==== GetEntity -[source,csharp] +[source,cs] ---- Promise< IEntity > GetEntity(string iid) ---- @@ -86,10 +100,17 @@ a| `iid` a| The iid of the ``Entity`` to retrieve. a| .Returns `Promise< IEntity >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.GetEntity(iid).Resolve(); +---- + [#_Promise__IEntityType___TypeDB_Driver_Api_IConceptManager_GetEntityType___string_label_] ==== GetEntityType -[source,csharp] +[source,cs] ---- Promise< IEntityType > GetEntityType(string label) ---- @@ -112,10 +133,17 @@ a| `label` a| The label of the ``IEntityType`` to retrieve. a| .Returns `Promise< IEntityType >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.GetEntityType(label).Resolve(); +---- + [#_Promise__IRelation___TypeDB_Driver_Api_IConceptManager_GetRelation___string_iid_] ==== GetRelation -[source,csharp] +[source,cs] ---- Promise< IRelation > GetRelation(string iid) ---- @@ -138,10 +166,17 @@ a| `iid` a| The iid of the ``Relation`` to retrieve. a| .Returns `Promise< IRelation >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.GetRelation(iid).Resolve(); +---- + [#_Promise__IRelationType___TypeDB_Driver_Api_IConceptManager_GetRelationType___string_label_] ==== GetRelationType -[source,csharp] +[source,cs] ---- Promise< IRelationType > GetRelationType(string label) ---- @@ -164,10 +199,17 @@ a| `label` a| The label of the ``IRelationType`` to retrieve. a| .Returns `Promise< IRelationType >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.GetRelationType(label).Resolve(); +---- + [#_IList__TypeDBException___TypeDB_Driver_Api_IConceptManager_GetSchemaExceptions___] ==== GetSchemaExceptions -[source,csharp] +[source,cs] ---- IList< TypeDBException > GetSchemaExceptions() ---- @@ -181,10 +223,17 @@ A list of all schema exceptions for the current transaction. .Returns `IList< TypeDBException >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.GetSchemaExceptions(); +---- + [#_Promise__IAttributeType___TypeDB_Driver_Api_IConceptManager_PutAttributeType___string_label__IValue_ValueType_valueType_] ==== PutAttributeType -[source,csharp] +[source,cs] ---- Promise< IAttributeType > PutAttributeType(string label, IValue.ValueType valueType) ---- @@ -208,10 +257,17 @@ a| `valueType` a| The value type of the ``IAttributeType`` to create. a| .Returns `Promise< IAttributeType >` +[caption=""] +.Code examples +[source,cs] +---- +await transaction.Concepts.PutAttributeType(label, valueType).Resolve(); +---- + [#_Promise__IEntityType___TypeDB_Driver_Api_IConceptManager_PutEntityType___string_label_] ==== PutEntityType -[source,csharp] +[source,cs] ---- Promise< IEntityType > PutEntityType(string label) ---- @@ -234,10 +290,17 @@ a| `label` a| The label of the ``IEntityType`` to create or retrieve. a| .Returns `Promise< IEntityType >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.PutEntityType(label).Resolve(); +---- + [#_Promise__IRelationType___TypeDB_Driver_Api_IConceptManager_PutRelationType___string_label_] ==== PutRelationType -[source,csharp] +[source,cs] ---- Promise< IRelationType > PutRelationType(string label) ---- @@ -260,5 +323,12 @@ a| `label` a| The label of the ``IRelationType`` to create or retrieve. a| .Returns `Promise< IRelationType >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.PutRelationType(label).Resolve(); +---- + // end::methods[] diff --git a/csharp/docs/concept/Transitivity.adoc b/csharp/docs/concept/Transitivity.adoc index 3dade242a9..b2028f7278 100644 --- a/csharp/docs/concept/Transitivity.adoc +++ b/csharp/docs/concept/Transitivity.adoc @@ -10,7 +10,7 @@ This class is used for specifying whether we need explicit or transitive subtypi [caption=""] .Examples -[source,csharp] +[source,cs] ---- attributeType.GetOwners(transaction, annotation, Explicit); ---- diff --git a/csharp/docs/connection/IDatabase.adoc b/csharp/docs/connection/IDatabase.adoc index 136e2e7812..1da987922e 100644 --- a/csharp/docs/connection/IDatabase.adoc +++ b/csharp/docs/connection/IDatabase.adoc @@ -7,7 +7,7 @@ [#_void_TypeDB_Driver_Api_IDatabase_Delete___] ==== Delete -[source,csharp] +[source,cs] ---- void Delete() ---- @@ -21,10 +21,17 @@ Deletes this database. .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +database.Delete(); +---- + [#_ISet__IReplica___TypeDB_Driver_Api_IDatabase_GetReplicas___] ==== GetReplicas -[source,csharp] +[source,cs] ---- ISet< IReplica > GetReplicas() ---- @@ -38,10 +45,17 @@ Set of ``Replica`` instances for this database. Only works in TypeDB Cloud .Returns `ISet< IReplica >` +[caption=""] +.Code examples +[source,cs] +---- +database.GetReplicas(); +---- + [#_string_TypeDB_Driver_Api_IDatabase_GetRuleSchema___] ==== GetRuleSchema -[source,csharp] +[source,cs] ---- string GetRuleSchema() ---- @@ -55,10 +69,17 @@ The rules in the schema as a valid TypeQL define query string. .Returns `string` +[caption=""] +.Code examples +[source,cs] +---- +database.GetRuleSchema(); +---- + [#_string_TypeDB_Driver_Api_IDatabase_GetSchema___] ==== GetSchema -[source,csharp] +[source,cs] ---- string GetSchema() ---- @@ -72,10 +93,17 @@ A full schema text as a valid TypeQL define query string. .Returns `string` +[caption=""] +.Code examples +[source,cs] +---- +database.GetSchema(); +---- + [#_string_TypeDB_Driver_Api_IDatabase_GetTypeSchema___] ==== GetTypeSchema -[source,csharp] +[source,cs] ---- string GetTypeSchema() ---- @@ -89,5 +117,12 @@ The types in the schema as a valid TypeQL define query string. .Returns `string` +[caption=""] +.Code examples +[source,cs] +---- +database.GetTypeSchema(); +---- + // end::methods[] diff --git a/csharp/docs/connection/IDatabaseManager.adoc b/csharp/docs/connection/IDatabaseManager.adoc index edfc57f4c7..476119404d 100644 --- a/csharp/docs/connection/IDatabaseManager.adoc +++ b/csharp/docs/connection/IDatabaseManager.adoc @@ -11,7 +11,7 @@ Provides access to all database management methods. [#_bool_TypeDB_Driver_Api_IDatabaseManager_Contains___string_name_] ==== Contains -[source,csharp] +[source,cs] ---- bool Contains(string name) ---- @@ -34,10 +34,17 @@ a| `name` a| The database name to be checked a| .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +driver.Databases.Contains(name); +---- + [#_void_TypeDB_Driver_Api_IDatabaseManager_Create___string_name_] ==== Create -[source,csharp] +[source,cs] ---- void Create(string name) ---- @@ -60,10 +67,17 @@ a| `name` a| The name of the database to be created a| .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +driver.Databases.Create(name); +---- + [#_IDatabase_TypeDB_Driver_Api_IDatabaseManager_Get___string_name_] ==== Get -[source,csharp] +[source,cs] ---- IDatabase Get(string name) ---- @@ -86,10 +100,17 @@ a| `name` a| The name of the database to retrieve a| .Returns `IDatabase` +[caption=""] +.Code examples +[source,cs] +---- +driver.Databases.Get(name); +---- + [#_IList__IDatabase___TypeDB_Driver_Api_IDatabaseManager_GetAll___] ==== GetAll -[source,csharp] +[source,cs] ---- IList< IDatabase > GetAll() ---- @@ -103,5 +124,12 @@ Retrieves all databases present on the TypeDB server. .Returns `IList< IDatabase >` +[caption=""] +.Code examples +[source,cs] +---- +driver.Databases.GetAll(); +---- + // end::methods[] diff --git a/csharp/docs/connection/IReplica.adoc b/csharp/docs/connection/IReplica.adoc index aae081f027..e26be886e8 100644 --- a/csharp/docs/connection/IReplica.adoc +++ b/csharp/docs/connection/IReplica.adoc @@ -11,7 +11,7 @@ The metadata and state of an individual raft replica of a database. [#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPreferred___] ==== IsPreferred -[source,csharp] +[source,cs] ---- bool IsPreferred() ---- @@ -27,7 +27,7 @@ Checks whether this is the preferred replica of the raft cluster. If true, Opera [#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPrimary___] ==== IsPrimary -[source,csharp] +[source,cs] ---- bool IsPrimary() ---- diff --git a/csharp/docs/connection/ITypeDBDriver.adoc b/csharp/docs/connection/ITypeDBDriver.adoc index 556c706291..8041d77f5a 100644 --- a/csharp/docs/connection/ITypeDBDriver.adoc +++ b/csharp/docs/connection/ITypeDBDriver.adoc @@ -7,7 +7,7 @@ [#_void_TypeDB_Driver_Api_ITypeDBDriver_Close___] ==== Close -[source,csharp] +[source,cs] ---- void Close() ---- @@ -21,10 +21,17 @@ Closes the driver. Before instantiating a new driver, the driver that’s curren .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +driver.Close(); +---- + [#_IUser_TypeDB_Driver_Api_ITypeDBDriver_GetCurrentUser___] ==== GetCurrentUser -[source,csharp] +[source,cs] ---- IUser GetCurrentUser() ---- @@ -38,10 +45,17 @@ Returns the logged-in user for the connection. Only for TypeDB Cloud. .Returns `IUser` +[caption=""] +.Code examples +[source,cs] +---- +driver.GetCurrentUser(); +---- + [#_bool_TypeDB_Driver_Api_ITypeDBDriver_IsOpen___] ==== IsOpen -[source,csharp] +[source,cs] ---- bool IsOpen() ---- @@ -55,10 +69,17 @@ Checks whether this connection is presently open. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +driver.IsOpen(); +---- + [#_ITypeDBSession_TypeDB_Driver_Api_ITypeDBDriver_Session___string_database__SessionType_type_] ==== Session -[source,csharp] +[source,cs] ---- ITypeDBSession Session(string database, SessionType type) ---- @@ -82,7 +103,7 @@ Opens a session to the given database with default options. [#_ITypeDBSession_TypeDB_Driver_Api_ITypeDBDriver_Session___string_database__SessionType_type__TypeDBOptions_options_] ==== Session -[source,csharp] +[source,cs] ---- ITypeDBSession Session(string database, SessionType type, TypeDBOptions options) ---- @@ -107,5 +128,12 @@ a| `options` a| ``TypeDBOptions`` for the session a| .Returns `ITypeDBSession` +[caption=""] +.Code examples +[source,cs] +---- +driver.Session(database, sessionType, options); +---- + // end::methods[] diff --git a/csharp/docs/connection/IUser.adoc b/csharp/docs/connection/IUser.adoc index 8d978f17cc..609393e85b 100644 --- a/csharp/docs/connection/IUser.adoc +++ b/csharp/docs/connection/IUser.adoc @@ -11,7 +11,7 @@ TypeDB user information [#_void_TypeDB_Driver_Api_IUser_UpdatePassword___string_passwordOld__string_passwordNew_] ==== UpdatePassword -[source,csharp] +[source,cs] ---- void UpdatePassword(string passwordOld, string passwordNew) ---- diff --git a/csharp/docs/connection/IUserManager.adoc b/csharp/docs/connection/IUserManager.adoc index d9de8e084f..b55e0a3abd 100644 --- a/csharp/docs/connection/IUserManager.adoc +++ b/csharp/docs/connection/IUserManager.adoc @@ -11,7 +11,7 @@ Provides access to all user management methods. [#_bool_TypeDB_Driver_Api_IUserManager_Contains___string_username_] ==== Contains -[source,csharp] +[source,cs] ---- bool Contains(string username) ---- @@ -34,10 +34,17 @@ a| `username` a| The user name to be checked a| .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +driver.Users.Contains(username); +---- + [#_void_TypeDB_Driver_Api_IUserManager_Create___string_username__string_password_] ==== Create -[source,csharp] +[source,cs] ---- void Create(string username, string password) ---- @@ -61,10 +68,17 @@ a| `password` a| The password of the user to be created a| .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +driver.Users.Create(username, password); +---- + [#_void_TypeDB_Driver_Api_IUserManager_Delete___string_username_] ==== Delete -[source,csharp] +[source,cs] ---- void Delete(string username) ---- @@ -87,10 +101,17 @@ a| `username` a| The name of the user to be deleted a| .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +driver.Users.Delete(username); +---- + [#_IUser_TypeDB_Driver_Api_IUserManager_Get___string_username_] ==== Get -[source,csharp] +[source,cs] ---- IUser? Get(string username) ---- @@ -113,10 +134,17 @@ a| `username` a| The name of the user to retrieve a| .Returns `IUser?` +[caption=""] +.Code examples +[source,cs] +---- +driver.Users.Get(username); +---- + [#_ISet__IUser___TypeDB_Driver_Api_IUserManager_GetAll___] ==== GetAll -[source,csharp] +[source,cs] ---- ISet< IUser > GetAll() ---- @@ -130,10 +158,17 @@ Retrieves all users which exist on the TypeDB server. .Returns `ISet< IUser >` +[caption=""] +.Code examples +[source,cs] +---- +driver.Users.GetAll(); +---- + [#_void_TypeDB_Driver_Api_IUserManager_SetPassword___string_username__string_password_] ==== SetPassword -[source,csharp] +[source,cs] ---- void SetPassword(string username, string password) ---- @@ -157,5 +192,12 @@ a| `password` a| The new password a| .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +driver.Users.SetPassword(username, password); +---- + // end::methods[] diff --git a/csharp/docs/connection/TypeDBCredential.adoc b/csharp/docs/connection/TypeDBCredential.adoc index c013370fa1..393d234d50 100644 --- a/csharp/docs/connection/TypeDBCredential.adoc +++ b/csharp/docs/connection/TypeDBCredential.adoc @@ -10,7 +10,7 @@ User credentials and TLS encryption settings for connecting to TypeDB Cloud. [caption=""] .Examples -[source,csharp] +[source,cs] ---- // Creates a credential as above, but the connection will be made over TLS. TypeDBCredential credential = new TypeDBCredential(username, password, true); @@ -23,7 +23,7 @@ TypeDBCredential credential = new TypeDBCredential(username, password, Path.of(" [#_TypeDB_Driver_Api_TypeDBCredential_TypeDBCredential___string_username__string_password__bool_tlsEnabled_] ==== TypeDBCredential -[source,csharp] +[source,cs] ---- TypeDBCredential(string username, string password, bool tlsEnabled) ---- @@ -70,7 +70,7 @@ a| `tlsEnabled` a| Specify whether the connection to TypeDB Cloud must be done o [#_TypeDB_Driver_Api_TypeDBCredential_TypeDBCredential___string_username__string_password__string_tlsRootCAPath_] ==== TypeDBCredential -[source,csharp] +[source,cs] ---- TypeDBCredential(string username, string password, string? tlsRootCAPath) ---- diff --git a/csharp/docs/data/IAttribute.adoc b/csharp/docs/data/IAttribute.adoc index 6a5e99e65c..43b48e4b61 100644 --- a/csharp/docs/data/IAttribute.adoc +++ b/csharp/docs/data/IAttribute.adoc @@ -18,7 +18,7 @@ Attributes can be uniquely addressed by their type and value. [#_IAttribute_IConcept__TypeDB_Driver_Api_IAttribute_AsAttribute___] ==== AsAttribute -[source,csharp] +[source,cs] ---- IAttribute IConcept. AsAttribute() ---- @@ -34,10 +34,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `IAttribute IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +attribute.AsAttribute(); +---- + [#_IEnumerable__IThing___TypeDB_Driver_Api_IAttribute_GetOwners___ITypeDBTransaction_transaction_] ==== GetOwners -[source,csharp] +[source,cs] ---- IEnumerable< IThing > GetOwners(ITypeDBTransaction transaction) ---- @@ -60,10 +67,17 @@ a| `transaction` a| The current transaction a| .Returns `IEnumerable< IThing >` +[caption=""] +.Code examples +[source,cs] +---- +attribute.GetOwners(transaction); +---- + [#_IEnumerable__IThing___TypeDB_Driver_Api_IAttribute_GetOwners___ITypeDBTransaction_transaction__IThingType_ownerType_] ==== GetOwners -[source,csharp] +[source,cs] ---- IEnumerable< IThing > GetOwners(ITypeDBTransaction transaction, IThingType ownerType) ---- @@ -87,10 +101,17 @@ a| `ownerType` a| Filter results for only owners of the given type a| .Returns `IEnumerable< IThing >` +[caption=""] +.Code examples +[source,cs] +---- +attribute.GetOwners(transaction, ownerType); +---- + [#_bool_IConcept__TypeDB_Driver_Api_IAttribute_IsAttribute___] ==== IsAttribute -[source,csharp] +[source,cs] ---- bool IConcept. IsAttribute() ---- @@ -106,5 +127,12 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `bool IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +attribute.IsAttribute(); +---- + // end::methods[] diff --git a/csharp/docs/data/IEntity.adoc b/csharp/docs/data/IEntity.adoc index 596b57aaf5..ffba855a11 100644 --- a/csharp/docs/data/IEntity.adoc +++ b/csharp/docs/data/IEntity.adoc @@ -16,7 +16,7 @@ Instance of data of an entity type, representing a standalone object that exists [#_IEntity_IConcept__TypeDB_Driver_Api_IEntity_AsEntity___] ==== AsEntity -[source,csharp] +[source,cs] ---- IEntity IConcept. AsEntity() ---- @@ -32,10 +32,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `IEntity IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +entity.AsEntity(); +---- + [#_bool_IConcept__TypeDB_Driver_Api_IEntity_IsEntity___] ==== IsEntity -[source,csharp] +[source,cs] ---- bool IConcept. IsEntity() ---- @@ -51,5 +58,12 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `bool IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +entity.IsEntity(); +---- + // end::methods[] diff --git a/csharp/docs/data/IRelation.adoc b/csharp/docs/data/IRelation.adoc index 1875c1d0b6..fa844cf944 100644 --- a/csharp/docs/data/IRelation.adoc +++ b/csharp/docs/data/IRelation.adoc @@ -16,7 +16,7 @@ Relation is an instance of a relation type and can be uniquely addressed by a co [#_VoidPromise_TypeDB_Driver_Api_IRelation_AddPlayer___ITypeDBTransaction_transaction__IRoleType_roleType__IThing_player_] ==== AddPlayer -[source,csharp] +[source,cs] ---- VoidPromise AddPlayer(ITypeDBTransaction transaction, IRoleType roleType, IThing player) ---- @@ -41,10 +41,17 @@ a| `player` a| The thing to play the role a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +relation.AddPlayer(transaction, roleType, player).Resolve(); +---- + [#_IRelation_IConcept__TypeDB_Driver_Api_IRelation_AsRelation___] ==== AsRelation -[source,csharp] +[source,cs] ---- IRelation IConcept. AsRelation() ---- @@ -60,10 +67,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `IRelation IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +relation.AsRelation(); +---- + [#_Dictionary__IRoleType__ICollection__IThing_____TypeDB_Driver_Api_IRelation_GetPlayers___ITypeDBTransaction_transaction_] ==== GetPlayers -[source,csharp] +[source,cs] ---- Dictionary< IRoleType, ICollection< IThing > > GetPlayers(ITypeDBTransaction transaction) ---- @@ -86,10 +100,17 @@ a| `transaction` a| The current transaction a| .Returns `Dictionary< IRoleType, ICollection< IThing > >` +[caption=""] +.Code examples +[source,cs] +---- +relation.GetPlayers(transaction) +---- + [#_IEnumerable__IThing___TypeDB_Driver_Api_IRelation_GetPlayersByRoleType___ITypeDBTransaction_transaction__params_IRoleType___roleTypes_] ==== GetPlayersByRoleType -[source,csharp] +[source,cs] ---- IEnumerable< IThing > GetPlayersByRoleType(ITypeDBTransaction transaction, params IRoleType[] roleTypes) ---- @@ -113,10 +134,17 @@ a| `roleTypes` a| 0 or more role types a| .Returns `IEnumerable< IThing >` +[caption=""] +.Code examples +[source,cs] +---- +relation.GetPlayersByRoleType(transaction, roleTypes); +---- + [#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelation_GetRelating___ITypeDBTransaction_transaction_] ==== GetRelating -[source,csharp] +[source,cs] ---- IEnumerable< IRoleType > GetRelating(ITypeDBTransaction transaction) ---- @@ -139,10 +167,17 @@ a| `transaction` a| The current transaction a| .Returns `IEnumerable< IRoleType >` +[caption=""] +.Code examples +[source,cs] +---- +relation.GetRelating(transaction); +---- + [#_bool_IConcept__TypeDB_Driver_Api_IRelation_IsRelation___] ==== IsRelation -[source,csharp] +[source,cs] ---- bool IConcept. IsRelation() ---- @@ -158,10 +193,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `bool IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +relation.IsRelation(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IRelation_RemovePlayer___ITypeDBTransaction_transaction__IRoleType_roleType__IThing_player_] ==== RemovePlayer -[source,csharp] +[source,cs] ---- VoidPromise RemovePlayer(ITypeDBTransaction transaction, IRoleType roleType, IThing player) ---- @@ -186,5 +228,12 @@ a| `player` a| The instance to no longer play the role in this ``IRelation`` a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +relation.RemovePlayer(transaction, roleType, player).Resolve(); +---- + // end::methods[] diff --git a/csharp/docs/data/IThing.adoc b/csharp/docs/data/IThing.adoc index 73b20efbcd..5d7d969f21 100644 --- a/csharp/docs/data/IThing.adoc +++ b/csharp/docs/data/IThing.adoc @@ -11,7 +11,7 @@ [#_IThing_IConcept__TypeDB_Driver_Api_IThing_AsThing___] ==== AsThing -[source,csharp] +[source,cs] ---- IThing IConcept. AsThing() ---- @@ -27,10 +27,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `IThing IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +thing.AsThing(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IThing_Delete___ITypeDBTransaction_transaction_] ==== Delete -[source,csharp] +[source,cs] ---- VoidPromise Delete(ITypeDBTransaction transaction) ---- @@ -53,10 +60,17 @@ a| `transaction` a| The current transaction a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +thing.Delete(transaction).Resolve(); +---- + [#_IEnumerable__IAttribute___TypeDB_Driver_Api_IThing_GetHas___ITypeDBTransaction_transaction__params_IAttributeType___attributeTypes_] ==== GetHas -[source,csharp] +[source,cs] ---- IEnumerable< IAttribute > GetHas(ITypeDBTransaction transaction, params IAttributeType[] attributeTypes) ---- @@ -80,10 +94,18 @@ a| `attributeTypes` a| The ``IAttributeType``s to filter the attributes by a| .Returns `IEnumerable< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +thing.GetHas(transaction); +thing.GetHas(transaction, attributeType); +---- + [#_IEnumerable__IAttribute___TypeDB_Driver_Api_IThing_GetHas___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] ==== GetHas -[source,csharp] +[source,cs] ---- IEnumerable< IAttribute > GetHas(ITypeDBTransaction transaction, ICollection< Annotation > annotations) ---- @@ -107,10 +129,18 @@ a| `annotations` a| Only retrieve attributes with all given ``Annotation``s a| .Returns `IEnumerable< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +thing.GetHas(transaction); +thing.GetHas(transaction, new []{NewKey()}); +---- + [#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThing_GetPlaying___ITypeDBTransaction_transaction_] ==== GetPlaying -[source,csharp] +[source,cs] ---- IEnumerable< IRoleType > GetPlaying(ITypeDBTransaction transaction) ---- @@ -133,10 +163,17 @@ a| `transaction` a| The current transaction a| .Returns `IEnumerable< IRoleType >` +[caption=""] +.Code examples +[source,cs] +---- +thing.GetPlaying(transaction); +---- + [#_IEnumerable__IRelation___TypeDB_Driver_Api_IThing_GetRelations___ITypeDBTransaction_transaction__params_IRoleType___roleTypes_] ==== GetRelations -[source,csharp] +[source,cs] ---- IEnumerable< IRelation > GetRelations(ITypeDBTransaction transaction, params IRoleType[] roleTypes) ---- @@ -160,10 +197,17 @@ a| `roleTypes` a| The array of roles to filter the relations by. a| .Returns `IEnumerable< IRelation >` +[caption=""] +.Code examples +[source,cs] +---- +thing.GetRelations(transaction, roleTypes); +---- + [#_Promise__bool___TypeDB_Driver_Api_IThing_IsDeleted___ITypeDBTransaction_transaction_] ==== IsDeleted -[source,csharp] +[source,cs] ---- Promise< bool > IsDeleted(ITypeDBTransaction transaction) ---- @@ -186,10 +230,17 @@ a| `transaction` a| The current transaction a| .Returns `Promise< bool >` +[caption=""] +.Code examples +[source,cs] +---- +thing.IsDeleted(transaction).Resolve(); +---- + [#_bool_TypeDB_Driver_Api_IThing_IsInferred___] ==== IsInferred -[source,csharp] +[source,cs] ---- bool IsInferred() ---- @@ -203,10 +254,17 @@ Checks if this ``IThing`` is inferred by a [Reasoning Rule]. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +thing.IsInferred(); +---- + [#_bool_IConcept__TypeDB_Driver_Api_IThing_IsThing___] ==== IsThing -[source,csharp] +[source,cs] ---- bool IConcept. IsThing() ---- @@ -222,10 +280,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `bool IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +thing.IsThing(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IThing_SetHas___ITypeDBTransaction_transaction__IAttribute_attribute_] ==== SetHas -[source,csharp] +[source,cs] ---- VoidPromise SetHas(ITypeDBTransaction transaction, IAttribute attribute) ---- @@ -249,10 +314,17 @@ a| `attribute` a| The ``IAttribute`` to be owned by this ``IThing``. a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +thing.SetHas(transaction, attribute).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IThing_UnsetHas___ITypeDBTransaction_transaction__IAttribute_attribute_] ==== UnsetHas -[source,csharp] +[source,cs] ---- VoidPromise UnsetHas(ITypeDBTransaction transaction, IAttribute attribute) ---- @@ -276,5 +348,12 @@ a| `attribute` a| The ``IAttribute`` to be disowned from this ``IThing``. a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +thing.UnsetHas(transaction, attribute).Resolve(); +---- + // end::methods[] diff --git a/csharp/docs/data/IValue.adoc b/csharp/docs/data/IValue.adoc index c0686271c6..fc2f2298fc 100644 --- a/csharp/docs/data/IValue.adoc +++ b/csharp/docs/data/IValue.adoc @@ -11,7 +11,7 @@ [#_bool_TypeDB_Driver_Api_IValue_AsBool___] ==== AsBool -[source,csharp] +[source,cs] ---- bool AsBool() ---- @@ -25,10 +25,17 @@ Returns a ``bool`` value of this value concept. If the value has another type, r .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +value.AsBool(); +---- + [#_System_DateTime_TypeDB_Driver_Api_IValue_AsDateTime___] ==== AsDateTime -[source,csharp] +[source,cs] ---- System.DateTime AsDateTime() ---- @@ -42,10 +49,17 @@ Returns a ``datetime`` value of this value concept. This value contains raw date .Returns `System.DateTime` +[caption=""] +.Code examples +[source,cs] +---- +value.AsDateTime(); +---- + [#_double_TypeDB_Driver_Api_IValue_AsDouble___] ==== AsDouble -[source,csharp] +[source,cs] ---- double AsDouble() ---- @@ -59,10 +73,17 @@ Returns a ``double`` value of this value concept. If the value has another type, .Returns `double` +[caption=""] +.Code examples +[source,cs] +---- +value.AsDouble(); +---- + [#_long_TypeDB_Driver_Api_IValue_AsLong___] ==== AsLong -[source,csharp] +[source,cs] ---- long AsLong() ---- @@ -76,10 +97,17 @@ Returns a ``long`` value of this value concept. If the value has another type, r .Returns `long` +[caption=""] +.Code examples +[source,cs] +---- +value.AsLong(); +---- + [#_string_TypeDB_Driver_Api_IValue_AsString___] ==== AsString -[source,csharp] +[source,cs] ---- string AsString() ---- @@ -93,10 +121,17 @@ Returns a ``string`` value of this value concept. If the value has another type, .Returns `string` +[caption=""] +.Code examples +[source,cs] +---- +value.AsString(); +---- + [#_object_TypeDB_Driver_Api_IValue_AsUntyped___] ==== AsUntyped -[source,csharp] +[source,cs] ---- object AsUntyped() ---- @@ -110,10 +145,17 @@ Returns an untyped ``object`` value of this value concept. This is useful for va .Returns `object` +[caption=""] +.Code examples +[source,cs] +---- +value.AsUntyped(); +---- + [#_IValue_IConcept__TypeDB_Driver_Api_IValue_AsValue___] ==== AsValue -[source,csharp] +[source,cs] ---- IValue IConcept. AsValue() ---- @@ -131,10 +173,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `IValue IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsValue(); +---- + [#_bool_TypeDB_Driver_Api_IValue_IsBool___] ==== IsBool -[source,csharp] +[source,cs] ---- bool IsBool() ---- @@ -148,10 +197,17 @@ Returns ``True`` if the value which this value concept holds is of type ``bool`` .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +value.IsBool(); +---- + [#_bool_TypeDB_Driver_Api_IValue_IsDateTime___] ==== IsDateTime -[source,csharp] +[source,cs] ---- bool IsDateTime() ---- @@ -165,10 +221,17 @@ Returns ``True`` if the value which this value concept holds is of type ``dateti .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +value.IsDateTime(); +---- + [#_bool_TypeDB_Driver_Api_IValue_IsDouble___] ==== IsDouble -[source,csharp] +[source,cs] ---- bool IsDouble() ---- @@ -182,10 +245,17 @@ Returns ``True`` if the value which this value concept holds is of type ``double .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +value.IsDouble(); +---- + [#_bool_TypeDB_Driver_Api_IValue_IsLong___] ==== IsLong -[source,csharp] +[source,cs] ---- bool IsLong() ---- @@ -199,10 +269,17 @@ Returns ``True`` if the value which this value concept holds is of type ``long`` .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +value.IsLong(); +---- + [#_bool_TypeDB_Driver_Api_IValue_IsString___] ==== IsString -[source,csharp] +[source,cs] ---- bool IsString() ---- @@ -216,10 +293,17 @@ Returns ``True`` if the value which this value concept holds is of type ``string .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +value.IsString(); +---- + [#_bool_IConcept__TypeDB_Driver_Api_IValue_IsValue___] ==== IsValue -[source,csharp] +[source,cs] ---- bool IConcept. IsValue() ---- @@ -237,5 +321,12 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `bool IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsValue(); +---- + // end::methods[] diff --git a/csharp/docs/data/ValueType.adoc b/csharp/docs/data/ValueType.adoc index f8c48e0115..b7bc335e9c 100644 --- a/csharp/docs/data/ValueType.adoc +++ b/csharp/docs/data/ValueType.adoc @@ -10,7 +10,7 @@ Used to specify the type of the value. [caption=""] .Examples -[source,csharp] +[source,cs] ---- thingType.GetOwns(transaction, IValue.ValueType.String); ---- diff --git a/csharp/docs/errors/TypeDBDriverException.adoc b/csharp/docs/errors/TypeDBDriverException.adoc index 07d6e293c4..be0232e91a 100644 --- a/csharp/docs/errors/TypeDBDriverException.adoc +++ b/csharp/docs/errors/TypeDBDriverException.adoc @@ -11,7 +11,7 @@ Exceptions raised by the driver. [#_bool_TypeDB_Driver_Common_TypeDBDriverException_Contains___string_subString_] ==== Contains -[source,csharp] +[source,cs] ---- bool Contains(string subString) ---- @@ -25,10 +25,31 @@ Checks whether a substring is a part of this exception's message. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +try +{ + ... +} +catch (TypeDBDriverException e) +{ + if (e.Contains("CSCO01")) + { + ... + } + else + { + ... + } +} +---- + [#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___ErrorMessage_error__params_object___errorParams_] ==== TypeDBDriverException -[source,csharp] +[source,cs] ---- TypeDBDriverException(ErrorMessage error, params object?[] errorParams) ---- @@ -44,7 +65,7 @@ TypeDBDriverException(ErrorMessage error, params object?[] errorParams) [#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___string_message_] ==== TypeDBDriverException -[source,csharp] +[source,cs] ---- TypeDBDriverException(string message) ---- @@ -60,7 +81,7 @@ TypeDBDriverException(string message) [#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___SystemException_error_] ==== TypeDBDriverException -[source,csharp] +[source,cs] ---- TypeDBDriverException(System::Exception error) ---- @@ -76,7 +97,7 @@ TypeDBDriverException(System::Exception error) [#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___PinvokeError_nativeError_] ==== TypeDBDriverException -[source,csharp] +[source,cs] ---- TypeDBDriverException(Pinvoke::Error nativeError) ---- diff --git a/csharp/docs/logic/ILogicManager.adoc b/csharp/docs/logic/ILogicManager.adoc index e1fe1373b2..155d51c394 100644 --- a/csharp/docs/logic/ILogicManager.adoc +++ b/csharp/docs/logic/ILogicManager.adoc @@ -11,7 +11,7 @@ Provides methods for manipulating rules in the database. [#_Promise__IRule___TypeDB_Driver_Api_ILogicManager_GetRule___string_label_] ==== GetRule -[source,csharp] +[source,cs] ---- Promise< IRule > GetRule(string label) ---- @@ -34,10 +34,17 @@ a| `label` a| The label of the Rule to create or retrieve a| .Returns `Promise< IRule >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Logic.GetRule(label).Resolve() +---- + [#_IEnumerable__IRule___TypeDB_Driver_Api_ILogicManager_GetRules___] ==== GetRules -[source,csharp] +[source,cs] ---- IEnumerable< IRule > GetRules() ---- @@ -51,10 +58,17 @@ Retrieves all rules. .Returns `IEnumerable< IRule >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Logic.GetRules(); +---- + [#_Promise__IRule___TypeDB_Driver_Api_ILogicManager_PutRule___string_label__string_when__string_then_] ==== PutRule -[source,csharp] +[source,cs] ---- Promise< IRule > PutRule(string label, string when, string then) ---- @@ -79,5 +93,12 @@ a| `then` a| The then body of the rule to create a| .Returns `Promise< IRule >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Logic.PutRule(label, when, then).Resolve() +---- + // end::methods[] diff --git a/csharp/docs/logic/IRule.adoc b/csharp/docs/logic/IRule.adoc index 519f08e2b6..bf92279636 100644 --- a/csharp/docs/logic/IRule.adoc +++ b/csharp/docs/logic/IRule.adoc @@ -11,7 +11,7 @@ Rules are a part of schema and define embedded logic. The reasoning engine uses [#_VoidPromise_TypeDB_Driver_Api_IRule_Delete___ITypeDBTransaction_transaction_] ==== Delete -[source,csharp] +[source,cs] ---- VoidPromise Delete(ITypeDBTransaction transaction) ---- @@ -34,10 +34,17 @@ a| `transaction` a| The current ``Transaction`` a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +rule.Delete(transaction).Resolve(); +---- + [#_Promise__bool___TypeDB_Driver_Api_IRule_IsDeleted___ITypeDBTransaction_transaction_] ==== IsDeleted -[source,csharp] +[source,cs] ---- Promise< bool > IsDeleted(ITypeDBTransaction transaction) ---- @@ -60,10 +67,17 @@ a| `transaction` a| The current ``Transaction`` a| .Returns `Promise< bool >` +[caption=""] +.Code examples +[source,cs] +---- +rule.IsDeleted(transaction).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IRule_SetLabel___ITypeDBTransaction_transaction__string_label_] ==== SetLabel -[source,csharp] +[source,cs] ---- VoidPromise SetLabel(ITypeDBTransaction transaction, string label) ---- @@ -87,5 +101,12 @@ a| `label` a| The new label to be given to the rule a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +rule.SetLabel(transaction, newLabel).Resolve(); +---- + // end::methods[] diff --git a/csharp/docs/schema/Annotation.adoc b/csharp/docs/schema/Annotation.adoc index af08651c30..37986ce09b 100644 --- a/csharp/docs/schema/Annotation.adoc +++ b/csharp/docs/schema/Annotation.adoc @@ -11,7 +11,7 @@ Annotation [#_override_bool_TypeDB_Driver_Api_IThingType_Annotation_Equals___object_obj_] ==== Equals -[source,csharp] +[source,cs] ---- override bool Equals(object? obj) ---- @@ -34,10 +34,17 @@ a| `obj` a| Object to compare with a| .Returns `override bool` +[caption=""] +.Code examples +[source,cs] +---- +annotation.Equals(obj); +---- + [#_override_int_TypeDB_Driver_Api_IThingType_Annotation_GetHashCode___] ==== GetHashCode -[source,csharp] +[source,cs] ---- override int GetHashCode() ---- @@ -53,7 +60,7 @@ override int GetHashCode() [#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsKey___] ==== IsKey -[source,csharp] +[source,cs] ---- bool IsKey() ---- @@ -67,10 +74,17 @@ Checks if this ``Annotation`` is a ``@key`` annotation. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +annotation.IsKey(); +---- + [#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsUnique___] ==== IsUnique -[source,csharp] +[source,cs] ---- bool IsUnique() ---- @@ -84,10 +98,17 @@ Checks if this ``Annotation`` is a ``@unique`` annotation. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +annotation.IsUnique(); +---- + [#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewKey___] ==== NewKey -[source,csharp] +[source,cs] ---- static Annotation NewKey() ---- @@ -101,10 +122,18 @@ Produces a ``@key`` annotation. .Returns `static Annotation` +[caption=""] +.Code examples +[source,cs] +---- +using static TypeDB.Driver.Api.IThingType.Annotation; +NewKey(); +---- + [#_static_Annotation_TypeDB_Driver_Api_IThingType_Annotation_NewUnique___] ==== NewUnique -[source,csharp] +[source,cs] ---- static Annotation NewUnique() ---- @@ -118,10 +147,17 @@ Produces a ``@unique`` annotation. .Returns `static Annotation` +[caption=""] +.Code examples +[source,cs] +---- +Annotation.NewUnique(); +---- + [#_override_string_TypeDB_Driver_Api_IThingType_Annotation_ToString___] ==== ToString -[source,csharp] +[source,cs] ---- override string ToString() ---- @@ -135,5 +171,12 @@ Retrieves a string representation of this ``Annotation``. .Returns `override string` +[caption=""] +.Code examples +[source,cs] +---- +annotation.ToString(); +---- + // end::methods[] diff --git a/csharp/docs/schema/IAttributeType.adoc b/csharp/docs/schema/IAttributeType.adoc index 935795a1ae..0bc9bf2c09 100644 --- a/csharp/docs/schema/IAttributeType.adoc +++ b/csharp/docs/schema/IAttributeType.adoc @@ -23,7 +23,7 @@ Multiple types can own the same attribute type, and different instances of the s [#_IAttributeType_IConcept__TypeDB_Driver_Api_IAttributeType_AsAttributeType___] ==== AsAttributeType -[source,csharp] +[source,cs] ---- IAttributeType IConcept. AsAttributeType() ---- @@ -41,10 +41,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `IAttributeType IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsAttributeType(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__IValue_value_] ==== Get -[source,csharp] +[source,cs] ---- Promise< IAttribute > Get(ITypeDBTransaction transaction, IValue value) ---- @@ -68,10 +75,17 @@ a| `value` a| ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Get(transaction, value).Resolve(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__string_value_] ==== Get -[source,csharp] +[source,cs] ---- Promise< IAttribute > Get(ITypeDBTransaction transaction, string value) ---- @@ -95,10 +109,17 @@ a| `value` a| ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Get(transaction, value).Resolve(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__long_value_] ==== Get -[source,csharp] +[source,cs] ---- Promise< IAttribute > Get(ITypeDBTransaction transaction, long value) ---- @@ -122,10 +143,17 @@ a| `value` a| ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Get(transaction, value).Resolve(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__double_value_] ==== Get -[source,csharp] +[source,cs] ---- Promise< IAttribute > Get(ITypeDBTransaction transaction, double value) ---- @@ -149,10 +177,17 @@ a| `value` a| ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Get(transaction, value).Resolve(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__bool_value_] ==== Get -[source,csharp] +[source,cs] ---- Promise< IAttribute > Get(ITypeDBTransaction transaction, bool value) ---- @@ -176,10 +211,17 @@ a| `value` a| ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Get(transaction, value).Resolve(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Get___ITypeDBTransaction_transaction__System_DateTime_value_] ==== Get -[source,csharp] +[source,cs] ---- Promise< IAttribute > Get(ITypeDBTransaction transaction, System.DateTime value) ---- @@ -203,10 +245,17 @@ a| `value` a| ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Get(transaction, value).Resolve(); +---- + [#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction_] ==== GetOwners -[source,csharp] +[source,cs] ---- IEnumerable< IThingType > GetOwners(ITypeDBTransaction transaction) ---- @@ -229,10 +278,17 @@ a| `transaction` a| The current transaction a| .Returns `IEnumerable< IThingType >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.GetOwners(transaction); +---- + [#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] ==== GetOwners -[source,csharp] +[source,cs] ---- IEnumerable< IThingType > GetOwners(ITypeDBTransaction transaction, ICollection< Annotation > annotations) ---- @@ -256,10 +312,17 @@ a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this .Returns `IEnumerable< IThingType >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.GetOwners(transaction, annotations); +---- + [#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] ==== GetOwners -[source,csharp] +[source,cs] ---- IEnumerable< IThingType > GetOwners(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ---- @@ -283,10 +346,17 @@ a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explic .Returns `IEnumerable< IThingType >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.GetOwners(transaction, transitivity); +---- + [#_IEnumerable__IThingType___TypeDB_Driver_Api_IAttributeType_GetOwners___ITypeDBTransaction_transaction__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] ==== GetOwners -[source,csharp] +[source,cs] ---- IEnumerable< IThingType > GetOwners(ITypeDBTransaction transaction, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) ---- @@ -311,10 +381,17 @@ a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explic .Returns `IEnumerable< IThingType >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.GetOwners(transaction, annotations, transitivity); +---- + [#_Promise__string___TypeDB_Driver_Api_IAttributeType_GetRegex___ITypeDBTransaction_transaction_] ==== GetRegex -[source,csharp] +[source,cs] ---- Promise< string > GetRegex(ITypeDBTransaction transaction) ---- @@ -337,10 +414,17 @@ a| `transaction` a| The current transaction a| .Returns `Promise< string >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.GetRegex(transaction).Resolve(); +---- + [#_IEnumerable__IType___TypeDB_Driver_Api_IAttributeType_GetSubtypes___ITypeDBTransaction_transaction__IValue_ValueType_valueType_] ==== GetSubtypes -[source,csharp] +[source,cs] ---- IEnumerable< IType > GetSubtypes(ITypeDBTransaction transaction, IValue.ValueType valueType) ---- @@ -364,10 +448,17 @@ a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| .Returns `IEnumerable< IType >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.GetSubtypes(transaction, valueType); +---- + [#_IEnumerable__IType___TypeDB_Driver_Api_IAttributeType_GetSubtypes___ITypeDBTransaction_transaction__IValue_ValueType_valueType__IConcept_Transitivity_transitivity_] ==== GetSubtypes -[source,csharp] +[source,cs] ---- IEnumerable< IType > GetSubtypes(ITypeDBTransaction transaction, IValue.ValueType valueType, IConcept.Transitivity transitivity) ---- @@ -392,10 +483,17 @@ a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit .Returns `IEnumerable< IType >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.GetSubtypes(transaction, valueType, transitivity); +---- + [#_bool_IConcept__TypeDB_Driver_Api_IAttributeType_IsAttributeType___] ==== IsAttributeType -[source,csharp] +[source,cs] ---- bool IConcept. IsAttributeType() ---- @@ -413,10 +511,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `bool IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsAttributeType(); +---- + [#_bool_TypeDB_Driver_Api_IAttributeType_IsBool___] ==== IsBool -[source,csharp] +[source,cs] ---- bool IsBool() ---- @@ -430,10 +535,17 @@ Returns ``True`` if the value for attributes of this type is of type ``bool``. O .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.IsBool(); +---- + [#_bool_TypeDB_Driver_Api_IAttributeType_IsDateTime___] ==== IsDateTime -[source,csharp] +[source,cs] ---- bool IsDateTime() ---- @@ -447,10 +559,17 @@ Returns ``True`` if the value for attributes of this type is of type ``datetime` .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.IsDateTime(); +---- + [#_bool_TypeDB_Driver_Api_IAttributeType_IsDouble___] ==== IsDouble -[source,csharp] +[source,cs] ---- bool IsDouble() ---- @@ -464,10 +583,17 @@ Returns ``True`` if the value for attributes of this type is of type ``double``. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.IsDouble(); +---- + [#_bool_TypeDB_Driver_Api_IAttributeType_IsLong___] ==== IsLong -[source,csharp] +[source,cs] ---- bool IsLong() ---- @@ -481,10 +607,17 @@ Returns ``True`` if the value for attributes of this type is of type ``long``. O .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.IsLong(); +---- + [#_bool_TypeDB_Driver_Api_IAttributeType_IsString___] ==== IsString -[source,csharp] +[source,cs] ---- bool IsString() ---- @@ -498,10 +631,17 @@ Returns ``True`` if the value for attributes of this type is of type ``string``. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.IsString(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__IValue_value_] ==== Put -[source,csharp] +[source,cs] ---- Promise< IAttribute > Put(ITypeDBTransaction transaction, IValue value) ---- @@ -525,10 +665,17 @@ a| `value` a| New ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Put(transaction, value).Resolve(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__string_value_] ==== Put -[source,csharp] +[source,cs] ---- Promise< IAttribute > Put(ITypeDBTransaction transaction, string value) ---- @@ -552,10 +699,17 @@ a| `value` a| New ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Put(transaction, value).Resolve(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__long_value_] ==== Put -[source,csharp] +[source,cs] ---- Promise< IAttribute > Put(ITypeDBTransaction transaction, long value) ---- @@ -579,10 +733,17 @@ a| `value` a| New ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Put(transaction, value).Resolve(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__double_value_] ==== Put -[source,csharp] +[source,cs] ---- Promise< IAttribute > Put(ITypeDBTransaction transaction, double value) ---- @@ -606,10 +767,17 @@ a| `value` a| New ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Put(transaction, value).Resolve(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__bool_value_] ==== Put -[source,csharp] +[source,cs] ---- Promise< IAttribute > Put(ITypeDBTransaction transaction, bool value) ---- @@ -633,10 +801,17 @@ a| `value` a| New ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Put(transaction, value).Resolve(); +---- + [#_Promise__IAttribute___TypeDB_Driver_Api_IAttributeType_Put___ITypeDBTransaction_transaction__System_DateTime_value_] ==== Put -[source,csharp] +[source,cs] ---- Promise< IAttribute > Put(ITypeDBTransaction transaction, System.DateTime value) ---- @@ -660,10 +835,17 @@ a| `value` a| New ``IAttribute``’s value a| .Returns `Promise< IAttribute >` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.Put(transaction, value).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IAttributeType_SetRegex___ITypeDBTransaction_transaction__string_regex_] ==== SetRegex -[source,csharp] +[source,cs] ---- VoidPromise SetRegex(ITypeDBTransaction transaction, string regex) ---- @@ -689,10 +871,17 @@ a| `regex` a| Regular expression a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.SetRegex(transaction, regex).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IAttributeType_SetSupertype___ITypeDBTransaction_transaction__IAttributeType_attributeType_] ==== SetSupertype -[source,csharp] +[source,cs] ---- VoidPromise SetSupertype(ITypeDBTransaction transaction, IAttributeType attributeType) ---- @@ -716,10 +905,17 @@ a| `attributeType` a| The ``IAttributeType`` to set as the supertype of this ``I .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.SetSupertype(transaction, superType).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IAttributeType_UnsetRegex___ITypeDBTransaction_transaction_] ==== UnsetRegex -[source,csharp] +[source,cs] ---- VoidPromise UnsetRegex(ITypeDBTransaction transaction) ---- @@ -742,5 +938,12 @@ a| `transaction` a| The current transaction a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +attributeType.UnsetRegex(transaction).Resolve(); +---- + // end::methods[] diff --git a/csharp/docs/schema/IEntityType.adoc b/csharp/docs/schema/IEntityType.adoc index 0eefd02558..67ea7779d4 100644 --- a/csharp/docs/schema/IEntityType.adoc +++ b/csharp/docs/schema/IEntityType.adoc @@ -17,7 +17,7 @@ Entity types represent the classification of independent objects in the data mod [#_IEntityType_IConcept__TypeDB_Driver_Api_IEntityType_AsEntityType___] ==== AsEntityType -[source,csharp] +[source,cs] ---- IEntityType IConcept. AsEntityType() ---- @@ -35,10 +35,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `IEntityType IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsEntityType(); +---- + [#_Promise__IEntity___TypeDB_Driver_Api_IEntityType_Create___ITypeDBTransaction_transaction_] ==== Create -[source,csharp] +[source,cs] ---- Promise< IEntity > Create(ITypeDBTransaction transaction) ---- @@ -61,10 +68,17 @@ a| `transaction` a| The current transaction a| .Returns `Promise< IEntity >` +[caption=""] +.Code examples +[source,cs] +---- +entityType.Create(transaction).Resolve(); +---- + [#_bool_IConcept__TypeDB_Driver_Api_IEntityType_IsEntityType___] ==== IsEntityType -[source,csharp] +[source,cs] ---- bool IConcept. IsEntityType() ---- @@ -82,10 +96,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `bool IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsEntityType(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IEntityType_SetSupertype___ITypeDBTransaction_transaction__IEntityType_superEntityType_] ==== SetSupertype -[source,csharp] +[source,cs] ---- VoidPromise SetSupertype(ITypeDBTransaction transaction, IEntityType superEntityType) ---- @@ -109,5 +130,12 @@ a| `superEntityType` a| The ``IEntityType`` to set as the supertype of this ``IE .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +entityType.SetSupertype(transaction, entityType).Resolve(); +---- + // end::methods[] diff --git a/csharp/docs/schema/IRelationType.adoc b/csharp/docs/schema/IRelationType.adoc index 82ee806e57..eeb49235e7 100644 --- a/csharp/docs/schema/IRelationType.adoc +++ b/csharp/docs/schema/IRelationType.adoc @@ -17,7 +17,7 @@ Relation types (or subtypes of the relation root type) represent relationships b [#_IRelationType_IConcept__TypeDB_Driver_Api_IRelationType_AsRelationType___] ==== AsRelationType -[source,csharp] +[source,cs] ---- IRelationType IConcept. AsRelationType() ---- @@ -35,10 +35,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `IRelationType IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsRelationType(); +---- + [#_Promise__IRelation___TypeDB_Driver_Api_IRelationType_Create___ITypeDBTransaction_transaction_] ==== Create -[source,csharp] +[source,cs] ---- Promise< IRelation > Create(ITypeDBTransaction transaction) ---- @@ -61,10 +68,17 @@ a| `transaction` a| The current transaction a| .Returns `Promise< IRelation >` +[caption=""] +.Code examples +[source,cs] +---- +relationType.Create(transaction).Resolve(); +---- + [#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction_] ==== GetRelates -[source,csharp] +[source,cs] ---- IEnumerable< IRoleType > GetRelates(ITypeDBTransaction transaction) ---- @@ -88,7 +102,7 @@ Retrieves roles that this ``IRelationType`` relates to directly or via inheritan [#_IEnumerable__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] ==== GetRelates -[source,csharp] +[source,cs] ---- IEnumerable< IRoleType > GetRelates(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ---- @@ -112,10 +126,17 @@ a| `transitivity` a| ``Transitive`` for direct and inherited relates, ``Explicit .Returns `IEnumerable< IRoleType >` +[caption=""] +.Code examples +[source,cs] +---- +relationType.GetRelates(transaction, transitivity); +---- + [#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelates___ITypeDBTransaction_transaction__string_roleLabel_] ==== GetRelates -[source,csharp] +[source,cs] ---- Promise< IRoleType > GetRelates(ITypeDBTransaction transaction, string roleLabel) ---- @@ -139,10 +160,17 @@ a| `roleLabel` a| Label of the role we wish to retrieve a| .Returns `Promise< IRoleType >` +[caption=""] +.Code examples +[source,cs] +---- +relationType.GetRelates(transaction, roleLabel).Resolve(); +---- + [#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__IRoleType_roleType_] ==== GetRelatesOverridden -[source,csharp] +[source,cs] ---- Promise< IRoleType > GetRelatesOverridden(ITypeDBTransaction transaction, IRoleType roleType) ---- @@ -166,7 +194,7 @@ Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label`` [#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__string_roleLabel_] ==== GetRelatesOverridden -[source,csharp] +[source,cs] ---- Promise< IRoleType > GetRelatesOverridden(ITypeDBTransaction transaction, string roleLabel) ---- @@ -190,10 +218,17 @@ a| `roleLabel` a| Label of the role that overrides an inherited role a| .Returns `Promise< IRoleType >` +[caption=""] +.Code examples +[source,cs] +---- +relationType.GetRelatesOverridden(transaction, roleLabel).Resolve(); +---- + [#_bool_IConcept__TypeDB_Driver_Api_IRelationType_IsRelationType___] ==== IsRelationType -[source,csharp] +[source,cs] ---- bool IConcept. IsRelationType() ---- @@ -211,10 +246,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `bool IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsRelationType(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel_] ==== SetRelates -[source,csharp] +[source,cs] ---- VoidPromise SetRelates(ITypeDBTransaction transaction, string roleLabel) ---- @@ -238,7 +280,7 @@ Sets the new role that this ``IRelationType`` relates to. [#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel__IRoleType_overriddenType_] ==== SetRelates -[source,csharp] +[source,cs] ---- VoidPromise SetRelates(ITypeDBTransaction transaction, string roleLabel, IRoleType overriddenType) ---- @@ -262,7 +304,7 @@ Sets the new role that this ``IRelationType`` relates to. [#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetRelates___ITypeDBTransaction_transaction__string_roleLabel__string_overriddenLabel_] ==== SetRelates -[source,csharp] +[source,cs] ---- VoidPromise SetRelates(ITypeDBTransaction transaction, string roleLabel, string? overriddenLabel) ---- @@ -287,10 +329,18 @@ a| `overriddenLabel` a| The label being overridden, if applicable a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +relationType.SetRelates(transaction, roleLabel).Resolve(); +relationType.SetRelates(transaction, roleLabel, overriddenLabel).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IRelationType_SetSupertype___ITypeDBTransaction_transaction__IRelationType_superRelationType_] ==== SetSupertype -[source,csharp] +[source,cs] ---- VoidPromise SetSupertype(ITypeDBTransaction transaction, IRelationType superRelationType) ---- @@ -314,10 +364,17 @@ a| `superRelationType` a| The ``IRelationType`` to set as the supertype of this .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +relationType.SetSupertype(transaction, superRelationType).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__IRoleType_roleType_] ==== UnsetRelates -[source,csharp] +[source,cs] ---- VoidPromise UnsetRelates(ITypeDBTransaction transaction, IRoleType roleType) ---- @@ -341,7 +398,7 @@ Disallows this ``IRelationType`` from relating to the given role. [#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__string_roleLabel_] ==== UnsetRelates -[source,csharp] +[source,cs] ---- VoidPromise UnsetRelates(ITypeDBTransaction transaction, string roleLabel) ---- @@ -365,5 +422,12 @@ a| `roleLabel` a| The role to not relate to the relation type. a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +relationType.UnsetRelates(transaction, roleLabel).Resolve(); +---- + // end::methods[] diff --git a/csharp/docs/schema/IRoleType.adoc b/csharp/docs/schema/IRoleType.adoc index c369e43b13..0ab89ed960 100644 --- a/csharp/docs/schema/IRoleType.adoc +++ b/csharp/docs/schema/IRoleType.adoc @@ -16,7 +16,7 @@ Roles are special internal types used by relations. We can not create an instanc [#_IRoleType_IConcept__TypeDB_Driver_Api_IRoleType_AsRoleType___] ==== AsRoleType -[source,csharp] +[source,cs] ---- IRoleType IConcept. AsRoleType() ---- @@ -34,10 +34,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `IRoleType IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsRoleType(); +---- + [#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction_] ==== GetPlayerInstances -[source,csharp] +[source,cs] ---- IEnumerable< IThing > GetPlayerInstances(ITypeDBTransaction transaction) ---- @@ -61,7 +68,7 @@ Retrieves the ``Thing`` instances that play this role. [#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] ==== GetPlayerInstances -[source,csharp] +[source,cs] ---- IEnumerable< IThing > GetPlayerInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ---- @@ -85,10 +92,17 @@ a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit` .Returns `IEnumerable< IThing >` +[caption=""] +.Code examples +[source,cs] +---- +roleType.GetPlayerInstances(transaction, transitivity); +---- + [#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction_] ==== GetPlayerTypes -[source,csharp] +[source,cs] ---- IEnumerable< IThingType > GetPlayerTypes(ITypeDBTransaction transaction) ---- @@ -112,7 +126,7 @@ Retrieves the ``ThingType``s whose instances play this role. Equivalent to ``Get [#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] ==== GetPlayerTypes -[source,csharp] +[source,cs] ---- IEnumerable< IThingType > GetPlayerTypes(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ---- @@ -136,10 +150,17 @@ a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit` .Returns `IEnumerable< IThingType >` +[caption=""] +.Code examples +[source,cs] +---- +roleType.GetPlayerTypes(transaction, transitivity) +---- + [#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction_] ==== GetRelationInstances -[source,csharp] +[source,cs] ---- IEnumerable< IRelation > GetRelationInstances(ITypeDBTransaction transaction) ---- @@ -163,7 +184,7 @@ Retrieves the ``Relation`` instances that this role is related to. Equivalent to [#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] ==== GetRelationInstances -[source,csharp] +[source,cs] ---- IEnumerable< IRelation > GetRelationInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ---- @@ -187,10 +208,17 @@ a| `transitivity` a| ``Transitive`` for direct and indirect relation, ``Explicit .Returns `IEnumerable< IRelation >` +[caption=""] +.Code examples +[source,cs] +---- +roleType.GetRelationInstances(transaction, transitivity) +---- + [#_IEnumerable__IRelationType___TypeDB_Driver_Api_IRoleType_GetRelationTypes___ITypeDBTransaction_transaction_] ==== GetRelationTypes -[source,csharp] +[source,cs] ---- IEnumerable< IRelationType > GetRelationTypes(ITypeDBTransaction transaction) ---- @@ -213,10 +241,17 @@ a| `transaction` a| The current transaction a| .Returns `IEnumerable< IRelationType >` +[caption=""] +.Code examples +[source,cs] +---- +roleType.GetRelationTypes(transaction); +---- + [#_bool_IConcept__TypeDB_Driver_Api_IRoleType_IsRoleType___] ==== IsRoleType -[source,csharp] +[source,cs] ---- bool IConcept. IsRoleType() ---- @@ -234,5 +269,12 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `bool IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsRoleType(); +---- + // end::methods[] diff --git a/csharp/docs/schema/IThingType.adoc b/csharp/docs/schema/IThingType.adoc index e968da09c3..4870b3a537 100644 --- a/csharp/docs/schema/IThingType.adoc +++ b/csharp/docs/schema/IThingType.adoc @@ -12,7 +12,7 @@ [#_IThingType_IConcept__TypeDB_Driver_Api_IThingType_AsThingType___] ==== AsThingType -[source,csharp] +[source,cs] ---- IThingType IConcept. AsThingType() ---- @@ -30,10 +30,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `IThingType IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsThingType(); +---- + [#_IEnumerable__IThing___TypeDB_Driver_Api_IThingType_GetInstances___ITypeDBTransaction_transaction_] ==== GetInstances -[source,csharp] +[source,cs] ---- IEnumerable< IThing > GetInstances(ITypeDBTransaction transaction) ---- @@ -57,7 +64,7 @@ Retrieves all ``IThing`` objects that are instances of this ``IThingType`` or it [#_IEnumerable__IThing___TypeDB_Driver_Api_IThingType_GetInstances___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] ==== GetInstances -[source,csharp] +[source,cs] ---- IEnumerable< IThing > GetInstances(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ---- @@ -81,10 +88,18 @@ a| `transitivity` a| ``Explicit`` for direct instances only, ``Transitive`` to i .Returns `IEnumerable< IThing >` +[caption=""] +.Code examples +[source,cs] +---- +thingType.GetInstances(transaction); +thingType.GetInstances(transaction, Explicit); +---- + [#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction_] ==== GetOwns -[source,csharp] +[source,cs] ---- IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction) ---- @@ -108,7 +123,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow [#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType_] ==== GetOwns -[source,csharp] +[source,cs] ---- IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IValue.ValueType valueType) ---- @@ -132,7 +147,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow [#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__ICollection__Annotation___annotations_] ==== GetOwns -[source,csharp] +[source,cs] ---- IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, ICollection< Annotation > annotations) ---- @@ -156,7 +171,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow [#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__ICollection__Annotation___annotations_] ==== GetOwns -[source,csharp] +[source,cs] ---- IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, ICollection< Annotation > annotations) ---- @@ -180,7 +195,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow [#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] ==== GetOwns -[source,csharp] +[source,cs] ---- IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ---- @@ -204,7 +219,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow [#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__IConcept_Transitivity_transitivity_] ==== GetOwns -[source,csharp] +[source,cs] ---- IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, IConcept.Transitivity transitivity) ---- @@ -228,7 +243,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow [#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] ==== GetOwns -[source,csharp] +[source,cs] ---- IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) ---- @@ -252,7 +267,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow [#_IEnumerable__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwns___ITypeDBTransaction_transaction__IValue_ValueType_valueType__ICollection__Annotation___annotations__IConcept_Transitivity_transitivity_] ==== GetOwns -[source,csharp] +[source,cs] ---- IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IValue.ValueType? valueType, ICollection< Annotation > annotations, IConcept.Transitivity transitivity) ---- @@ -278,10 +293,18 @@ a| `annotations` a| Only retrieve attribute types owned with annotations. a| .Returns `IEnumerable< IAttributeType >` +[caption=""] +.Code examples +[source,cs] +---- +thingType.GetOwns(transaction); +thingType.GetOwns(transaction, valueType, Explicit, new []{NewKey()})); +---- + [#_Promise__IAttributeType___TypeDB_Driver_Api_IThingType_GetOwnsOverridden___ITypeDBTransaction_transaction__IAttributeType_attributeType_] ==== GetOwnsOverridden -[source,csharp] +[source,cs] ---- Promise< IAttributeType > GetOwnsOverridden(ITypeDBTransaction transaction, IAttributeType attributeType) ---- @@ -305,10 +328,17 @@ a| `attributeType` a| The ``IAttributeType`` that overrides requested ``IAttribu .Returns `Promise< IAttributeType >` +[caption=""] +.Code examples +[source,cs] +---- +thingType.GetOwnsOverridden(transaction, attributeType).Resolve(); +---- + [#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThingType_GetPlays___ITypeDBTransaction_transaction_] ==== GetPlays -[source,csharp] +[source,cs] ---- IEnumerable< IRoleType > GetPlays(ITypeDBTransaction transaction) ---- @@ -332,7 +362,7 @@ Retrieves all direct and inherited roles that are allowed to be played by the in [#_IEnumerable__IRoleType___TypeDB_Driver_Api_IThingType_GetPlays___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] ==== GetPlays -[source,csharp] +[source,cs] ---- IEnumerable< IRoleType > GetPlays(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ---- @@ -356,10 +386,18 @@ a| `transitivity` a| transitivity: ``Transitive`` for direct and indirect playin .Returns `IEnumerable< IRoleType >` +[caption=""] +.Code examples +[source,cs] +---- +thingType.GetPlays(transaction).Resolve(); +thingType.GetPlays(transaction, Explicit).Resolve(); +---- + [#_Promise__IRoleType___TypeDB_Driver_Api_IThingType_GetPlaysOverridden___ITypeDBTransaction_transaction__IRoleType_roleType_] ==== GetPlaysOverridden -[source,csharp] +[source,cs] ---- Promise< IRoleType > GetPlaysOverridden(ITypeDBTransaction transaction, IRoleType roleType) ---- @@ -383,10 +421,17 @@ a| `roleType` a| The ``IRoleType`` that overrides an inherited role a| .Returns `Promise< IRoleType >` +[caption=""] +.Code examples +[source,cs] +---- +thingType.GetPlaysOverridden(transaction, roleType).Resolve(); +---- + [#_Promise__string___TypeDB_Driver_Api_IThingType_GetSyntax___ITypeDBTransaction_transaction_] ==== GetSyntax -[source,csharp] +[source,cs] ---- Promise< string > GetSyntax(ITypeDBTransaction transaction) ---- @@ -409,10 +454,17 @@ a| `transaction` a| The current transaction a| .Returns `Promise< string >` +[caption=""] +.Code examples +[source,cs] +---- +thingType.GetSyntax(transaction).Resolve(); +---- + [#_bool_IConcept__TypeDB_Driver_Api_IThingType_IsThingType___] ==== IsThingType -[source,csharp] +[source,cs] ---- bool IConcept. IsThingType() ---- @@ -430,10 +482,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `bool IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsThingType(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IThingType_SetAbstract___ITypeDBTransaction_transaction_] ==== SetAbstract -[source,csharp] +[source,cs] ---- VoidPromise SetAbstract(ITypeDBTransaction transaction) ---- @@ -456,10 +515,17 @@ a| `transaction` a| The current transaction a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +thingType.SetAbstract(transaction).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__IAttributeType_overriddenType__ICollection__Annotation___annotations_] ==== SetOwns -[source,csharp] +[source,cs] ---- VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, IAttributeType? overriddenType, ICollection< Annotation > annotations) ---- @@ -485,10 +551,18 @@ a| `annotations` a| Adds annotations to the ownership. a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +thingType.SetOwns(transaction, attributeType).Resolve(); +thingType.SetOwns(transaction, attributeType, overriddenType, new []{NewKey()}).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__IAttributeType_overriddenType_] ==== SetOwns -[source,csharp] +[source,cs] ---- VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, IAttributeType overriddenType) ---- @@ -512,7 +586,7 @@ Allows the instances of this ``IThingType`` to own the given ``IAttributeType``, [#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType__ICollection__Annotation___annotations_] ==== SetOwns -[source,csharp] +[source,cs] ---- VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, ICollection< Annotation > annotations) ---- @@ -536,7 +610,7 @@ Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. [#_VoidPromise_TypeDB_Driver_Api_IThingType_SetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType_] ==== SetOwns -[source,csharp] +[source,cs] ---- VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType) ---- @@ -560,7 +634,7 @@ Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. [#_VoidPromise_TypeDB_Driver_Api_IThingType_SetPlays___ITypeDBTransaction_transaction__IRoleType_roleType_] ==== SetPlays -[source,csharp] +[source,cs] ---- VoidPromise SetPlays(ITypeDBTransaction transaction, IRoleType roleType) ---- @@ -584,7 +658,7 @@ Allows the instances of this ``IThingType`` to play the given role. [#_VoidPromise_TypeDB_Driver_Api_IThingType_SetPlays___ITypeDBTransaction_transaction__IRoleType_roleType__IRoleType_overriddenType_] ==== SetPlays -[source,csharp] +[source,cs] ---- VoidPromise SetPlays(ITypeDBTransaction transaction, IRoleType roleType, IRoleType overriddenType) ---- @@ -609,10 +683,18 @@ a| `overriddenType` a| The role type that this role overrides, if applicable a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +thingType.SetPlays(transaction, roleType).Resolve(); +thingType.SetPlays(transaction, roleType, overriddenType).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetAbstract___ITypeDBTransaction_transaction_] ==== UnsetAbstract -[source,csharp] +[source,cs] ---- VoidPromise UnsetAbstract(ITypeDBTransaction transaction) ---- @@ -635,10 +717,17 @@ a| `transaction` a| The current transaction a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +thingType.UnsetAbstract(transaction).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetOwns___ITypeDBTransaction_transaction__IAttributeType_attributeType_] ==== UnsetOwns -[source,csharp] +[source,cs] ---- VoidPromise UnsetOwns(ITypeDBTransaction transaction, IAttributeType attributeType) ---- @@ -662,10 +751,17 @@ a| `attributeType` a| The ``IAttributeType`` to not be owned by the type. a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +thingType.UnsetOwns(transaction, attributeType).Resolve(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IThingType_UnsetPlays___ITypeDBTransaction_transaction__IRoleType_roleType_] ==== UnsetPlays -[source,csharp] +[source,cs] ---- VoidPromise UnsetPlays(ITypeDBTransaction transaction, IRoleType roleType) ---- @@ -689,5 +785,12 @@ a| `roleType` a| The role to not be played by the instances of this type. a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +thingType.UnsetPlays(transaction, roleType).Resolve(); +---- + // end::methods[] diff --git a/csharp/docs/schema/IType.adoc b/csharp/docs/schema/IType.adoc index c98ac38454..502c3abe3a 100644 --- a/csharp/docs/schema/IType.adoc +++ b/csharp/docs/schema/IType.adoc @@ -11,7 +11,7 @@ [#_IType_IConcept__TypeDB_Driver_Api_IType_AsType___] ==== AsType -[source,csharp] +[source,cs] ---- IType IConcept. AsType() ---- @@ -29,10 +29,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `IType IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.AsType(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IType_Delete___ITypeDBTransaction_transaction_] ==== Delete -[source,csharp] +[source,cs] ---- VoidPromise Delete(ITypeDBTransaction transaction) ---- @@ -55,10 +62,17 @@ a| `transaction` a| The current transaction a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +type.Delete(transaction).Resolve(); +---- + [#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSubtypes___ITypeDBTransaction_transaction_] ==== GetSubtypes -[source,csharp] +[source,cs] ---- IEnumerable< IType > GetSubtypes(ITypeDBTransaction transaction) ---- @@ -82,7 +96,7 @@ Retrieves all direct and indirect subtypes of the type. Equivalent to ``GetSubty [#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSubtypes___ITypeDBTransaction_transaction__IConcept_Transitivity_transitivity_] ==== GetSubtypes -[source,csharp] +[source,cs] ---- IEnumerable< IType > GetSubtypes(ITypeDBTransaction transaction, IConcept.Transitivity transitivity) ---- @@ -106,10 +120,18 @@ a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit .Returns `IEnumerable< IType >` +[caption=""] +.Code examples +[source,cs] +---- +type.GetSubtypes(transaction); +type.GetSubtypes(transaction, Explicit); +---- + [#_Promise__IType___TypeDB_Driver_Api_IType_GetSupertype___ITypeDBTransaction_transaction_] ==== GetSupertype -[source,csharp] +[source,cs] ---- Promise< IType > GetSupertype(ITypeDBTransaction transaction) ---- @@ -132,10 +154,17 @@ a| `transaction` a| The current transaction a| .Returns `Promise< IType >` +[caption=""] +.Code examples +[source,cs] +---- +type.GetSupertype(transaction).Resolve(); +---- + [#_IEnumerable__IType___TypeDB_Driver_Api_IType_GetSupertypes___ITypeDBTransaction_transaction_] ==== GetSupertypes -[source,csharp] +[source,cs] ---- IEnumerable< IType > GetSupertypes(ITypeDBTransaction transaction) ---- @@ -158,10 +187,17 @@ a| `transaction` a| The current transaction a| .Returns `IEnumerable< IType >` +[caption=""] +.Code examples +[source,cs] +---- +type.GetSupertypes(transaction); +---- + [#_bool_TypeDB_Driver_Api_IType_IsAbstract___] ==== IsAbstract -[source,csharp] +[source,cs] ---- bool IsAbstract() ---- @@ -175,10 +211,17 @@ Checks if the type is prevented from having data instances (i.e., ``abstract``). .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +type.IsAbstract(); +---- + [#_Promise__bool___TypeDB_Driver_Api_IType_IsDeleted___ITypeDBTransaction_transaction_] ==== IsDeleted -[source,csharp] +[source,cs] ---- Promise< bool > IsDeleted(ITypeDBTransaction transaction) ---- @@ -201,10 +244,17 @@ a| `transaction` a| The current transaction a| .Returns `Promise< bool >` +[caption=""] +.Code examples +[source,cs] +---- +type.IsDeleted(transaction).Resolve(); +---- + [#_bool_TypeDB_Driver_Api_IType_IsRoot___] ==== IsRoot -[source,csharp] +[source,cs] ---- bool IsRoot() ---- @@ -218,10 +268,17 @@ Checks if the type is a root type. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +type.IsRoot(); +---- + [#_bool_IConcept__TypeDB_Driver_Api_IType_IsType___] ==== IsType -[source,csharp] +[source,cs] ---- bool IConcept. IsType() ---- @@ -239,10 +296,17 @@ Implements TypeDB.Driver.Api.IConcept. .Returns `bool IConcept.` +[caption=""] +.Code examples +[source,cs] +---- +concept.IsType(); +---- + [#_VoidPromise_TypeDB_Driver_Api_IType_SetLabel___ITypeDBTransaction_transaction__string_label_] ==== SetLabel -[source,csharp] +[source,cs] ---- VoidPromise SetLabel(ITypeDBTransaction transaction, string label) ---- @@ -266,5 +330,12 @@ a| `label` a| The new ``Label`` to be given to the type. a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +type.SetLabel(transaction, newLabel).Resolve(); +---- + // end::methods[] diff --git a/csharp/docs/schema/Label.adoc b/csharp/docs/schema/Label.adoc index 4ab4233409..8343cdc880 100644 --- a/csharp/docs/schema/Label.adoc +++ b/csharp/docs/schema/Label.adoc @@ -39,7 +39,7 @@ label.Scope; [#_override_bool_TypeDB_Driver_Common_Label_Equals___object_obj_] ==== Equals -[source,csharp] +[source,cs] ---- override bool Equals(object? obj) ---- @@ -62,10 +62,17 @@ a| `obj` a| Object to compare with a| .Returns `override bool` +[caption=""] +.Code examples +[source,cs] +---- +label.Equals(obj); +---- + [#_override_int_TypeDB_Driver_Common_Label_GetHashCode___] ==== GetHashCode -[source,csharp] +[source,cs] ---- override int GetHashCode() ---- @@ -81,7 +88,7 @@ override int GetHashCode() [#_TypeDB_Driver_Common_Label_Label___string_scope__string_name_] ==== Label -[source,csharp] +[source,cs] ---- Label(string? scope, string name) ---- @@ -105,10 +112,17 @@ a| `name` a| Label name a| .Returns `Label` +[caption=""] +.Code examples +[source,cs] +---- +new Label("relation", "role"); +---- + [#_TypeDB_Driver_Common_Label_Label___string_name_] ==== Label -[source,csharp] +[source,cs] ---- Label(string name) ---- @@ -131,10 +145,17 @@ a| `name` a| Label name a| .Returns `Label` +[caption=""] +.Code examples +[source,cs] +---- +new Label("entity"); +---- + [#_override_string_TypeDB_Driver_Common_Label_ToString___] ==== ToString -[source,csharp] +[source,cs] ---- override string ToString() ---- @@ -148,5 +169,12 @@ Returns the string representation of the scoped name. .Returns `override string` +[caption=""] +.Code examples +[source,cs] +---- +label.ToString(); +---- + // end::methods[] diff --git a/csharp/docs/session/ITypeDBSession.adoc b/csharp/docs/session/ITypeDBSession.adoc index 7791fc6a46..3351e85cd9 100644 --- a/csharp/docs/session/ITypeDBSession.adoc +++ b/csharp/docs/session/ITypeDBSession.adoc @@ -7,7 +7,7 @@ [#_void_TypeDB_Driver_Api_ITypeDBSession_Close___] ==== Close -[source,csharp] +[source,cs] ---- void Close() ---- @@ -21,10 +21,17 @@ Closes the session. Before opening a new session, the session currently open sho .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +session.Close(); +---- + [#_bool_TypeDB_Driver_Api_ITypeDBSession_IsOpen___] ==== IsOpen -[source,csharp] +[source,cs] ---- bool IsOpen() ---- @@ -38,10 +45,17 @@ Checks whether this session is open. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +session.IsOpen(); +---- + [#_void_TypeDB_Driver_Api_ITypeDBSession_OnClose___Action_function_] ==== OnClose -[source,csharp] +[source,cs] ---- void OnClose(Action function) ---- @@ -64,10 +78,17 @@ a| `function` a| The callback function. a| .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +session.OnClose(function); +---- + [#_void_TypeDB_Driver_Api_ITypeDBSession_OnReopen___Action_function_] ==== OnReopen -[source,csharp] +[source,cs] ---- void OnReopen(Action function) ---- @@ -90,10 +111,17 @@ a| `function` a| The callback function. a| .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +session.OnReopen(function); +---- + [#_ITypeDBTransaction_TypeDB_Driver_Api_ITypeDBSession_Transaction___TransactionType_type_] ==== Transaction -[source,csharp] +[source,cs] ---- ITypeDBTransaction Transaction(TransactionType type) ---- @@ -117,7 +145,7 @@ Opens a transaction on the database connected to the session with default option [#_ITypeDBTransaction_TypeDB_Driver_Api_ITypeDBSession_Transaction___TransactionType_type__TypeDBOptions_options_] ==== Transaction -[source,csharp] +[source,cs] ---- ITypeDBTransaction Transaction(TransactionType type, TypeDBOptions options) ---- @@ -141,5 +169,12 @@ a| `options` a| Options for the session a| .Returns `ITypeDBTransaction` +[caption=""] +.Code examples +[source,cs] +---- +session.Transaction(transactionType, options); +---- + // end::methods[] diff --git a/csharp/docs/session/SessionType.adoc b/csharp/docs/session/SessionType.adoc index 4f654782f8..e22b40d7ff 100644 --- a/csharp/docs/session/SessionType.adoc +++ b/csharp/docs/session/SessionType.adoc @@ -10,7 +10,7 @@ Used to specify the type of the session. [caption=""] .Examples -[source,csharp] +[source,cs] ---- driver.Session(database, SessionType.Schema); ---- diff --git a/csharp/docs/session/TypeDBOptions.adoc b/csharp/docs/session/TypeDBOptions.adoc index 5ce607d6f3..e9e73cfc94 100644 --- a/csharp/docs/session/TypeDBOptions.adoc +++ b/csharp/docs/session/TypeDBOptions.adoc @@ -11,7 +11,7 @@ TypeDB session and transaction options. ``TypeDBOptions`` object can be used to [#_bool_TypeDB_Driver_Api_TypeDBOptions_Explain___] ==== Explain -[source,csharp] +[source,cs] ---- bool? Explain() ---- @@ -25,10 +25,17 @@ Returns the value set for the explanation in this ``TypeDBOptions`` object. If s .Returns `bool?` +[caption=""] +.Code examples +[source,cs] +---- +options.Explain(); +---- + [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Explain___bool_explain_] ==== Explain -[source,csharp] +[source,cs] ---- TypeDBOptions Explain(bool explain) ---- @@ -51,10 +58,17 @@ a| `explain` a| Explicitly enable or disable explanations a| .Returns `TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +options.Explain(explain); +---- + [#_bool_TypeDB_Driver_Api_TypeDBOptions_Infer___] ==== Infer -[source,csharp] +[source,cs] ---- bool? Infer() ---- @@ -68,10 +82,17 @@ Returns the value set for the inference in this ``TypeDBOptions`` object. .Returns `bool?` +[caption=""] +.Code examples +[source,cs] +---- +options.Infer(); +---- + [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Infer___bool_infer_] ==== Infer -[source,csharp] +[source,cs] ---- TypeDBOptions Infer(bool infer) ---- @@ -94,10 +115,17 @@ a| `infer` a| Explicitly enable or disable inference a| .Returns `TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +options.Infer(infer); +---- + [#_bool_TypeDB_Driver_Api_TypeDBOptions_Parallel___] ==== Parallel -[source,csharp] +[source,cs] ---- bool? Parallel() ---- @@ -111,10 +139,17 @@ Returns the value set for the parallel execution in this ``TypeDBOptions`` objec .Returns `bool?` +[caption=""] +.Code examples +[source,cs] +---- +options.Parallel(); +---- + [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Parallel___bool_parallel_] ==== Parallel -[source,csharp] +[source,cs] ---- TypeDBOptions Parallel(bool parallel) ---- @@ -137,10 +172,17 @@ a| `parallel` a| Explicitly enable or disable parallel execution a| .Returns `TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +options.Parallel(parallel); +---- + [#_bool_TypeDB_Driver_Api_TypeDBOptions_Prefetch___] ==== Prefetch -[source,csharp] +[source,cs] ---- bool? Prefetch() ---- @@ -154,10 +196,17 @@ Returns the value set for the prefetching in this ``TypeDBOptions`` object. If s .Returns `bool?` +[caption=""] +.Code examples +[source,cs] +---- +options.Prefetch(); +---- + [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_Prefetch___bool_prefetch_] ==== Prefetch -[source,csharp] +[source,cs] ---- TypeDBOptions Prefetch(bool prefetch) ---- @@ -180,10 +229,17 @@ a| `prefetch` a| Explicitly enable or disable prefetching a| .Returns `TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +options.Prefetch(prefetch); +---- + [#_int_TypeDB_Driver_Api_TypeDBOptions_PrefetchSize___] ==== PrefetchSize -[source,csharp] +[source,cs] ---- int? PrefetchSize() ---- @@ -197,10 +253,17 @@ Returns the value set for the prefetch size in this ``TypeDBOptions`` object. If .Returns `int?` +[caption=""] +.Code examples +[source,cs] +---- +options.PrefetchSize(); +---- + [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_PrefetchSize___int_prefetchSize_] ==== PrefetchSize -[source,csharp] +[source,cs] ---- TypeDBOptions PrefetchSize(int prefetchSize) ---- @@ -223,10 +286,17 @@ a| `prefetchSize` a| Number of answers that the server should send before the dr .Returns `TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +options.PrefetchSize(prefetchSize); +---- + [#_bool_TypeDB_Driver_Api_TypeDBOptions_ReadAnyReplica___] ==== ReadAnyReplica -[source,csharp] +[source,cs] ---- bool? ReadAnyReplica() ---- @@ -240,10 +310,17 @@ Returns the value set for reading data from any replica in this ``TypeDBOptions` .Returns `bool?` +[caption=""] +.Code examples +[source,cs] +---- +options.ReadAnyReplica(); +---- + [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_ReadAnyReplica___bool_readAnyReplica_] ==== ReadAnyReplica -[source,csharp] +[source,cs] ---- TypeDBOptions ReadAnyReplica(bool readAnyReplica) ---- @@ -266,10 +343,17 @@ a| `readAnyReplica` a| Explicitly enable or disable reading data from any replic .Returns `TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +options.ReadAnyReplica(readAnyReplica); +---- + [#_int_TypeDB_Driver_Api_TypeDBOptions_SchemaLockAcquireTimeoutMillis___] ==== SchemaLockAcquireTimeoutMillis -[source,csharp] +[source,cs] ---- int? SchemaLockAcquireTimeoutMillis() ---- @@ -283,10 +367,17 @@ Returns the value set for the schema lock acquire timeout in this ``TypeDBOption .Returns `int?` +[caption=""] +.Code examples +[source,cs] +---- +options.SchemaLockAcquireTimeoutMillis(); +---- + [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_SchemaLockAcquireTimeoutMillis___int_schemaLockAcquireTimeoutMillis_] ==== SchemaLockAcquireTimeoutMillis -[source,csharp] +[source,cs] ---- TypeDBOptions SchemaLockAcquireTimeoutMillis(int schemaLockAcquireTimeoutMillis) ---- @@ -309,10 +400,17 @@ a| `schemaLockAcquireTimeoutMillis` a| How long the driver should wait if openin .Returns `TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +options.SchemaLockAcquireTimeoutMillis(schemaLockAcquireTimeoutMillis); +---- + [#_int_TypeDB_Driver_Api_TypeDBOptions_SessionIdleTimeoutMillis___] ==== SessionIdleTimeoutMillis -[source,csharp] +[source,cs] ---- int? SessionIdleTimeoutMillis() ---- @@ -326,10 +424,17 @@ Returns the value set for the session idle timeout in this ``TypeDBOptions`` obj .Returns `int?` +[caption=""] +.Code examples +[source,cs] +---- +options.SessionIdleTimeoutMillis(); +---- + [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_SessionIdleTimeoutMillis___int_sessionIdleTimeoutMillis_] ==== SessionIdleTimeoutMillis -[source,csharp] +[source,cs] ---- TypeDBOptions SessionIdleTimeoutMillis(int sessionIdleTimeoutMillis) ---- @@ -352,10 +457,17 @@ a| `sessionIdleTimeoutMillis` a| timeout that allows the server to close session .Returns `TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +options.SessionIdleTimeoutMillis(sessionIdleTimeoutMillis); +---- + [#_bool_TypeDB_Driver_Api_TypeDBOptions_TraceInference___] ==== TraceInference -[source,csharp] +[source,cs] ---- bool? TraceInference() ---- @@ -369,10 +481,17 @@ Returns the value set for reasoning tracing in this ``TypeDBOptions`` object. If .Returns `bool?` +[caption=""] +.Code examples +[source,cs] +---- +options.TraceInference(); +---- + [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_TraceInference___bool_traceInference_] ==== TraceInference -[source,csharp] +[source,cs] ---- TypeDBOptions TraceInference(bool traceInference) ---- @@ -395,10 +514,17 @@ a| `traceInference` a| Explicitly enable or disable reasoning tracing a| .Returns `TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +options.TraceInference(traceInference); +---- + [#_int_TypeDB_Driver_Api_TypeDBOptions_TransactionTimeoutMillis___] ==== TransactionTimeoutMillis -[source,csharp] +[source,cs] ---- int? TransactionTimeoutMillis() ---- @@ -412,10 +538,17 @@ Returns the value set for the transaction timeout in this ``TypeDBOptions`` obje .Returns `int?` +[caption=""] +.Code examples +[source,cs] +---- +options.TransactionTimeoutMillis(); +---- + [#_TypeDBOptions_TypeDB_Driver_Api_TypeDBOptions_TransactionTimeoutMillis___int_transactionTimeoutMillis_] ==== TransactionTimeoutMillis -[source,csharp] +[source,cs] ---- TypeDBOptions TransactionTimeoutMillis(int transactionTimeoutMillis) ---- @@ -438,10 +571,17 @@ a| `transactionTimeoutMillis` a| Timeout for killing transactions automatically. .Returns `TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +options.TransactionTimeoutMillis(transactionTimeoutMillis); +---- + [#_TypeDB_Driver_Api_TypeDBOptions_TypeDBOptions___] ==== TypeDBOptions -[source,csharp] +[source,cs] ---- TypeDBOptions() ---- @@ -455,5 +595,12 @@ Produces a new ``TypeDBOptions`` object. .Returns `TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +TypeDBOptions options = TypeDBOptions(); +---- + // end::methods[] diff --git a/csharp/docs/transaction/IQueryManager.adoc b/csharp/docs/transaction/IQueryManager.adoc index 4c095c27bc..805019e7b8 100644 --- a/csharp/docs/transaction/IQueryManager.adoc +++ b/csharp/docs/transaction/IQueryManager.adoc @@ -11,7 +11,7 @@ Provides methods for executing TypeQL queries in the transaction. [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query_] ==== Define -[source,csharp] +[source,cs] ---- VoidPromise Define(string query) ---- @@ -35,7 +35,7 @@ Performs a TypeQL Define query with default options. [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query__TypeDBOptions_options_] ==== Define -[source,csharp] +[source,cs] ---- VoidPromise Define(string query, TypeDBOptions options) ---- @@ -59,10 +59,17 @@ a| `options` a| Specify query options a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query.Define(query, options).Resolve() +---- + [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query_] ==== Delete -[source,csharp] +[source,cs] ---- VoidPromise Delete(string query) ---- @@ -86,7 +93,7 @@ Performs a TypeQL Delete query with default options. [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query__TypeDBOptions_options_] ==== Delete -[source,csharp] +[source,cs] ---- VoidPromise Delete(string query, TypeDBOptions options) ---- @@ -110,10 +117,17 @@ a| `options` a| Specify query options a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query.Delete(query, options).Resolve() +---- + [#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable_] ==== Explain -[source,csharp] +[source,cs] ---- IEnumerable< IExplanation > IExplainable explainable) ---- @@ -137,7 +151,7 @@ Performs a TypeQL Explain query with default options. [#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable__TypeDBOptions_options_] ==== Explain -[source,csharp] +[source,cs] ---- IEnumerable< IExplanation > IExplainable explainable, TypeDBOptions options) ---- @@ -161,10 +175,17 @@ a| `options` a| Specify query options a| .Returns `IEnumerable< IExplanation > IExplainable explainable, TypeDBOptions` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query.Explain(explainable, options) +---- + [#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query_] ==== Fetch -[source,csharp] +[source,cs] ---- IEnumerable< JObject > Fetch(string query) ---- @@ -188,7 +209,7 @@ Performs a TypeQL Fetch (Fetch) with default options. [#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query__TypeDBOptions_options_] ==== Fetch -[source,csharp] +[source,cs] ---- IEnumerable< JObject > Fetch(string query, TypeDBOptions options) ---- @@ -212,10 +233,17 @@ a| `options` a| Specify query options a| .Returns `IEnumerable< JObject >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query.Fetch(query, options) +---- + [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query_] ==== Get -[source,csharp] +[source,cs] ---- IEnumerable< IConceptMap > Get(string query) ---- @@ -239,7 +267,7 @@ Performs a TypeQL Get (Get) with default options. [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query__TypeDBOptions_options_] ==== Get -[source,csharp] +[source,cs] ---- IEnumerable< IConceptMap > Get(string query, TypeDBOptions options) ---- @@ -263,10 +291,17 @@ a| `options` a| Specify query options a| .Returns `IEnumerable< IConceptMap >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query.Get(query, options); +---- + [#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query_] ==== GetAggregate -[source,csharp] +[source,cs] ---- Promise< IValue > GetAggregate(string query) ---- @@ -290,7 +325,7 @@ Performs a TypeQL Get Aggregate query with default options. [#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query__TypeDBOptions_options_] ==== GetAggregate -[source,csharp] +[source,cs] ---- Promise< IValue > GetAggregate(string query, TypeDBOptions options) ---- @@ -314,10 +349,17 @@ a| `options` a| Specify query options a| .Returns `Promise< IValue >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query.GetAggregate(query, options).Resolve() +---- + [#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query_] ==== GetGroup -[source,csharp] +[source,cs] ---- IEnumerable< IConceptMapGroup > GetGroup(string query) ---- @@ -341,7 +383,7 @@ Performs a TypeQL Get Group query with default options. [#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query__TypeDBOptions_options_] ==== GetGroup -[source,csharp] +[source,cs] ---- IEnumerable< IConceptMapGroup > GetGroup(string query, TypeDBOptions options) ---- @@ -365,10 +407,17 @@ a| `options` a| Specify query options a| .Returns `IEnumerable< IConceptMapGroup >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query.GetGroup(query, options) +---- + [#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query_] ==== GetGroupAggregate -[source,csharp] +[source,cs] ---- IEnumerable< IValueGroup > GetGroupAggregate(string query) ---- @@ -392,7 +441,7 @@ Performs a TypeQL Get Group Aggregate query with default options. [#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query__TypeDBOptions_options_] ==== GetGroupAggregate -[source,csharp] +[source,cs] ---- IEnumerable< IValueGroup > GetGroupAggregate(string query, TypeDBOptions options) ---- @@ -416,10 +465,17 @@ a| `options` a| Specify query options a| .Returns `IEnumerable< IValueGroup >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query.GetGroupAggregate(query, options) +---- + [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query_] ==== Insert -[source,csharp] +[source,cs] ---- IEnumerable< IConceptMap > Insert(string query) ---- @@ -443,7 +499,7 @@ Performs a TypeQL Insert query with default options. [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query__TypeDBOptions_options_] ==== Insert -[source,csharp] +[source,cs] ---- IEnumerable< IConceptMap > Insert(string query, TypeDBOptions options) ---- @@ -467,10 +523,17 @@ a| `options` a| Specify query options a| .Returns `IEnumerable< IConceptMap >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query.Insert(query, options) +---- + [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query_] ==== Undefine -[source,csharp] +[source,cs] ---- VoidPromise Undefine(string query) ---- @@ -494,7 +557,7 @@ Performs a TypeQL Undefine query with default options. [#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query__TypeDBOptions_options_] ==== Undefine -[source,csharp] +[source,cs] ---- VoidPromise Undefine(string query, TypeDBOptions options) ---- @@ -518,10 +581,17 @@ a| `options` a| Specify query options a| .Returns `VoidPromise` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query.Undefine(query, options).Resolve() +---- + [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query_] ==== Update -[source,csharp] +[source,cs] ---- IEnumerable< IConceptMap > Update(string query) ---- @@ -545,7 +615,7 @@ Performs a TypeQL Update query with default options. [#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query__TypeDBOptions_options_] ==== Update -[source,csharp] +[source,cs] ---- IEnumerable< IConceptMap > Update(string query, TypeDBOptions options) ---- @@ -569,5 +639,12 @@ a| `options` a| Specify query options a| .Returns `IEnumerable< IConceptMap >` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query.Update(query, options) +---- + // end::methods[] diff --git a/csharp/docs/transaction/ITypeDBTransaction.adoc b/csharp/docs/transaction/ITypeDBTransaction.adoc index f28ece3e22..53074b4188 100644 --- a/csharp/docs/transaction/ITypeDBTransaction.adoc +++ b/csharp/docs/transaction/ITypeDBTransaction.adoc @@ -7,7 +7,7 @@ [#_void_TypeDB_Driver_Api_ITypeDBTransaction_Close___] ==== Close -[source,csharp] +[source,cs] ---- void Close() ---- @@ -21,10 +21,17 @@ Closes the transaction. .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Close(); +---- + [#_void_TypeDB_Driver_Api_ITypeDBTransaction_Commit___] ==== Commit -[source,csharp] +[source,cs] ---- void Commit() ---- @@ -38,10 +45,17 @@ Commits the changes made via this transaction to the TypeDB database. Whether or .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Commit(); +---- + [#_bool_TypeDB_Driver_Api_ITypeDBTransaction_IsOpen___] ==== IsOpen -[source,csharp] +[source,cs] ---- bool IsOpen() ---- @@ -55,10 +69,17 @@ Checks whether this transaction is open. .Returns `bool` +[caption=""] +.Code examples +[source,cs] +---- +transaction.IsOpen(); +---- + [#_void_TypeDB_Driver_Api_ITypeDBTransaction_OnClose___Action__Exception___function_] ==== OnClose -[source,csharp] +[source,cs] ---- void OnClose(Action< Exception > function) ---- @@ -81,10 +102,17 @@ a| `function` a| The callback function. a| .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +transaction.OnClose(function); +---- + [#_void_TypeDB_Driver_Api_ITypeDBTransaction_Rollback___] ==== Rollback -[source,csharp] +[source,cs] ---- void Rollback() ---- @@ -98,5 +126,12 @@ Rolls back the uncommitted changes made via this transaction. .Returns `void` +[caption=""] +.Code examples +[source,cs] +---- +transaction.Rollback(); +---- + // end::methods[] diff --git a/csharp/docs/transaction/TransactionType.adoc b/csharp/docs/transaction/TransactionType.adoc index 4c5590c546..d4bcb24ead 100644 --- a/csharp/docs/transaction/TransactionType.adoc +++ b/csharp/docs/transaction/TransactionType.adoc @@ -10,7 +10,7 @@ Used to specify the type of transaction. [caption=""] .Examples -[source,csharp] +[source,cs] ---- session.Transaction(TransactionType.Read); ---- diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index 2fdc7a8d51..371c33c9f9 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -78,7 +78,7 @@ class DoxygenParserCsharp : Callable { classes += parsedEnums } - // class files + // Class (Interface, Struct) files File(inputDirectoryName).walkTopDown().filter { (it.toString().startsWith(htmlDocsDirectoryName + "class_type_") || it.toString().startsWith(htmlDocsDirectoryName + "interface_type_") @@ -90,13 +90,14 @@ class DoxygenParserCsharp : Callable { val parsed = Jsoup.parse(html) val (parsedClass, nestedParsedClasses) = parseClass(parsed) - - if (parsedClass.isNotEmpty()) classes.add(parsedClass) + if (parsedClass.isNotEmpty()) { + classes.add(parsedClass) + } nestedParsedClasses.forEach{ element -> classes.add(element) } } classes.forEach { parsedClass -> - val parsedClassAsciiDoc = parsedClass.toAsciiDoc("csharp") + val parsedClassAsciiDoc = parsedClass.toAsciiDoc("cs") val outputFile = getFile(docsDir, "${generateFilename(parsedClass.name)}.adoc") outputFile.writeText(parsedClassAsciiDoc) } @@ -141,8 +142,11 @@ class DoxygenParserCsharp : Callable { missingDeclarations.add(element.selectFirst("td.memItemRight")!!.text()) } else { - if (type == "enum") { - nestedClasses.add(parseEnum(element, memberDetails)) + if (type == "enum") { // Enums that are members of a class + val parsedEnum = parseEnum(element, memberDetails) + if (parsedEnum.isNotEmpty()) { + nestedClasses.add(parsedEnum) + } } else { members.add(memberDetails) @@ -241,7 +245,7 @@ class DoxygenParserCsharp : Callable { val methodDescr: List = element.selectFirst("div.memdoc") ?.let { splitToParagraphs(it.html()) } ?.map { replaceSpaces(reformatTextWithCode(it.substringBefore(" pre + div pre").map { replaceSpaces(it.text()) } + val methodExamples = element.select("div.memdoc > pre").map { replaceSpaces(it.text()) } val methodArgs = element.select("table.params > tbody > tr") .map { From 3edf7c7f110a02f998c187e358862f25d68ff0b1 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Fri, 22 Mar 2024 16:41:57 +0000 Subject: [PATCH 035/118] Finish generated docs for C#, fix automation.yml, README and integration tests --- .factory/automation.yml | 54 +- c/docs/answer/conceptmap.adoc | 287 ---------- c/docs/answer/explanation.adoc | 386 ------------- c/docs/answer/primitives.adoc | 195 ------- c/docs/answer/valuegroup.adoc | 129 ----- c/docs/concept/attribute.adoc | 51 -- c/docs/concept/concept.adoc | 472 ---------------- c/docs/concept/entity.adoc | 19 - c/docs/concept/relation.adoc | 109 ---- c/docs/concept/roleplayer.adoc | 97 ---- c/docs/concept/thing.adoc | 466 --------------- c/docs/concept/value.adoc | 243 -------- c/docs/connection/connection.adoc | 130 ----- c/docs/connection/credential.adoc | 55 -- c/docs/connection/database.adoc | 296 ---------- c/docs/connection/replica.adoc | 129 ----- c/docs/connection/user.adoc | 289 ---------- c/docs/errors/error.adoc | 96 ---- c/docs/errors/schemaexception.adoc | 97 ---- c/docs/logic/logic.adoc | 63 --- c/docs/logic/rule.adoc | 200 ------- c/docs/schema/annotation.adoc | 122 ---- c/docs/schema/attributetype.adoc | 223 -------- c/docs/schema/entitytype.adoc | 99 ---- c/docs/schema/relationtype.adoc | 179 ------ c/docs/schema/roletype.adoc | 243 -------- c/docs/schema/transitivity.adoc | 31 - c/docs/schema/valuetype.adoc | 51 -- c/docs/session/options.adoc | 533 ------------------ c/docs/session/session.adoc | 189 ------- c/docs/transaction/query.adoc | 190 ------- c/docs/transaction/transaction.adoc | 173 ------ cpp/README.md | 2 +- csharp/Test/Integration/Examples/BUILD | 17 +- .../Integration/Examples/CloudExamplesTest.cs | 125 ++++ .../{ExamplesTest.cs => CoreExamplesTest.cs} | 120 ++-- csharp/docs/answer/IConceptMap.adoc | 24 + csharp/docs/answer/IConceptMapGroup.adoc | 24 + csharp/docs/answer/IExplainable.adoc | 51 ++ csharp/docs/answer/IExplanation.adoc | 72 +++ csharp/docs/answer/IValueGroup.adoc | 51 ++ csharp/docs/concept/IConceptManager.adoc | 72 +++ csharp/docs/connection/IDatabase.adoc | 72 +++ csharp/docs/connection/IReplica.adoc | 32 ++ csharp/docs/connection/ITypeDBDriver.adoc | 48 ++ csharp/docs/connection/IUser.adoc | 32 ++ csharp/docs/data/IAttribute.adoc | 24 + csharp/docs/data/IThing.adoc | 48 ++ csharp/docs/data/IValue.adoc | 24 + csharp/docs/logic/IRule.adoc | 48 ++ csharp/docs/schema/IAttributeType.adoc | 24 + csharp/docs/schema/IType.adoc | 24 + csharp/docs/schema/Label.adoc | 24 + csharp/docs/session/ITypeDBSession.adoc | 72 +++ .../docs/transaction/ITypeDBTransaction.adoc | 120 ++++ tool/docs/csharp/DoxygenParserCsharp.kt | 31 +- tool/docs/update.sh | 1 + 57 files changed, 1138 insertions(+), 5940 deletions(-) delete mode 100644 c/docs/answer/conceptmap.adoc delete mode 100644 c/docs/answer/explanation.adoc delete mode 100644 c/docs/answer/primitives.adoc delete mode 100644 c/docs/answer/valuegroup.adoc delete mode 100644 c/docs/concept/attribute.adoc delete mode 100644 c/docs/concept/concept.adoc delete mode 100644 c/docs/concept/entity.adoc delete mode 100644 c/docs/concept/relation.adoc delete mode 100644 c/docs/concept/roleplayer.adoc delete mode 100644 c/docs/concept/thing.adoc delete mode 100644 c/docs/concept/value.adoc delete mode 100644 c/docs/connection/connection.adoc delete mode 100644 c/docs/connection/credential.adoc delete mode 100644 c/docs/connection/database.adoc delete mode 100644 c/docs/connection/replica.adoc delete mode 100644 c/docs/connection/user.adoc delete mode 100644 c/docs/errors/error.adoc delete mode 100644 c/docs/errors/schemaexception.adoc delete mode 100644 c/docs/logic/logic.adoc delete mode 100644 c/docs/logic/rule.adoc delete mode 100644 c/docs/schema/annotation.adoc delete mode 100644 c/docs/schema/attributetype.adoc delete mode 100644 c/docs/schema/entitytype.adoc delete mode 100644 c/docs/schema/relationtype.adoc delete mode 100644 c/docs/schema/roletype.adoc delete mode 100644 c/docs/schema/transitivity.adoc delete mode 100644 c/docs/schema/valuetype.adoc delete mode 100644 c/docs/session/options.adoc delete mode 100644 c/docs/session/session.adoc delete mode 100644 c/docs/transaction/query.adoc delete mode 100644 c/docs/transaction/transaction.adoc create mode 100644 csharp/Test/Integration/Examples/CloudExamplesTest.cs rename csharp/Test/Integration/Examples/{ExamplesTest.cs => CoreExamplesTest.cs} (98%) diff --git a/.factory/automation.yml b/.factory/automation.yml index ddb09aa7f5..ecb5d03620 100644 --- a/.factory/automation.yml +++ b/.factory/automation.yml @@ -69,7 +69,7 @@ build: curl -L https://github.com/doxygen/doxygen/releases/download/Release_1_10_0/doxygen-1.10.0.linux.bin.tar.gz | tar xzO doxygen-1.10.0/bin/doxygen > /var/tmp/doxygen && sudo mv /var/tmp/doxygen /usr/local/bin/ && sudo chmod +x /usr/local/bin/doxygen bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - DOCS_DIRS="java/docs nodejs/docs python/docs rust/docs cpp/docs c/docs" + DOCS_DIRS="java/docs nodejs/docs python/docs rust/docs cpp/docs c/docs csharp/docs" rm -rf $DOCS_DIRS tool/docs/update.sh git add $DOCS_DIRS @@ -447,24 +447,40 @@ build: # export TEST_SUCCESS=0 || export TEST_SUCCESS=1 # tool/test/stop-cloud-servers.sh # exit $TEST_SUCCESS -# -# test-csharp-integration-core: -# image: vaticle-ubuntu-22.04 -# dependencies: -# - build -# type: foreground -# command: | -# sudo apt-get update -# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME -# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD -# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh -# bazel run @vaticle_dependencies//distribution/artifact:create-netrc -# tool/test/start-core-server.sh && -# bazel test //csharp/Test/Integration/... --test_output=streamed --jobs=1 && -# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 -# tool/test/stop-core-server.sh -# exit $TEST_SUCCESS -# + + test-csharp-integration-core: + image: vaticle-ubuntu-22.04 + dependencies: + - build + type: foreground + command: | + sudo apt-get update + export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME + export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD + bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh + bazel run @vaticle_dependencies//distribution/artifact:create-netrc + tool/test/start-core-server.sh && + bazel test //csharp/Test/Integration/... --test_output=streamed --jobs=1 && + export TEST_SUCCESS=0 || export TEST_SUCCESS=1 + tool/test/stop-core-server.sh + exit $TEST_SUCCESS + + test-csharp-integration-cloud: + image: vaticle-ubuntu-22.04 + dependencies: + - build + type: foreground + command: | + export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME + export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD + bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh + bazel run @vaticle_dependencies//distribution/artifact:create-netrc + source tool/test/start-cloud-servers.sh && + .factory/test-cloud.sh //csharp/Test/Integration/Examples/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && + export TEST_SUCCESS=0 || export TEST_SUCCESS=1 + tool/test/stop-cloud-servers.sh + exit $TEST_SUCCESS + # test-csharp-behaviour-core: # image: vaticle-ubuntu-22.04 # dependencies: diff --git a/c/docs/answer/conceptmap.adoc b/c/docs/answer/conceptmap.adoc deleted file mode 100644 index d4b85d78a5..0000000000 --- a/c/docs/answer/conceptmap.adoc +++ /dev/null @@ -1,287 +0,0 @@ -[#_methods__answer__conceptmap] -=== conceptmap - -[#_Struct_ConceptMap] -==== Struct ConceptMap - - - -Contains a mapping of variables to concepts. - -[#_Struct_ConceptMapGroup] -==== Struct ConceptMapGroup - - - -Contains an element of the TypeQL Get Group query result. - -[#_Struct_ConceptMapGroupIterator] -==== Struct ConceptMapGroupIterator - - - -Iterator over the ``ConceptMapGroup``s in the result of the TypeQL Get Group query. - -[#_Struct_ConceptMapIterator] -==== Struct ConceptMapIterator - - - -Iterator over the ``ConceptMap``s in the result of a TypeQL Get query. - -[#_concept_map_drop] -==== concept_map_drop - -[source,cpp] ----- -void concept_map_drop(struct ConceptMap* concept_map) ----- - - - -Frees the native rust ``ConceptMap`` object - -[caption=""] -.Returns -`void` - -[#_concept_map_equals] -==== concept_map_equals - -[source,cpp] ----- -bool concept_map_equals(const struct ConceptMap* lhs, const struct ConceptMap* rhs) ----- - - - -Checks whether the provided ``ConceptMap`` objects are equal - -[caption=""] -.Returns -`bool` - -[#_concept_map_get] -==== concept_map_get - -[source,cpp] ----- -struct Concept* concept_map_get(const struct ConceptMap* concept_map, const char* var) ----- - - - -Retrieves a concept for a given variable name. - -[caption=""] -.Returns -`struct Concept*` - -[#_concept_map_get_explainables] -==== concept_map_get_explainables - -[source,cpp] ----- -struct Explainables* concept_map_get_explainables(const struct ConceptMap* concept_map) ----- - - - -Gets the ``Explainables`` object for this ``ConceptMap``, exposing which of the concepts in this ``ConceptMap`` are explainable. - -[caption=""] -.Returns -`struct Explainables*` - -[#_concept_map_get_values] -==== concept_map_get_values - -[source,cpp] ----- -struct ConceptIterator* concept_map_get_values(const struct ConceptMap* concept_map) ----- - - - -Produces an ``Iterator`` over all ``Concepts`` in this ``ConceptMap``. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_concept_map_get_variables] -==== concept_map_get_variables - -[source,cpp] ----- -struct StringIterator* concept_map_get_variables(const struct ConceptMap* concept_map) ----- - - - -Produces an ``Iterator`` over all variables in this ``ConceptMap``. - -[caption=""] -.Returns -`struct StringIterator*` - -[#_concept_map_group_drop] -==== concept_map_group_drop - -[source,cpp] ----- -void concept_map_group_drop(struct ConceptMapGroup* concept_map_group) ----- - - - -Frees the native rust ``ConceptMapGroup`` object - -[caption=""] -.Returns -`void` - -[#_concept_map_group_equals] -==== concept_map_group_equals - -[source,cpp] ----- -bool concept_map_group_equals(const struct ConceptMapGroup* lhs, const struct ConceptMapGroup* rhs) ----- - - - -Checks whether the provided ``ConceptMapGroup`` objects are equal - -[caption=""] -.Returns -`bool` - -[#_concept_map_group_get_concept_maps] -==== concept_map_group_get_concept_maps - -[source,cpp] ----- -struct ConceptMapIterator* concept_map_group_get_concept_maps(const struct ConceptMapGroup* concept_map_group) ----- - - - -Retrieves the ``ConceptMap``s of the group. - -[caption=""] -.Returns -`struct ConceptMapIterator*` - -[#_concept_map_group_get_owner] -==== concept_map_group_get_owner - -[source,cpp] ----- -struct Concept* concept_map_group_get_owner(const struct ConceptMapGroup* concept_map_group) ----- - - - -Retrieves the concept that is the group owner. - -[caption=""] -.Returns -`struct Concept*` - -[#_concept_map_group_iterator_drop] -==== concept_map_group_iterator_drop - -[source,cpp] ----- -void concept_map_group_iterator_drop(struct ConceptMapGroupIterator* it) ----- - - - -Frees the native rust ``ConceptMapGroupIterator`` object - -[caption=""] -.Returns -`void` - -[#_concept_map_group_iterator_next] -==== concept_map_group_iterator_next - -[source,cpp] ----- -struct ConceptMapGroup* concept_map_group_iterator_next(struct ConceptMapGroupIterator* it) ----- - - - -Forwards the ``ConceptMapGroupIterator`` and returns the next ``ConceptMapGroup`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct ConceptMapGroup*` - -[#_concept_map_group_to_string] -==== concept_map_group_to_string - -[source,cpp] ----- -char* concept_map_group_to_string(const struct ConceptMapGroup* concept_map_group) ----- - - - -A string representation of this ``ConceptMapGroup`` object - -[caption=""] -.Returns -`char*` - -[#_concept_map_iterator_drop] -==== concept_map_iterator_drop - -[source,cpp] ----- -void concept_map_iterator_drop(struct ConceptMapIterator* it) ----- - - - -Frees the native rust ``ConceptMapIterator`` object - -[caption=""] -.Returns -`void` - -[#_concept_map_iterator_next] -==== concept_map_iterator_next - -[source,cpp] ----- -struct ConceptMap* concept_map_iterator_next(struct ConceptMapIterator* it) ----- - - - -Forwards the ``ConceptMapIterator`` and returns the next ``ConceptMap`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct ConceptMap*` - -[#_concept_map_to_string] -==== concept_map_to_string - -[source,cpp] ----- -char* concept_map_to_string(const struct ConceptMap* concept_map) ----- - - - -A string representation of this ConceptMap. - -[caption=""] -.Returns -`char*` - diff --git a/c/docs/answer/explanation.adoc b/c/docs/answer/explanation.adoc deleted file mode 100644 index 808daff67f..0000000000 --- a/c/docs/answer/explanation.adoc +++ /dev/null @@ -1,386 +0,0 @@ -[#_methods__answer__explanation] -=== explanation - -[#_Struct_Explainable] -==== Struct Explainable - - - -Contains an explainable object. - -[#_Struct_Explainables] -==== Struct Explainables - - - -Contains explainable objects. - -[#_explainable_drop] -==== explainable_drop - -[source,cpp] ----- -void explainable_drop(struct Explainable* explainable) ----- - - - -Frees the native rust ``Explainable`` object - -[caption=""] -.Returns -`void` - -[#_explainable_get_conjunction] -==== explainable_get_conjunction - -[source,cpp] ----- -char* explainable_get_conjunction(const struct Explainable* explainable) ----- - - - -Retrieves the subquery of the original query that is actually being explained. - -[caption=""] -.Returns -`char*` - -[#_explainable_get_id] -==== explainable_get_id - -[source,cpp] ----- -int64_t explainable_get_id(const struct Explainable* explainable) ----- - - - -Retrieves the unique ID that identifies this ``Explainable``. - -[caption=""] -.Returns -`int64_t` - -[#_explainables_drop] -==== explainables_drop - -[source,cpp] ----- -void explainables_drop(struct Explainables* explainables) ----- - - - -Frees the native rust ``Explainables`` object - -[caption=""] -.Returns -`void` - -[#_explainables_equals] -==== explainables_equals - -[source,cpp] ----- -bool explainables_equals(const struct Explainables* lhs, const struct Explainables* rhs) ----- - - - -Checks whether the provided ``Explainables`` objects are equal - -[caption=""] -.Returns -`bool` - -[#_explainables_get_attribute] -==== explainables_get_attribute - -[source,cpp] ----- -struct Explainable* explainables_get_attribute(const struct Explainables* explainables, const char* var) ----- - - - -Retrieves the explainable attribute with the given variable name. - -[caption=""] -.Returns -`struct Explainable*` - -[#_explainables_get_attributes_keys] -==== explainables_get_attributes_keys - -[source,cpp] ----- -struct StringIterator* explainables_get_attributes_keys(const struct Explainables* explainables) ----- - - - -Retrieves all variables corresponding to this ``ConceptMap``’s explainable attributes. - -[caption=""] -.Returns -`struct StringIterator*` - -[#_explainables_get_ownership] -==== explainables_get_ownership - -[source,cpp] ----- -struct Explainable* explainables_get_ownership(const struct Explainables* explainables, const char* owner, const char* attribute) ----- - - - -Retrieves the explainable attribute ownership with the pair of (owner, attribute) variable names. - -[caption=""] -.Returns -`struct Explainable*` - -[#_explainables_get_ownerships_keys] -==== explainables_get_ownerships_keys - -[source,cpp] ----- -struct StringPairIterator* explainables_get_ownerships_keys(const struct Explainables* explainables) ----- - - - -Retrieves all variables corresponding to this ``ConceptMap``’s explainable ownerships. - -[caption=""] -.Returns -`struct StringPairIterator*` - -[#_explainables_get_relation] -==== explainables_get_relation - -[source,cpp] ----- -struct Explainable* explainables_get_relation(const struct Explainables* explainables, const char* var) ----- - - - -Retrieves the explainable relation with the given variable name. - -[caption=""] -.Returns -`struct Explainable*` - -[#_explainables_get_relations_keys] -==== explainables_get_relations_keys - -[source,cpp] ----- -struct StringIterator* explainables_get_relations_keys(const struct Explainables* explainables) ----- - - - -Retrieves all variables corresponding to this ``ConceptMap``’s explainable relations. - -[caption=""] -.Returns -`struct StringIterator*` - -[#_explainables_to_string] -==== explainables_to_string - -[source,cpp] ----- -char* explainables_to_string(const struct Explainables* explainables) ----- - - - -A string representation of this ``Explainables`` object - -[caption=""] -.Returns -`char*` - -[#_methods__answer__explanation] -=== explanation - -[#_Struct_Explanation] -==== Struct Explanation - - - -An explanation of which rule was used for inferring the explained concept, the condition of the rule, the conclusion of the rule, and the mapping of variables between the query and the rule’s conclusion. - -[#_Struct_ExplanationIterator] -==== Struct ExplanationIterator - - - -Iterator over the ``Explanation``s in the result of the explain query. - -[#_explanation_drop] -==== explanation_drop - -[source,cpp] ----- -void explanation_drop(struct Explanation* explanation) ----- - - - -Frees the native rust ``Explanation`` object - -[caption=""] -.Returns -`void` - -[#_explanation_equals] -==== explanation_equals - -[source,cpp] ----- -bool explanation_equals(const struct Explanation* lhs, const struct Explanation* rhs) ----- - - - -Checks whether the provided ``Explanation`` objects are equal - -[caption=""] -.Returns -`bool` - -[#_explanation_get_conclusion] -==== explanation_get_conclusion - -[source,cpp] ----- -struct ConceptMap* explanation_get_conclusion(const struct Explanation* explanation) ----- - - - -Retrieves the Conclusion for this Explanation. - -[caption=""] -.Returns -`struct ConceptMap*` - -[#_explanation_get_condition] -==== explanation_get_condition - -[source,cpp] ----- -struct ConceptMap* explanation_get_condition(const struct Explanation* explanation) ----- - - - -Retrieves the Condition for this Explanation. - -[caption=""] -.Returns -`struct ConceptMap*` - -[#_explanation_get_mapped_variables] -==== explanation_get_mapped_variables - -[source,cpp] ----- -struct StringIterator* explanation_get_mapped_variables(const struct Explanation* explanation) ----- - - - -Retrieves the query variables for this ``Explanation``. - -[caption=""] -.Returns -`struct StringIterator*` - -[#_explanation_get_mapping] -==== explanation_get_mapping - -[source,cpp] ----- -struct StringIterator* explanation_get_mapping(const struct Explanation* explanation, const char* var) ----- - - - -Retrieves the rule variables corresponding to the query variable var for this ``Explanation``. - -[caption=""] -.Returns -`struct StringIterator*` - -[#_explanation_get_rule] -==== explanation_get_rule - -[source,cpp] ----- -struct Rule* explanation_get_rule(const struct Explanation* explanation) ----- - - - -Retrieves the Rule for this Explanation. - -[caption=""] -.Returns -`struct Rule*` - -[#_explanation_iterator_drop] -==== explanation_iterator_drop - -[source,cpp] ----- -void explanation_iterator_drop(struct ExplanationIterator* it) ----- - - - -Frees the native rust ``ExplanationIterator`` object - -[caption=""] -.Returns -`void` - -[#_explanation_iterator_next] -==== explanation_iterator_next - -[source,cpp] ----- -struct Explanation* explanation_iterator_next(struct ExplanationIterator* it) ----- - - - -Forwards the ``Explanation`` and returns the next ``Explanation`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct Explanation*` - -[#_explanation_to_string] -==== explanation_to_string - -[source,cpp] ----- -char* explanation_to_string(const struct Explanation* explanation) ----- - - - -A string representation of this ``Explanation`` object - -[caption=""] -.Returns -`char*` - diff --git a/c/docs/answer/primitives.adoc b/c/docs/answer/primitives.adoc deleted file mode 100644 index 8ee02bd7f2..0000000000 --- a/c/docs/answer/primitives.adoc +++ /dev/null @@ -1,195 +0,0 @@ -[#_methods__answer__primitives] -=== primitives - -[#_Struct_StringIterator] -==== Struct StringIterator - - - -Iterator over the strings in the result of a request or a TypeQL Fetch query. - -[#_Struct_StringPair] -==== Struct StringPair - - - -A ``StringPair`` used to represent the pair of variables involved in an ownership. ``_0`` and ``_1`` are the owner and attribute variables respectively. - -[#_Struct_StringPairIterator] -==== Struct StringPairIterator - - - -Iterator over the ``StringPair``s representing explainable owner-attribute variable pairs - -[#_Struct_StringPromise] -==== Struct StringPromise - - - -Promise object representing the result of an asynchronous operation. Use string_promise_resolve(StringPromise*) to wait for and retrieve the resulting string. - -[#_string_free] -==== string_free - -[source,cpp] ----- -void string_free(char* str) ----- - - - -Frees a native rust string. _WARNING: Always use this function to free strings returned by the driver. Using the standard C free function will create a dangling reference on the rust side._ - -[caption=""] -.Returns -`void` - -[#_string_iterator_drop] -==== string_iterator_drop - -[source,cpp] ----- -void string_iterator_drop(struct StringIterator* it) ----- - - - -Frees the native rust ``StringIterator`` object - -[caption=""] -.Returns -`void` - -[#_string_iterator_next] -==== string_iterator_next - -[source,cpp] ----- -char* string_iterator_next(struct StringIterator* it) ----- - - - -Forwards the ``StringIterator`` and returns the next string if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`char*` - -[#_string_pair_drop] -==== string_pair_drop - -[source,cpp] ----- -void string_pair_drop(struct StringPair* string_pair) ----- - - - -Frees the native rust ``StringPair`` object - -[caption=""] -.Returns -`void` - -[#_string_pair_iterator_drop] -==== string_pair_iterator_drop - -[source,cpp] ----- -void string_pair_iterator_drop(struct StringPairIterator* it) ----- - - - -Frees the native rust ``StringPairIterator`` object - -[caption=""] -.Returns -`void` - -[#_string_pair_iterator_next] -==== string_pair_iterator_next - -[source,cpp] ----- -struct StringPair* string_pair_iterator_next(struct StringPairIterator* it) ----- - - - -Forwards the ``StringIterator`` and returns the next ``StringPair`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct StringPair*` - -[#_string_promise_resolve] -==== string_promise_resolve - -[source,cpp] ----- -char* string_promise_resolve(struct StringPromise* promise) ----- - - - -Waits for and returns the result of the operation represented by the ``BoolPromise`` object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved. - -[caption=""] -.Returns -`char*` - -[#_methods__answer__primitives] -=== primitives - -[#_Struct_BoolPromise] -==== Struct BoolPromise - - - -Promise object representing the result of an asynchronous operation. Use bool_promise_resolve(BoolPromise*) to wait for and retrieve the resulting boolean value. - -[#_bool_promise_resolve] -==== bool_promise_resolve - -[source,cpp] ----- -bool bool_promise_resolve(struct BoolPromise* promise) ----- - - - -Waits for and returns the result of the operation represented by the ``BoolPromise`` object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved. - -[caption=""] -.Returns -`bool` - -[#_methods__answer__primitives] -=== primitives - -[#_Struct_VoidPromise] -==== Struct VoidPromise - - - -Promise object representing the result of an asynchronous operation. A VoidPromise does not return a value, but must be resolved using void_promise_resolve(VoidPromise*) to ensure the operation has completed, or for a failed operation to set the error. - -[#_void_promise_resolve] -==== void_promise_resolve - -[source,cpp] ----- -void void_promise_resolve(struct VoidPromise* promise) ----- - - - -Waits for the operation represented by the ``VoidPromise`` to complete. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved. - -[caption=""] -.Returns -`void` - diff --git a/c/docs/answer/valuegroup.adoc b/c/docs/answer/valuegroup.adoc deleted file mode 100644 index 4a06fe5c91..0000000000 --- a/c/docs/answer/valuegroup.adoc +++ /dev/null @@ -1,129 +0,0 @@ -[#_methods__answer__valuegroup] -=== valuegroup - -[#_Struct_ValueGroup] -==== Struct ValueGroup - - - -Contains an element of a TypeQL Get Group Aggregate query result. - -[#_Struct_ValueGroupIterator] -==== Struct ValueGroupIterator - - - -Iterator over the ``ValueGroup``s in the result of the Get Group Aggregate query. - -[#_value_group_drop] -==== value_group_drop - -[source,cpp] ----- -void value_group_drop(struct ValueGroup* value_group) ----- - - - -Frees the native rust ``ValueGroup`` object - -[caption=""] -.Returns -`void` - -[#_value_group_equals] -==== value_group_equals - -[source,cpp] ----- -bool value_group_equals(const struct ValueGroup* lhs, const struct ValueGroup* rhs) ----- - - - -Checks whether the provided ``ValueGroup`` objects are equal - -[caption=""] -.Returns -`bool` - -[#_value_group_get_owner] -==== value_group_get_owner - -[source,cpp] ----- -struct Concept* value_group_get_owner(struct ValueGroup* value_group) ----- - - - -Retrieves the concept that is the group owner. - -[caption=""] -.Returns -`struct Concept*` - -[#_value_group_get_value] -==== value_group_get_value - -[source,cpp] ----- -struct Concept* value_group_get_value(struct ValueGroup* value_group) ----- - - - -Retrieves the ``Value`` answer of the group. - -[caption=""] -.Returns -`struct Concept*` - -[#_value_group_iterator_drop] -==== value_group_iterator_drop - -[source,cpp] ----- -void value_group_iterator_drop(struct ValueGroupIterator* it) ----- - - - -Frees the native rust ``ValueGroupIterator`` object - -[caption=""] -.Returns -`void` - -[#_value_group_iterator_next] -==== value_group_iterator_next - -[source,cpp] ----- -struct ValueGroup* value_group_iterator_next(struct ValueGroupIterator* it) ----- - - - -Forwards the ``ValueGroupIterator`` and returns the next ``ValueGroup`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct ValueGroup*` - -[#_value_group_to_string] -==== value_group_to_string - -[source,cpp] ----- -char* value_group_to_string(const struct ValueGroup* value_group) ----- - - - -A string representation of this ``ValueGroup`` object - -[caption=""] -.Returns -`char*` - diff --git a/c/docs/concept/attribute.adoc b/c/docs/concept/attribute.adoc deleted file mode 100644 index ee1c0e181b..0000000000 --- a/c/docs/concept/attribute.adoc +++ /dev/null @@ -1,51 +0,0 @@ -[#_methods__concept__attribute] -=== attribute - -[#_attribute_get_owners] -==== attribute_get_owners - -[source,cpp] ----- -struct ConceptIterator* attribute_get_owners(struct Transaction* transaction, const struct Concept* attribute, const struct Concept* thing_type) ----- - - - -Retrieves the instances that own this ``Attribute``. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_attribute_get_type] -==== attribute_get_type - -[source,cpp] ----- -struct Concept* attribute_get_type(const struct Concept* attribute) ----- - - - -Retrieves the type which this ``Attribute`` belongs to. - -[caption=""] -.Returns -`struct Concept*` - -[#_attribute_get_value] -==== attribute_get_value - -[source,cpp] ----- -struct Concept* attribute_get_value(const struct Concept* attribute) ----- - - - -Retrieves the type which this ``Relation`` belongs to. - -[caption=""] -.Returns -`struct Concept*` - diff --git a/c/docs/concept/concept.adoc b/c/docs/concept/concept.adoc deleted file mode 100644 index 4b78d05a35..0000000000 --- a/c/docs/concept/concept.adoc +++ /dev/null @@ -1,472 +0,0 @@ -[#_methods__concept__concept] -=== concept - -[#_Struct_Concept] -==== Struct Concept - - - -The fundamental TypeQL object. A Concept is either a Type, Thing, or Value. To use subtype specific methods, the Concept must be of the expected subtype. - -[#_Struct_ConceptIterator] -==== Struct ConceptIterator - - - -Iterator over the ``Concepts``s returned by an API method or query. - -[#_Struct_ConceptPromise] -==== Struct ConceptPromise - - - -Promise object representing the result of an asynchronous operation. Use concept_promise_resolve(ConceptPromise*) to wait for and retrieve the resulting boolean value. - -[#_concept_drop] -==== concept_drop - -[source,cpp] ----- -void concept_drop(struct Concept* concept) ----- - - - -Frees the native rust ``Concept`` object - -[caption=""] -.Returns -`void` - -[#_concept_equals] -==== concept_equals - -[source,cpp] ----- -bool concept_equals(const struct Concept* lhs, const struct Concept* rhs) ----- - - - -Checks whether the provided ``Concept`` objects are equal - -[caption=""] -.Returns -`bool` - -[#_concept_is_attribute] -==== concept_is_attribute - -[source,cpp] ----- -bool concept_is_attribute(const struct Concept* concept) ----- - - - -Checks if the concept is an ``Attribute``. - -[caption=""] -.Returns -`bool` - -[#_concept_is_attribute_type] -==== concept_is_attribute_type - -[source,cpp] ----- -bool concept_is_attribute_type(const struct Concept* concept) ----- - - - -Checks if the concept is an ``AttributeType``. - -[caption=""] -.Returns -`bool` - -[#_concept_is_entity] -==== concept_is_entity - -[source,cpp] ----- -bool concept_is_entity(const struct Concept* concept) ----- - - - -Checks if the concept is an ``Entity``. - -[caption=""] -.Returns -`bool` - -[#_concept_is_entity_type] -==== concept_is_entity_type - -[source,cpp] ----- -bool concept_is_entity_type(const struct Concept* concept) ----- - - - -Checks if the concept is an ``EntityType``. - -[caption=""] -.Returns -`bool` - -[#_concept_is_relation] -==== concept_is_relation - -[source,cpp] ----- -bool concept_is_relation(const struct Concept* concept) ----- - - - -Checks if the concept is a ``Relation``. - -[caption=""] -.Returns -`bool` - -[#_concept_is_relation_type] -==== concept_is_relation_type - -[source,cpp] ----- -bool concept_is_relation_type(const struct Concept* concept) ----- - - - -Checks if the concept is a ``RelationType``. - -[caption=""] -.Returns -`bool` - -[#_concept_is_role_type] -==== concept_is_role_type - -[source,cpp] ----- -bool concept_is_role_type(const struct Concept* concept) ----- - - - -Checks if the concept is a ``RoleType``. - -[caption=""] -.Returns -`bool` - -[#_concept_is_root_thing_type] -==== concept_is_root_thing_type - -[source,cpp] ----- -bool concept_is_root_thing_type(const struct Concept* concept) ----- - - - -Checks if the concept is the root ``thing`` type. - -[caption=""] -.Returns -`bool` - -[#_concept_is_value] -==== concept_is_value - -[source,cpp] ----- -bool concept_is_value(const struct Concept* concept) ----- - - - -Checks if the concept is a ``Value``. - -[caption=""] -.Returns -`bool` - -[#_concept_iterator_drop] -==== concept_iterator_drop - -[source,cpp] ----- -void concept_iterator_drop(struct ConceptIterator* it) ----- - - - -Frees the native rust ``ConceptIterator`` object - -[caption=""] -.Returns -`void` - -[#_concept_iterator_next] -==== concept_iterator_next - -[source,cpp] ----- -struct Concept* concept_iterator_next(struct ConceptIterator* it) ----- - - - -Forwards the ``ConceptIterator`` and returns the next ``Concept`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct Concept*` - -[#_concept_promise_resolve] -==== concept_promise_resolve - -[source,cpp] ----- -struct Concept* concept_promise_resolve(struct ConceptPromise* promise) ----- - - - -Waits for and returns the result of the operation represented by the ``ConceptPromise`` object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved. - -[caption=""] -.Returns -`struct Concept*` - -[#_concept_to_string] -==== concept_to_string - -[source,cpp] ----- -char* concept_to_string(const struct Concept* concept) ----- - - - -A string representation of this ``Concept`` object - -[caption=""] -.Returns -`char*` - -[#_concepts_get_attribute] -==== concepts_get_attribute - -[source,cpp] ----- -struct ConceptPromise* concepts_get_attribute(const struct Transaction* transaction, const char* iid) ----- - - - -Retrieves an ``Attribute`` instance by its iid. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_concepts_get_attribute_type] -==== concepts_get_attribute_type - -[source,cpp] ----- -struct ConceptPromise* concepts_get_attribute_type(const struct Transaction* transaction, const char* label) ----- - - - -Retrieves an ``AttributeType`` by its label. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_concepts_get_entity] -==== concepts_get_entity - -[source,cpp] ----- -struct ConceptPromise* concepts_get_entity(const struct Transaction* transaction, const char* iid) ----- - - - -Retrieves an ``Entity`` instance by its iid. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_concepts_get_entity_type] -==== concepts_get_entity_type - -[source,cpp] ----- -struct ConceptPromise* concepts_get_entity_type(const struct Transaction* transaction, const char* label) ----- - - - -Retrieves an ``EntityType`` by its label. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_concepts_get_relation] -==== concepts_get_relation - -[source,cpp] ----- -struct ConceptPromise* concepts_get_relation(const struct Transaction* transaction, const char* iid) ----- - - - -Retrieves a ``relation`` instance by its iid. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_concepts_get_relation_type] -==== concepts_get_relation_type - -[source,cpp] ----- -struct ConceptPromise* concepts_get_relation_type(const struct Transaction* transaction, const char* label) ----- - - - -Retrieves a ``RelationType`` by its label. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_concepts_get_root_attribute_type] -==== concepts_get_root_attribute_type - -[source,cpp] ----- -struct Concept* concepts_get_root_attribute_type(void) ----- - - - -Retrieves the root ``AttributeType``, “attribute”. - -[caption=""] -.Returns -`struct Concept*` - -[#_concepts_get_root_entity_type] -==== concepts_get_root_entity_type - -[source,cpp] ----- -struct Concept* concepts_get_root_entity_type(void) ----- - - - -Retrieves the root ``EntityType``, “entity”. - -[caption=""] -.Returns -`struct Concept*` - -[#_concepts_get_root_relation_type] -==== concepts_get_root_relation_type - -[source,cpp] ----- -struct Concept* concepts_get_root_relation_type(void) ----- - - - -Retrieves the root ``RelationType``, “relation”. - -[caption=""] -.Returns -`struct Concept*` - -[#_concepts_get_schema_exceptions] -==== concepts_get_schema_exceptions - -[source,cpp] ----- -struct SchemaExceptionIterator* concepts_get_schema_exceptions(const struct Transaction* transaction) ----- - - - -Retrieves a list of all schema exceptions for the current transaction. - -[caption=""] -.Returns -`struct SchemaExceptionIterator*` - -[#_concepts_put_attribute_type] -==== concepts_put_attribute_type - -[source,cpp] ----- -struct ConceptPromise* concepts_put_attribute_type(const struct Transaction* transaction, const char* label, enum ValueType value_type) ----- - - - -Creates a new ``AttributeType`` if none exists with the given label, otherwise retrieves the existing one. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_concepts_put_entity_type] -==== concepts_put_entity_type - -[source,cpp] ----- -struct ConceptPromise* concepts_put_entity_type(const struct Transaction* transaction, const char* label) ----- - - - -Creates a new ``EntityType`` if none exists with the given label, otherwise retrieves the existing one. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_concepts_put_relation_type] -==== concepts_put_relation_type - -[source,cpp] ----- -struct ConceptPromise* concepts_put_relation_type(const struct Transaction* transaction, const char* label) ----- - - - -Creates a new ``RelationType`` if none exists with the given label, otherwise retrieves the existing one. - -[caption=""] -.Returns -`struct ConceptPromise*` - diff --git a/c/docs/concept/entity.adoc b/c/docs/concept/entity.adoc deleted file mode 100644 index 459987d90c..0000000000 --- a/c/docs/concept/entity.adoc +++ /dev/null @@ -1,19 +0,0 @@ -[#_methods__concept__entity] -=== entity - -[#_entity_get_type] -==== entity_get_type - -[source,cpp] ----- -struct Concept* entity_get_type(const struct Concept* entity) ----- - - - -Retrieves the type which this ``Entity`` belongs to. - -[caption=""] -.Returns -`struct Concept*` - diff --git a/c/docs/concept/relation.adoc b/c/docs/concept/relation.adoc deleted file mode 100644 index 1a27ebeb50..0000000000 --- a/c/docs/concept/relation.adoc +++ /dev/null @@ -1,109 +0,0 @@ -[#_methods__concept__relation] -=== relation - -[#_relation_add_role_player] -==== relation_add_role_player - -[source,cpp] ----- -struct VoidPromise* relation_add_role_player(struct Transaction* transaction, struct Concept* relation, const struct Concept* role_type, const struct Concept* player) ----- - - - -Adds a new role player to play the given role in this ``Relation``. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_relation_get_players_by_role_type] -==== relation_get_players_by_role_type - -[source,cpp] ----- -struct ConceptIterator* relation_get_players_by_role_type(struct Transaction* transaction, const struct Concept* relation, const struct Concept*const* role_types) ----- - - - -Retrieves all role players of this ``Relation``, optionally filtered by given role types. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `role_types` a| a null-terminated array of ``RoleType``s to include. a| -|=== - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_relation_get_relating] -==== relation_get_relating - -[source,cpp] ----- -struct ConceptIterator* relation_get_relating(struct Transaction* transaction, const struct Concept* relation) ----- - - - -Retrieves all role types currently played in this ``Relation``. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_relation_get_role_players] -==== relation_get_role_players - -[source,cpp] ----- -struct RolePlayerIterator* relation_get_role_players(struct Transaction* transaction, const struct Concept* relation) ----- - - - -Retrieves all instance involved in the ``Relation``, each paired with the role it plays. - -[caption=""] -.Returns -`struct RolePlayerIterator*` - -[#_relation_get_type] -==== relation_get_type - -[source,cpp] ----- -struct Concept* relation_get_type(const struct Concept* relation) ----- - - - -Retrieves the type which this ``Relation`` belongs to. - -[caption=""] -.Returns -`struct Concept*` - -[#_relation_remove_role_player] -==== relation_remove_role_player - -[source,cpp] ----- -struct VoidPromise* relation_remove_role_player(struct Transaction* transaction, struct Concept* relation, const struct Concept* role_type, const struct Concept* player) ----- - - - -Removes the association of the given instance that plays the given role in this ``Relation``. - -[caption=""] -.Returns -`struct VoidPromise*` - diff --git a/c/docs/concept/roleplayer.adoc b/c/docs/concept/roleplayer.adoc deleted file mode 100644 index a0347b9eb7..0000000000 --- a/c/docs/concept/roleplayer.adoc +++ /dev/null @@ -1,97 +0,0 @@ -[#_methods__concept__roleplayer] -=== roleplayer - -[#_Struct_RolePlayer] -==== Struct RolePlayer - - - -A pair representing the concept and the role it plays in a relation. The result of relation_get_role_players(Transaction*, Concept*) - -[#_Struct_RolePlayerIterator] -==== Struct RolePlayerIterator - - - -An iterator over ``RolePlayer`` pairs returned by relation_get_role_players(Transaction*, Concept*) - -[#_role_player_drop] -==== role_player_drop - -[source,cpp] ----- -void role_player_drop(struct RolePlayer* role_player) ----- - - - -Frees the native rust ``RolePlayer`` object - -[caption=""] -.Returns -`void` - -[#_role_player_get_player] -==== role_player_get_player - -[source,cpp] ----- -struct Concept* role_player_get_player(const struct RolePlayer* role_player) ----- - - - -Returns the ``Concept`` which plays the role in the ``RolePlayer`` - -[caption=""] -.Returns -`struct Concept*` - -[#_role_player_get_role_type] -==== role_player_get_role_type - -[source,cpp] ----- -struct Concept* role_player_get_role_type(const struct RolePlayer* role_player) ----- - - - -Returns the role-type played by the ``RolePlayer`` - -[caption=""] -.Returns -`struct Concept*` - -[#_role_player_iterator_drop] -==== role_player_iterator_drop - -[source,cpp] ----- -void role_player_iterator_drop(struct RolePlayerIterator* it) ----- - - - -Frees the native rust ``RolePlayerIterator`` object - -[caption=""] -.Returns -`void` - -[#_role_player_iterator_next] -==== role_player_iterator_next - -[source,cpp] ----- -struct RolePlayer* role_player_iterator_next(struct RolePlayerIterator* it) ----- - - - -Forwards the ``RolePlayerIterator`` and returns the next ``RolePlayer`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct RolePlayer*` - diff --git a/c/docs/concept/thing.adoc b/c/docs/concept/thing.adoc deleted file mode 100644 index e7e4e2a999..0000000000 --- a/c/docs/concept/thing.adoc +++ /dev/null @@ -1,466 +0,0 @@ -[#_methods__concept__thing] -=== thing - -[#_thing_delete] -==== thing_delete - -[source,cpp] ----- -struct VoidPromise* thing_delete(struct Transaction* transaction, struct Concept* thing) ----- - - - -Deletes this ``Thing``. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_thing_get_has] -==== thing_get_has - -[source,cpp] ----- -struct ConceptIterator* thing_get_has(struct Transaction* transaction, const struct Concept* thing, const struct Concept*const* attribute_types, const struct Annotation*const* annotations) ----- - - - -Retrieves the ``Attribute``s that this ``Thing`` owns, optionally filtered by ``AttributeType``s. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `thing` a| The thing to get owned attributes of a| -a| `attribute_types` a| a null-terminated array holding the attribute-types to include a| -a| `annotations` a| a null-terminated array of annotations - If non-empty, Only retrieves attributes with all given ``Annotation``s a| -|=== - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_thing_get_iid] -==== thing_get_iid - -[source,cpp] ----- -char* thing_get_iid(struct Concept* thing) ----- - - - -Retrieves the unique id of the ``Thing``. - -[caption=""] -.Returns -`char*` - -[#_thing_get_is_inferred] -==== thing_get_is_inferred - -[source,cpp] ----- -bool thing_get_is_inferred(struct Concept* thing) ----- - - - -Checks if this ``Thing`` is inferred by a [Reasoning Rule]. - -[caption=""] -.Returns -`bool` - -[#_thing_get_playing] -==== thing_get_playing - -[source,cpp] ----- -struct ConceptIterator* thing_get_playing(struct Transaction* transaction, const struct Concept* thing) ----- - - - -Retrieves the roles that this ``Thing`` is currently playing. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_thing_get_relations] -==== thing_get_relations - -[source,cpp] ----- -struct ConceptIterator* thing_get_relations(struct Transaction* transaction, const struct Concept* thing, const struct Concept*const* role_types) ----- - - - -Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally filtered by one or more given roles. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `role_types` a| a null-terminated array of ``RoleType``s to include. a| -|=== - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_thing_is_deleted] -==== thing_is_deleted - -[source,cpp] ----- -struct BoolPromise* thing_is_deleted(struct Transaction* transaction, const struct Concept* thing) ----- - - - -Checks if this ``Thing`` is deleted. - -[caption=""] -.Returns -`struct BoolPromise*` - -[#_thing_set_has] -==== thing_set_has - -[source,cpp] ----- -struct VoidPromise* thing_set_has(struct Transaction* transaction, struct Concept* thing, const struct Concept* attribute) ----- - - - -Assigns an ``Attribute`` to be owned by this ``Thing``. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_thing_type_delete] -==== thing_type_delete - -[source,cpp] ----- -struct VoidPromise* thing_type_delete(const struct Transaction* transaction, struct Concept* thing_type) ----- - - - -Deletes this thing type from the database. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_thing_type_get_label] -==== thing_type_get_label - -[source,cpp] ----- -char* thing_type_get_label(const struct Concept* thing_type) ----- - - - -Retrieves the unique label of the thing type. - -[caption=""] -.Returns -`char*` - -[#_thing_type_get_owns] -==== thing_type_get_owns - -[source,cpp] ----- -struct ConceptIterator* thing_type_get_owns(const struct Transaction* transaction, const struct Concept* thing_type, const enum ValueType* value_type, enum Transitivity transitivity, const struct Annotation*const* annotations) ----- - - - -Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed to own directly or via inheritance. Specify ``Explicit`` to only include directly owned types, or ``Transitive`` to include inherited - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `annotations` a| a null-terminated array of ``Annotation``s - If non-empty, Only retrieves attribute types owned with all specified annotations. a| -|=== - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_thing_type_get_owns_overridden] -==== thing_type_get_owns_overridden - -[source,cpp] ----- -struct ConceptPromise* thing_type_get_owns_overridden(const struct Transaction* transaction, const struct Concept* thing_type, const struct Concept* overridden_attribute_type) ----- - - - -Retrieves the ``AttributeType``, ownership of which is overridden for this ``ThingType`` by the specified ``AttributeType``. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_thing_type_get_plays] -==== thing_type_get_plays - -[source,cpp] ----- -struct ConceptIterator* thing_type_get_plays(const struct Transaction* transaction, const struct Concept* thing_type, enum Transitivity transitivity) ----- - - - -Retrieves all direct and inherited (or direct only) roles that are allowed to be played by the instances of this ``ThingType``. Specify ``Transitive`` for direct and inherited roles, Or ``Explicit`` for directly played roles only. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_thing_type_get_plays_overridden] -==== thing_type_get_plays_overridden - -[source,cpp] ----- -struct ConceptPromise* thing_type_get_plays_overridden(const struct Transaction* transaction, const struct Concept* thing_type, const struct Concept* overridden_role_type) ----- - - - -Retrieves the ``RoleType`` that is overridden by the given ``RoleType`` for this ``ThingType``. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_thing_type_get_syntax] -==== thing_type_get_syntax - -[source,cpp] ----- -struct StringPromise* thing_type_get_syntax(const struct Transaction* transaction, const struct Concept* thing_type) ----- - - - -Produces a TypeQL pattern for creating this ``ThingType`` in a ``define`` query. - -[caption=""] -.Returns -`struct StringPromise*` - -[#_thing_type_is_abstract] -==== thing_type_is_abstract - -[source,cpp] ----- -bool thing_type_is_abstract(const struct Concept* thing_type) ----- - - - -Checks if this thing type is prevented from having data instances (i.e., abstract). - -[caption=""] -.Returns -`bool` - -[#_thing_type_is_deleted] -==== thing_type_is_deleted - -[source,cpp] ----- -struct BoolPromise* thing_type_is_deleted(const struct Transaction* transaction, const struct Concept* thing_type) ----- - - - -Checks if the thing type has been deleted - -[caption=""] -.Returns -`struct BoolPromise*` - -[#_thing_type_is_root] -==== thing_type_is_root - -[source,cpp] ----- -bool thing_type_is_root(const struct Concept* thing_type) ----- - - - -Checks if this type is a root type (""entity"", ""relation"", ""attribute"") - -[caption=""] -.Returns -`bool` - -[#_thing_type_set_abstract] -==== thing_type_set_abstract - -[source,cpp] ----- -struct VoidPromise* thing_type_set_abstract(const struct Transaction* transaction, struct Concept* thing_type) ----- - - - -Set a ``ThingType`` to be abstract, meaning it cannot have instances. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_thing_type_set_label] -==== thing_type_set_label - -[source,cpp] ----- -struct VoidPromise* thing_type_set_label(const struct Transaction* transaction, struct Concept* thing_type, const char* new_label) ----- - - - -Renames the label of the type. The new label must remain unique. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_thing_type_set_owns] -==== thing_type_set_owns - -[source,cpp] ----- -struct VoidPromise* thing_type_set_owns(const struct Transaction* transaction, struct Concept* thing_type, const struct Concept* attribute_type, const struct Concept* overridden_attribute_type, const struct Annotation*const* annotations) ----- - - - -Allows the instances of this ``ThingType`` to own the given ``AttributeType``. Optionally, overriding a previously declared ownership. With the specified annotations to the ownership. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `transaction` a| The current transaction a| -a| `thing_type` a| The thing type which is to own the specified attribute a| -a| `attribute_type` a| The attribute type which is to be owned by the specified thing type a| -a| `overridden_attribute_type` a| Optional, The attribute whose ownership must be overridden a| -a| `annotations` a| A null-terminated array of ``Annotation``s to be added to the ownership a| -|=== - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_thing_type_set_plays] -==== thing_type_set_plays - -[source,cpp] ----- -struct VoidPromise* thing_type_set_plays(struct Transaction* transaction, struct Concept* thing_type, const struct Concept* role_type, const struct Concept* overridden_role_type) ----- - - - -Allows the instances of this ``ThingType`` to play the given role. Optionally, overriding the existing ability to play a role. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_thing_type_unset_abstract] -==== thing_type_unset_abstract - -[source,cpp] ----- -struct VoidPromise* thing_type_unset_abstract(const struct Transaction* transaction, struct Concept* thing_type) ----- - - - -Set a ``ThingType`` to be non-abstract, meaning it can have instances. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_thing_type_unset_owns] -==== thing_type_unset_owns - -[source,cpp] ----- -struct VoidPromise* thing_type_unset_owns(const struct Transaction* transaction, struct Concept* thing_type, const struct Concept* attribute_type) ----- - - - -Disallows the instances of this ``ThingType`` from owning the given ``AttributeType``. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_thing_type_unset_plays] -==== thing_type_unset_plays - -[source,cpp] ----- -struct VoidPromise* thing_type_unset_plays(const struct Transaction* transaction, struct Concept* thing_type, const struct Concept* role_type) ----- - - - -Disallows the instances of this ``ThingType`` from playing the given role. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_thing_unset_has] -==== thing_unset_has - -[source,cpp] ----- -struct VoidPromise* thing_unset_has(struct Transaction* transaction, struct Concept* thing, const struct Concept* attribute) ----- - - - -Unassigns an ``Attribute`` from this ``Thing``. - -[caption=""] -.Returns -`struct VoidPromise*` - diff --git a/c/docs/concept/value.adoc b/c/docs/concept/value.adoc deleted file mode 100644 index d7144cfe4e..0000000000 --- a/c/docs/concept/value.adoc +++ /dev/null @@ -1,243 +0,0 @@ -[#_methods__concept__value] -=== value - -[#_value_get_boolean] -==== value_get_boolean - -[source,cpp] ----- -bool value_get_boolean(const struct Concept* value) ----- - - - -Returns a ``boolean`` value of this value concept. If the value has another type, the error is set. - -[caption=""] -.Returns -`bool` - -[#_value_get_date_time_as_millis] -==== value_get_date_time_as_millis - -[source,cpp] ----- -int64_t value_get_date_time_as_millis(const struct Concept* value) ----- - - - -Returns the value of this datetime value concept as milliseconds since the start of the UNIX epoch. If the value has another type, the error is set. - -[caption=""] -.Returns -`int64_t` - -[#_value_get_double] -==== value_get_double - -[source,cpp] ----- -double value_get_double(const struct Concept* value) ----- - - - -Returns the ``double`` value of this value concept. If the value has another type, the error is set. - -[caption=""] -.Returns -`double` - -[#_value_get_long] -==== value_get_long - -[source,cpp] ----- -int64_t value_get_long(const struct Concept* value) ----- - - - -Returns the ``long`` value of this value concept. If the value has another type, the error is set. - -[caption=""] -.Returns -`int64_t` - -[#_value_get_string] -==== value_get_string - -[source,cpp] ----- -char* value_get_string(const struct Concept* value) ----- - - - -Returns the ``string`` value of this value concept. If the value has another type, the error is set. - -[caption=""] -.Returns -`char*` - -[#_value_is_boolean] -==== value_is_boolean - -[source,cpp] ----- -bool value_is_boolean(const struct Concept* value) ----- - - - -Returns ``true`` if the value which this ``Value`` concept holds is of type ``boolean``. Otherwise, returns ``false``. - -[caption=""] -.Returns -`bool` - -[#_value_is_date_time] -==== value_is_date_time - -[source,cpp] ----- -bool value_is_date_time(const struct Concept* value) ----- - - - -Returns ``true`` if the value which this ``Value`` concept holds is of type ``datetime``. Otherwise, returns ``false``. - -[caption=""] -.Returns -`bool` - -[#_value_is_double] -==== value_is_double - -[source,cpp] ----- -bool value_is_double(const struct Concept* value) ----- - - - -Returns ``true`` if the value which this ``Value`` concept holds is of type ``double``. Otherwise, returns ``false``. - -[caption=""] -.Returns -`bool` - -[#_value_is_long] -==== value_is_long - -[source,cpp] ----- -bool value_is_long(const struct Concept* value) ----- - - - -Returns ``true`` if the value which this ``Value`` concept holds is of type ``long``. Otherwise, returns ``false``. - -[caption=""] -.Returns -`bool` - -[#_value_is_string] -==== value_is_string - -[source,cpp] ----- -bool value_is_string(const struct Concept* value) ----- - - - -Returns ``true`` if the value which this ``Value`` concept holds is of type ``string``. Otherwise, returns ``false``. - -[caption=""] -.Returns -`bool` - -[#_value_new_boolean] -==== value_new_boolean - -[source,cpp] ----- -struct Concept* value_new_boolean(bool bool_) ----- - - - -Creates a new ``Value`` object of the specified boolean value. - -[caption=""] -.Returns -`struct Concept*` - -[#_value_new_date_time_from_millis] -==== value_new_date_time_from_millis - -[source,cpp] ----- -struct Concept* value_new_date_time_from_millis(int64_t millis) ----- - - - -Creates a new ``Value`` object of the specified datetime value. - -[caption=""] -.Returns -`struct Concept*` - -[#_value_new_double] -==== value_new_double - -[source,cpp] ----- -struct Concept* value_new_double(double double_) ----- - - - -Creates a new ``Value`` object of the specified double value. - -[caption=""] -.Returns -`struct Concept*` - -[#_value_new_long] -==== value_new_long - -[source,cpp] ----- -struct Concept* value_new_long(int64_t long_) ----- - - - -Creates a new ``Value`` object of the specified long value. - -[caption=""] -.Returns -`struct Concept*` - -[#_value_new_string] -==== value_new_string - -[source,cpp] ----- -struct Concept* value_new_string(const char* string) ----- - - - -Creates a new ``Value`` object of the specified string value. - -[caption=""] -.Returns -`struct Concept*` - diff --git a/c/docs/connection/connection.adoc b/c/docs/connection/connection.adoc deleted file mode 100644 index ed35279b01..0000000000 --- a/c/docs/connection/connection.adoc +++ /dev/null @@ -1,130 +0,0 @@ -[#_methods__connection__connection] -=== connection - -[#_init_logging] -==== init_logging - -[source,cpp] ----- -void init_logging(void) ----- - - - -Enables logging in the TypeDB driver. - -[caption=""] -.Returns -`void` - -[#_methods__connection__connection] -=== connection - -[#_Struct_Connection] -==== Struct Connection - - - -A connection to a TypeDB server which serves as the starting point for all interaction. - -[#_connection_close] -==== connection_close - -[source,cpp] ----- -void connection_close(struct Connection* connection) ----- - - - -Closes the driver. Before instantiating a new driver, the driver that’s currently open should first be closed. Closing a connction frees the underlying rust object. - -[caption=""] -.Returns -`void` - -[#_connection_force_close] -==== connection_force_close - -[source,cpp] ----- -void connection_force_close(struct Connection* connection) ----- - - - -Forcibly closes the driver. To be used in exceptional cases. - -[caption=""] -.Returns -`void` - -[#_connection_is_open] -==== connection_is_open - -[source,cpp] ----- -bool connection_is_open(const struct Connection* connection) ----- - - - -Checks whether this connection is presently open. - -[caption=""] -.Returns -`bool` - -[#_connection_open_cloud] -==== connection_open_cloud - -[source,cpp] ----- -struct Connection* connection_open_cloud(const char*const* addresses, const struct Credential* credential) ----- - - - -Open a TypeDB Driver to TypeDB Cloud server(s) available at the provided addresses, using the provided credential. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `addresses` a| a null-terminated array holding the address(es) of the TypeDB server(s) a| -a| `credential` a| The ``Credential`` to connect with a| -|=== - -[caption=""] -.Returns -`struct Connection*` - -[#_connection_open_core] -==== connection_open_core - -[source,cpp] ----- -struct Connection* connection_open_core(const char* address) ----- - - - -Open a TypeDB Driver to a TypeDB Core server available at the provided address. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `address` a| The address of the TypeDB server a| -|=== - -[caption=""] -.Returns -`struct Connection*` - diff --git a/c/docs/connection/credential.adoc b/c/docs/connection/credential.adoc deleted file mode 100644 index e926c28011..0000000000 --- a/c/docs/connection/credential.adoc +++ /dev/null @@ -1,55 +0,0 @@ -[#_methods__connection__credential] -=== credential - -[#_Struct_Credential] -==== Struct Credential - - - -User credentials and TLS encryption settings for connecting to TypeDB Cloud. - -[#_credential_drop] -==== credential_drop - -[source,cpp] ----- -void credential_drop(struct Credential* credential) ----- - - - -Frees the native rust ``Credential`` object - -[caption=""] -.Returns -`void` - -[#_credential_new] -==== credential_new - -[source,cpp] ----- -struct Credential* credential_new(const char* username, const char* password, const char* tls_root_ca, bool with_tls) ----- - - - -Creates a new ``Credential`` for connecting to TypeDB Cloud. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `username` a| The name of the user to connect as a| -a| `password` a| The password for the user a| -a| `tls_root_ca` a| Path to the CA certificate to use for authenticating server certificates. a| -a| `with_tls` a| Specify whether the connection to TypeDB Cloud must be done over TLS a| -|=== - -[caption=""] -.Returns -`struct Credential*` - diff --git a/c/docs/connection/database.adoc b/c/docs/connection/database.adoc deleted file mode 100644 index e8ef2b9f6e..0000000000 --- a/c/docs/connection/database.adoc +++ /dev/null @@ -1,296 +0,0 @@ -[#_methods__connection__database] -=== database - -[#_Struct_Database] -==== Struct Database - - - -A TypeDB database - -[#_Struct_DatabaseIterator] -==== Struct DatabaseIterator - - - -An ``Iterator`` over databases present on the TypeDB server - -[#_Struct_DatabaseManager] -==== Struct DatabaseManager - - - -Provides access to all database management methods. - -[#_database_close] -==== database_close - -[source,cpp] ----- -void database_close(struct Database* database) ----- - - - -Frees the native rust ``Database`` object - -[caption=""] -.Returns -`void` - -[#_database_delete] -==== database_delete - -[source,cpp] ----- -void database_delete(struct Database* database) ----- - - - -Deletes this database. - -[caption=""] -.Returns -`void` - -[#_database_get_name] -==== database_get_name - -[source,cpp] ----- -char* database_get_name(const struct Database* database) ----- - - - -The database name as a string. - -[caption=""] -.Returns -`char*` - -[#_database_get_preferred_replica_info] -==== database_get_preferred_replica_info - -[source,cpp] ----- -struct ReplicaInfo* database_get_preferred_replica_info(const struct Database* database) ----- - - - -Returns the preferred replica for this database. Operations which can be run on any replica will prefer to use this replica. _Only works in TypeDB Cloud_ - -[caption=""] -.Returns -`struct ReplicaInfo*` - -[#_database_get_primary_replica_info] -==== database_get_primary_replica_info - -[source,cpp] ----- -struct ReplicaInfo* database_get_primary_replica_info(const struct Database* database) ----- - - - -Returns the primary replica for this database. _Only works in TypeDB Cloud_ - -[caption=""] -.Returns -`struct ReplicaInfo*` - -[#_database_get_replicas_info] -==== database_get_replicas_info - -[source,cpp] ----- -struct ReplicaInfoIterator* database_get_replicas_info(const struct Database* database) ----- - - - -Set of ``Replica`` instances for this database. Only works in TypeDB Cloud - -[caption=""] -.Returns -`struct ReplicaInfoIterator*` - -[#_database_iterator_drop] -==== database_iterator_drop - -[source,cpp] ----- -void database_iterator_drop(struct DatabaseIterator* it) ----- - - - -Frees the native rust ``DatabaseIterator`` object - -[caption=""] -.Returns -`void` - -[#_database_iterator_next] -==== database_iterator_next - -[source,cpp] ----- -struct Database* database_iterator_next(struct DatabaseIterator* it) ----- - - - -Forwards the ``DatabaseIterator`` and returns the next ``Database`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct Database*` - -[#_database_manager_drop] -==== database_manager_drop - -[source,cpp] ----- -void database_manager_drop(struct DatabaseManager* databases) ----- - - - -Frees the native rust ``DatabaseManager`` object - -[caption=""] -.Returns -`void` - -[#_database_manager_new] -==== database_manager_new - -[source,cpp] ----- -struct DatabaseManager* database_manager_new(const struct Connection* connection) ----- - - - -Creates and returns a native ``DatabaseManager`` for the connection - -[caption=""] -.Returns -`struct DatabaseManager*` - -[#_database_rule_schema] -==== database_rule_schema - -[source,cpp] ----- -char* database_rule_schema(struct Database* database) ----- - - - -The rules in the schema as a valid TypeQL define query string. - -[caption=""] -.Returns -`char*` - -[#_database_schema] -==== database_schema - -[source,cpp] ----- -char* database_schema(struct Database* database) ----- - - - -A full schema text as a valid TypeQL define query string. - -[caption=""] -.Returns -`char*` - -[#_database_type_schema] -==== database_type_schema - -[source,cpp] ----- -char* database_type_schema(struct Database* database) ----- - - - -The types in the schema as a valid TypeQL define query string. - -[caption=""] -.Returns -`char*` - -[#_databases_all] -==== databases_all - -[source,cpp] ----- -struct DatabaseIterator* databases_all(struct DatabaseManager* databases) ----- - - - -Returns a ``DatabaseIterator`` over all databases present on the TypeDB server - -[caption=""] -.Returns -`struct DatabaseIterator*` - -[#_databases_contains] -==== databases_contains - -[source,cpp] ----- -bool databases_contains(struct DatabaseManager* databases, const char* name) ----- - - - -Checks if a database with the given name exists - -[caption=""] -.Returns -`bool` - -[#_databases_create] -==== databases_create - -[source,cpp] ----- -void databases_create(struct DatabaseManager* databases, const char* name) ----- - - - -Create a database with the given name - -[caption=""] -.Returns -`void` - -[#_databases_get] -==== databases_get - -[source,cpp] ----- -struct Database* databases_get(struct DatabaseManager* databases, const char* name) ----- - - - -Retrieve the database with the given name. - -[caption=""] -.Returns -`struct Database*` - diff --git a/c/docs/connection/replica.adoc b/c/docs/connection/replica.adoc deleted file mode 100644 index 77cedf593f..0000000000 --- a/c/docs/connection/replica.adoc +++ /dev/null @@ -1,129 +0,0 @@ -[#_methods__connection__replica] -=== replica - -[#_Struct_ReplicaInfo] -==== Struct ReplicaInfo - - - -The metadata and state of an individual raft replica of a database. - -[#_Struct_ReplicaInfoIterator] -==== Struct ReplicaInfoIterator - - - -Iterator over the ``ReplicaInfo`` corresponding to each replica of a TypeDB cloud database. - -[#_replica_info_drop] -==== replica_info_drop - -[source,cpp] ----- -void replica_info_drop(struct ReplicaInfo* replica_info) ----- - - - -Frees the native rust ``ReplicaInfo`` object - -[caption=""] -.Returns -`void` - -[#_replica_info_get_address] -==== replica_info_get_address - -[source,cpp] ----- -char* replica_info_get_address(const struct ReplicaInfo* replica_info) ----- - - - -Retrieves the address of the server hosting this replica - -[caption=""] -.Returns -`char*` - -[#_replica_info_get_term] -==== replica_info_get_term - -[source,cpp] ----- -int64_t replica_info_get_term(const struct ReplicaInfo* replica_info) ----- - - - -The raft protocol ‘term’ of this replica. - -[caption=""] -.Returns -`int64_t` - -[#_replica_info_is_preferred] -==== replica_info_is_preferred - -[source,cpp] ----- -bool replica_info_is_preferred(const struct ReplicaInfo* replica_info) ----- - - - -Checks whether this is the preferred replica of the raft cluster. If true, Operations which can be run on any replica will prefer to use this replica. - -[caption=""] -.Returns -`bool` - -[#_replica_info_is_primary] -==== replica_info_is_primary - -[source,cpp] ----- -bool replica_info_is_primary(const struct ReplicaInfo* replica_info) ----- - - - -Checks whether this is the primary replica of the raft cluster. - -[caption=""] -.Returns -`bool` - -[#_replica_info_iterator_drop] -==== replica_info_iterator_drop - -[source,cpp] ----- -void replica_info_iterator_drop(struct ReplicaInfoIterator* it) ----- - - - -Frees the native rust ``ReplicaInfoIterator`` object - -[caption=""] -.Returns -`void` - -[#_replica_info_iterator_next] -==== replica_info_iterator_next - -[source,cpp] ----- -struct ReplicaInfo* replica_info_iterator_next(struct ReplicaInfoIterator* it) ----- - - - -Forwards the ``ReplicaInfoIterator`` and returns the next ``ReplicaInfo`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct ReplicaInfo*` - diff --git a/c/docs/connection/user.adoc b/c/docs/connection/user.adoc deleted file mode 100644 index 52c6219ab4..0000000000 --- a/c/docs/connection/user.adoc +++ /dev/null @@ -1,289 +0,0 @@ -[#_methods__connection__user] -=== user - -[#_Struct_User] -==== Struct User - - - -User information - -[#_Struct_UserIterator] -==== Struct UserIterator - - - -Iterator over a set of ``User``s - -[#_Struct_UserManager] -==== Struct UserManager - - - -Provides access to all user management methods. - -[#_user_drop] -==== user_drop - -[source,cpp] ----- -void user_drop(struct User* user) ----- - - - -Frees the native rust ``User`` object. - -[caption=""] -.Returns -`void` - -[#_user_get_password_expiry_seconds] -==== user_get_password_expiry_seconds - -[source,cpp] ----- -int64_t user_get_password_expiry_seconds(struct User* user) ----- - - - -Returns the number of seconds remaining till this user’s current password expires. - -[caption=""] -.Returns -`int64_t` - -[#_user_get_username] -==== user_get_username - -[source,cpp] ----- -char* user_get_username(struct User* user) ----- - - - -Returns the name of this user. - -[caption=""] -.Returns -`char*` - -[#_user_iterator_drop] -==== user_iterator_drop - -[source,cpp] ----- -void user_iterator_drop(struct UserIterator* it) ----- - - - -Frees the native rust ``UserIterator`` object - -[caption=""] -.Returns -`void` - -[#_user_iterator_next] -==== user_iterator_next - -[source,cpp] ----- -struct User* user_iterator_next(struct UserIterator* it) ----- - - - -Forwards the ``UserIterator`` and returns the next ``User`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct User*` - -[#_user_manager_drop] -==== user_manager_drop - -[source,cpp] ----- -void user_manager_drop(struct UserManager* user_manager) ----- - - - -Frees the native rust ``UserManager`` object - -[caption=""] -.Returns -`void` - -[#_user_manager_new] -==== user_manager_new - -[source,cpp] ----- -struct UserManager* user_manager_new(const struct Connection* connection) ----- - - - -Creates a ``UserManager`` on the specified connection - -[caption=""] -.Returns -`struct UserManager*` - -[#_user_password_update] -==== user_password_update - -[source,cpp] ----- -void user_password_update(struct User* user, const struct UserManager* user_manager, const char* password_old, const char* password_new) ----- - - - -Updates the password for the current authenticated user. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `user` a| The user to update the password of - must be the current user. a| -a| `user_manager` a| The ``UserManager`` object on this connection. a| -a| `password_old` a| The current password of this user a| -a| `password_new` a| The new password a| -|=== - -[caption=""] -.Returns -`void` - -[#_users_all] -==== users_all - -[source,cpp] ----- -struct UserIterator* users_all(const struct UserManager* user_manager) ----- - - - -Retrieves all users which exist on the TypeDB server. - -[caption=""] -.Returns -`struct UserIterator*` - -[#_users_contains] -==== users_contains - -[source,cpp] ----- -bool users_contains(const struct UserManager* user_manager, const char* username) ----- - - - -Checks if a user with the given name exists. - -[caption=""] -.Returns -`bool` - -[#_users_create] -==== users_create - -[source,cpp] ----- -void users_create(const struct UserManager* user_manager, const char* username, const char* password) ----- - - - -Creates a user with the given name & password. - -[caption=""] -.Returns -`void` - -[#_users_current_user] -==== users_current_user - -[source,cpp] ----- -struct User* users_current_user(const struct UserManager* user_manager) ----- - - - -Retrieves the user who opened this connection - -[caption=""] -.Returns -`struct User*` - -[#_users_delete] -==== users_delete - -[source,cpp] ----- -void users_delete(const struct UserManager* user_manager, const char* username) ----- - - - -Deletes the user with the given username. - -[caption=""] -.Returns -`void` - -[#_users_get] -==== users_get - -[source,cpp] ----- -struct User* users_get(const struct UserManager* user_manager, const char* username) ----- - - - -Retrieves a user with the given name. - -[caption=""] -.Returns -`struct User*` - -[#_users_set_password] -==== users_set_password - -[source,cpp] ----- -void users_set_password(const struct UserManager* user_manager, const char* username, const char* password) ----- - - - -Sets a new password for a user. This operation can only be performed by administrators. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `user_manager` a| The UserManager object to be used. This must be on a connection opened by an administrator. a| -a| `username` a| The name of the user to set the password of a| -a| `password` a| The new password a| -|=== - -[caption=""] -.Returns -`void` - diff --git a/c/docs/errors/error.adoc b/c/docs/errors/error.adoc deleted file mode 100644 index 52932bb9d9..0000000000 --- a/c/docs/errors/error.adoc +++ /dev/null @@ -1,96 +0,0 @@ -[#_methods__errors__error] -=== error - -[#_Struct_Error] -==== Struct Error - - - -Represents errors encountered during operation. - -[#_error_code] -==== error_code - -[source,cpp] ----- -char* error_code(const struct Error* error) ----- - - - -Returns the error code of the ``Error`` object - -[caption=""] -.Returns -`char*` - -[#_error_drop] -==== error_drop - -[source,cpp] ----- -void error_drop(struct Error* error) ----- - - - -Frees the native rust ``Error`` object - -[caption=""] -.Returns -`void` - -[#_error_message] -==== error_message - -[source,cpp] ----- -char* error_message(const struct Error* error) ----- - - - -Returns the error message of the ``Error`` object - -[caption=""] -.Returns -`char*` - -[#_methods__errors__error] -=== error - -[#_get_last_error] -==== get_last_error - -[source,cpp] ----- -struct Error* get_last_error(void) ----- - - - -Returns the error which set the error flag. - -[caption=""] -.Returns -`struct Error*` - -[#_methods__errors__error] -=== error - -[#_check_error] -==== check_error - -[source,cpp] ----- -bool check_error(void) ----- - - - -Checks if the error flag was set by the last operation. If true, the error can be retrieved using get_last_error(void) - -[caption=""] -.Returns -`bool` - diff --git a/c/docs/errors/schemaexception.adoc b/c/docs/errors/schemaexception.adoc deleted file mode 100644 index d831d4c30a..0000000000 --- a/c/docs/errors/schemaexception.adoc +++ /dev/null @@ -1,97 +0,0 @@ -[#_methods__errors__schemaexception] -=== schemaexception - -[#_Struct_SchemaException] -==== Struct SchemaException - - - -Represents invalid schema constructs discovered during schema validation. - -[#_Struct_SchemaExceptionIterator] -==== Struct SchemaExceptionIterator - - - -Iterator over the ``SchemaException``s in the result of concepts_get_schema_exceptions(Transaction*). - -[#_schema_exception_code] -==== schema_exception_code - -[source,cpp] ----- -char* schema_exception_code(const struct SchemaException* schema_exception) ----- - - - -Returns the error code of the ``SchemaException`` object - -[caption=""] -.Returns -`char*` - -[#_schema_exception_drop] -==== schema_exception_drop - -[source,cpp] ----- -void schema_exception_drop(struct SchemaException* schema_exception) ----- - - - -Frees the native rust ``SchemaException`` object - -[caption=""] -.Returns -`void` - -[#_schema_exception_iterator_drop] -==== schema_exception_iterator_drop - -[source,cpp] ----- -void schema_exception_iterator_drop(struct SchemaExceptionIterator* it) ----- - - - -Frees the native rust ``SchemaExceptionIterator`` object - -[caption=""] -.Returns -`void` - -[#_schema_exception_iterator_next] -==== schema_exception_iterator_next - -[source,cpp] ----- -struct SchemaException* schema_exception_iterator_next(struct SchemaExceptionIterator* it) ----- - - - -Forwards the ``SchemaExceptionIterator`` and returns the next ``SchemaException`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct SchemaException*` - -[#_schema_exception_message] -==== schema_exception_message - -[source,cpp] ----- -char* schema_exception_message(const struct SchemaException* schema_exception) ----- - - - -Returns the error message of the ``SchemaException`` object - -[caption=""] -.Returns -`char*` - diff --git a/c/docs/logic/logic.adoc b/c/docs/logic/logic.adoc deleted file mode 100644 index 937ab3cc7e..0000000000 --- a/c/docs/logic/logic.adoc +++ /dev/null @@ -1,63 +0,0 @@ -[#_methods__logic__logic] -=== logic - -[#_logic_manager_get_rule] -==== logic_manager_get_rule - -[source,cpp] ----- -struct RulePromise* logic_manager_get_rule(struct Transaction* transaction, const char* label) ----- - - - -Retrieves the Rule that has the given label. - -[caption=""] -.Returns -`struct RulePromise*` - -[#_logic_manager_get_rules] -==== logic_manager_get_rules - -[source,cpp] ----- -struct RuleIterator* logic_manager_get_rules(struct Transaction* transaction) ----- - - - -Returns a ``RuleIterator`` over all rules in the database for the transaction. - -[caption=""] -.Returns -`struct RuleIterator*` - -[#_logic_manager_put_rule] -==== logic_manager_put_rule - -[source,cpp] ----- -struct RulePromise* logic_manager_put_rule(struct Transaction* transaction, const char* label, const char* when, const char* then) ----- - - - -Creates a new Rule if none exists with the given label, or replaces the existing one. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `label` a| The label of the Rule to create or replace a| -a| `when` a| The when body of the rule to create a| -a| `then` a| The then body of the rule to create a| -|=== - -[caption=""] -.Returns -`struct RulePromise*` - diff --git a/c/docs/logic/rule.adoc b/c/docs/logic/rule.adoc deleted file mode 100644 index b5cb6fadc1..0000000000 --- a/c/docs/logic/rule.adoc +++ /dev/null @@ -1,200 +0,0 @@ -[#_methods__logic__rule] -=== rule - -[#_Struct_Rule] -==== Struct Rule - - - -Rules are a part of schema and define embedded logic. The reasoning engine uses rules as a set of logic to infer new data. A rule consists of a condition and a conclusion, and is uniquely identified by a label. - -[#_Struct_RuleIterator] -==== Struct RuleIterator - - - -An iterator over ``Rule``s in the database - -[#_Struct_RulePromise] -==== Struct RulePromise - - - -Promise object representing the result of an asynchronous operation. Use rule_promise_resolve(RulePromise*) to wait for and retrieve the resulting ``Rule``. - -[#_rule_delete] -==== rule_delete - -[source,cpp] ----- -struct VoidPromise* rule_delete(const struct Transaction* transaction, struct Rule* rule) ----- - - - -Deletes this rule. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_rule_drop] -==== rule_drop - -[source,cpp] ----- -void rule_drop(struct Rule* rule) ----- - - - -Frees the native rust ``ReplicaInfoIterator`` object. - -[caption=""] -.Returns -`void` - -[#_rule_get_label] -==== rule_get_label - -[source,cpp] ----- -char* rule_get_label(const struct Rule* rule) ----- - - - -Retrieves the unique label of the rule. - -[caption=""] -.Returns -`char*` - -[#_rule_get_then] -==== rule_get_then - -[source,cpp] ----- -char* rule_get_then(const struct Rule* rule) ----- - - - -The single statement that constitutes the ‘then’ of the rule. - -[caption=""] -.Returns -`char*` - -[#_rule_get_when] -==== rule_get_when - -[source,cpp] ----- -char* rule_get_when(const struct Rule* rule) ----- - - - -The statements that constitute the ‘when’ of the rule. - -[caption=""] -.Returns -`char*` - -[#_rule_is_deleted] -==== rule_is_deleted - -[source,cpp] ----- -struct BoolPromise* rule_is_deleted(const struct Transaction* transaction, struct Rule* rule) ----- - - - -Check if this rule has been deleted. - -[caption=""] -.Returns -`struct BoolPromise*` - -[#_rule_iterator_drop] -==== rule_iterator_drop - -[source,cpp] ----- -void rule_iterator_drop(struct RuleIterator* it) ----- - - - -Frees the native rust ``RuleIterator`` object. - -[caption=""] -.Returns -`void` - -[#_rule_iterator_next] -==== rule_iterator_next - -[source,cpp] ----- -struct Rule* rule_iterator_next(struct RuleIterator* it) ----- - - - -Forwards the ``RuleIterator`` and returns the next ``Rule`` if it exists, or null if there are no more elements. - -[caption=""] -.Returns -`struct Rule*` - -[#_rule_promise_resolve] -==== rule_promise_resolve - -[source,cpp] ----- -struct Rule* rule_promise_resolve(struct RulePromise* promise) ----- - - - -Waits for and returns the result of the operation represented by the ``RulePromise`` object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved. - -[caption=""] -.Returns -`struct Rule*` - -[#_rule_set_label] -==== rule_set_label - -[source,cpp] ----- -struct VoidPromise* rule_set_label(const struct Transaction* transaction, struct Rule* rule, const char* new_label) ----- - - - -Renames the label of the rule. The new label must remain unique. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_rule_to_string] -==== rule_to_string - -[source,cpp] ----- -char* rule_to_string(const struct Rule* rule) ----- - - - -A string representation of this ``Rule`` object - -[caption=""] -.Returns -`char*` - diff --git a/c/docs/schema/annotation.adoc b/c/docs/schema/annotation.adoc deleted file mode 100644 index e1f53b897e..0000000000 --- a/c/docs/schema/annotation.adoc +++ /dev/null @@ -1,122 +0,0 @@ -[#_methods__schema__annotation] -=== annotation - -[#_Struct_Annotation] -==== Struct Annotation - - - -Annotations are used to specify extra schema constraints. - -[#_annotation_drop] -==== annotation_drop - -[source,cpp] ----- -void annotation_drop(struct Annotation* annotation) ----- - - - -Frees the native rust ``Annotation`` object - -[caption=""] -.Returns -`void` - -[#_annotation_equals] -==== annotation_equals - -[source,cpp] ----- -bool annotation_equals(const struct Annotation* lhs, const struct Annotation* rhs) ----- - - - -Checks whether the provided ``Annotation`` objects are equal - -[caption=""] -.Returns -`bool` - -[#_annotation_is_key] -==== annotation_is_key - -[source,cpp] ----- -bool annotation_is_key(const struct Annotation* annotation) ----- - - - -Checks whether the provided ``Annotation`` is ``@key`` - -[caption=""] -.Returns -`bool` - -[#_annotation_is_unique] -==== annotation_is_unique - -[source,cpp] ----- -bool annotation_is_unique(const struct Annotation* annotation) ----- - - - -Checks whether the provided ``Annotation`` is ``@unique`` - -[caption=""] -.Returns -`bool` - -[#_annotation_new_key] -==== annotation_new_key - -[source,cpp] ----- -struct Annotation* annotation_new_key(void) ----- - - - -Produces a ``@key`` annotation. - -[caption=""] -.Returns -`struct Annotation*` - -[#_annotation_new_unique] -==== annotation_new_unique - -[source,cpp] ----- -struct Annotation* annotation_new_unique(void) ----- - - - -Produces a ``@unique`` annotation. - -[caption=""] -.Returns -`struct Annotation*` - -[#_annotation_to_string] -==== annotation_to_string - -[source,cpp] ----- -char* annotation_to_string(const struct Annotation* annotation) ----- - - - -A string representation of this ``Annotation`` object - -[caption=""] -.Returns -`char*` - diff --git a/c/docs/schema/attributetype.adoc b/c/docs/schema/attributetype.adoc deleted file mode 100644 index ef2f549ab6..0000000000 --- a/c/docs/schema/attributetype.adoc +++ /dev/null @@ -1,223 +0,0 @@ -[#_methods__schema__attributetype] -=== attributetype - -[#_attribute_type_get] -==== attribute_type_get - -[source,cpp] ----- -struct ConceptPromise* attribute_type_get(struct Transaction* transaction, const struct Concept* attribute_type, const struct Concept* value) ----- - - - -Retrieves an ``Attribute`` of this ``AttributeType`` with the given ``Value`` if such ``Attribute`` exists. Otherwise, returns ``null``. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_attribute_type_get_instances] -==== attribute_type_get_instances - -[source,cpp] ----- -struct ConceptIterator* attribute_type_get_instances(struct Transaction* transaction, const struct Concept* attribute_type, enum Transitivity transitivity) ----- - - - -Retrieves all ``Attribute`` objects that are instances of this ``AttributeType`` or its subtypes. Specify ``Transitive`` for instances of this AttributeType and subtypes, Or ``Explicit`` of this AttributeType only - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_attribute_type_get_owners] -==== attribute_type_get_owners - -[source,cpp] ----- -struct ConceptIterator* attribute_type_get_owners(struct Transaction* transaction, const struct Concept* attribute_type, enum Transitivity transitivity, const struct Annotation*const* annotations) ----- - - - -Retrieve all ``Things`` that own an attribute of this ``AttributeType`` directly or through inheritance. Specify ``Transitive`` for direct and inherited ownership, or ``Explicit`` for direct ownership only - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `annotations` a| a null-terminated array of ``Annotation``s - If non-empty, Only retrieves thing types of ownerships with all specified annotations. a| -|=== - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_attribute_type_get_regex] -==== attribute_type_get_regex - -[source,cpp] ----- -struct StringPromise* attribute_type_get_regex(struct Transaction* transaction, const struct Concept* attribute_type) ----- - - - -Retrieves the regular expression that is defined for this ``AttributeType``. - -[caption=""] -.Returns -`struct StringPromise*` - -[#_attribute_type_get_subtypes] -==== attribute_type_get_subtypes - -[source,cpp] ----- -struct ConceptIterator* attribute_type_get_subtypes(struct Transaction* transaction, const struct Concept* attribute_type, enum Transitivity transitivity) ----- - - - -Retrieves all direct and indirect (or direct only) subtypes of the given ``AttributeType``. Specify ``Transitive`` for direct and indirect subtypes, Or ``Explicit`` for directly subtypes only. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_attribute_type_get_subtypes_with_value_type] -==== attribute_type_get_subtypes_with_value_type - -[source,cpp] ----- -struct ConceptIterator* attribute_type_get_subtypes_with_value_type(struct Transaction* transaction, const struct Concept* attribute_type, enum ValueType value_type, enum Transitivity transitivity) ----- - - - -Retrieves subtypes of this ``AttributeType`` with given ``ValueType``. Specify ``Transitive`` for direct and indirect subtypes, Or ``Explicit`` for directly subtypes only. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_attribute_type_get_supertype] -==== attribute_type_get_supertype - -[source,cpp] ----- -struct ConceptPromise* attribute_type_get_supertype(struct Transaction* transaction, const struct Concept* attribute_type) ----- - - - -Retrieves the most immediate supertype of the given ``AttributeType``. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_attribute_type_get_supertypes] -==== attribute_type_get_supertypes - -[source,cpp] ----- -struct ConceptIterator* attribute_type_get_supertypes(struct Transaction* transaction, const struct Concept* attribute_type) ----- - - - -Retrieves all supertypes of the given ``AttributeType``. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_attribute_type_get_value_type] -==== attribute_type_get_value_type - -[source,cpp] ----- -enum ValueType attribute_type_get_value_type(const struct Concept* attribute_type) ----- - - - -Retrieves the ``ValueType`` of this ``AttributeType``. - -[caption=""] -.Returns -`enum ValueType` - -[#_attribute_type_put] -==== attribute_type_put - -[source,cpp] ----- -struct ConceptPromise* attribute_type_put(struct Transaction* transaction, const struct Concept* attribute_type, const struct Concept* value) ----- - - - -Creates and returns a new instance of this ``AttributeType``, with the specified ``Value``. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_attribute_type_set_regex] -==== attribute_type_set_regex - -[source,cpp] ----- -struct VoidPromise* attribute_type_set_regex(struct Transaction* transaction, const struct Concept* attribute_type, const char* regex) ----- - - - -Sets a regular expression as a constraint for this ``AttributeType``. ``Value``s of all ``Attribute``s of this type (inserted earlier or later) should match this regex. - -Can only be applied for ``AttributeType``s with a ``string`` value type. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_attribute_type_set_supertype] -==== attribute_type_set_supertype - -[source,cpp] ----- -struct VoidPromise* attribute_type_set_supertype(struct Transaction* transaction, struct Concept* attribute_type, const struct Concept* supertype) ----- - - - -Sets the supplied ``AttributeType`` as the supertype of the current ``AttributeType``. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_attribute_type_unset_regex] -==== attribute_type_unset_regex - -[source,cpp] ----- -struct VoidPromise* attribute_type_unset_regex(struct Transaction* transaction, const struct Concept* attribute_type) ----- - - - -Removes the regular expression that is defined for this ``AttributeType``. - -[caption=""] -.Returns -`struct VoidPromise*` - diff --git a/c/docs/schema/entitytype.adoc b/c/docs/schema/entitytype.adoc deleted file mode 100644 index b1c6687653..0000000000 --- a/c/docs/schema/entitytype.adoc +++ /dev/null @@ -1,99 +0,0 @@ -[#_methods__schema__entitytype] -=== entitytype - -[#_entity_type_create] -==== entity_type_create - -[source,cpp] ----- -struct ConceptPromise* entity_type_create(struct Transaction* transaction, const struct Concept* entity_type) ----- - - - -Creates and returns a new instance of this ``EntityType``. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_entity_type_get_instances] -==== entity_type_get_instances - -[source,cpp] ----- -struct ConceptIterator* entity_type_get_instances(struct Transaction* transaction, const struct Concept* entity_type, enum Transitivity transitivity) ----- - - - -Retrieves all ``Entity`` objects that are instances of this ``EntityType`` or its subtypes. Specify ``Transitive`` for instances of this EntityType and subtypes, Or ``Explicit`` of this EntityType only - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_entity_type_get_subtypes] -==== entity_type_get_subtypes - -[source,cpp] ----- -struct ConceptIterator* entity_type_get_subtypes(struct Transaction* transaction, const struct Concept* entity_type, enum Transitivity transitivity) ----- - - - -Retrieves all direct and indirect (or direct only) subtypes of the given EntityType. Specify ``Transitive`` for direct and indirect subtypes, Or ``Explicit`` for directly subtypes only. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_entity_type_get_supertype] -==== entity_type_get_supertype - -[source,cpp] ----- -struct ConceptPromise* entity_type_get_supertype(struct Transaction* transaction, const struct Concept* entity_type) ----- - - - -Retrieves the most immediate supertype of the given ``EntityType``. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_entity_type_get_supertypes] -==== entity_type_get_supertypes - -[source,cpp] ----- -struct ConceptIterator* entity_type_get_supertypes(struct Transaction* transaction, const struct Concept* entity_type) ----- - - - -Retrieves all supertypes of the given EntityType. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_entity_type_set_supertype] -==== entity_type_set_supertype - -[source,cpp] ----- -struct VoidPromise* entity_type_set_supertype(struct Transaction* transaction, struct Concept* entity_type, const struct Concept* supertype) ----- - - - -Sets the supplied ``EntityType`` as the supertype of the current ``EntityType``. - -[caption=""] -.Returns -`struct VoidPromise*` - diff --git a/c/docs/schema/relationtype.adoc b/c/docs/schema/relationtype.adoc deleted file mode 100644 index 53db5c5f81..0000000000 --- a/c/docs/schema/relationtype.adoc +++ /dev/null @@ -1,179 +0,0 @@ -[#_methods__schema__relationtype] -=== relationtype - -[#_relation_type_create] -==== relation_type_create - -[source,cpp] ----- -struct ConceptPromise* relation_type_create(struct Transaction* transaction, const struct Concept* relation_type) ----- - - - -Creates and returns a new instance of this ``RelationType``. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_relation_type_get_instances] -==== relation_type_get_instances - -[source,cpp] ----- -struct ConceptIterator* relation_type_get_instances(struct Transaction* transaction, const struct Concept* relation_type, enum Transitivity transitivity) ----- - - - -Retrieves all ``Relation`` objects that are instances of this ``RelationType`` or its subtypes. Specify ``Transitive`` for instances of this RelationType and subtypes, Or ``Explicit`` of this RelationType only - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_relation_type_get_relates] -==== relation_type_get_relates - -[source,cpp] ----- -struct ConceptIterator* relation_type_get_relates(struct Transaction* transaction, const struct Concept* relation_type, enum Transitivity transitivity) ----- - - - -Retrieves roles that this ``RelationType`` relates to directly or via inheritance. Specify ``Transitive`` for direct and inherited relates Or ``Explicit`` for direct relates only - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_relation_type_get_relates_for_role_label] -==== relation_type_get_relates_for_role_label - -[source,cpp] ----- -struct ConceptPromise* relation_type_get_relates_for_role_label(struct Transaction* transaction, const struct Concept* relation_type, const char* role_label) ----- - - - -Retrieves the role with the specified label that this ``RelationType`` relates to, directly or via inheritance. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_relation_type_get_relates_overridden] -==== relation_type_get_relates_overridden - -[source,cpp] ----- -struct ConceptPromise* relation_type_get_relates_overridden(struct Transaction* transaction, const struct Concept* relation_type, const char* overridden_role_label) ----- - - - -Retrieves the ``RoleType`` that is overridden by the role with the ``role_label``. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_relation_type_get_subtypes] -==== relation_type_get_subtypes - -[source,cpp] ----- -struct ConceptIterator* relation_type_get_subtypes(struct Transaction* transaction, const struct Concept* relation_type, enum Transitivity transitivity) ----- - - - -Retrieves all direct and indirect (or direct only) subtypes of the given RelationType. Specify ``Transitive`` for direct and indirect subtypes, Or ``Explicit`` for directly subtypes only. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_relation_type_get_supertype] -==== relation_type_get_supertype - -[source,cpp] ----- -struct ConceptPromise* relation_type_get_supertype(struct Transaction* transaction, const struct Concept* relation_type) ----- - - - -Retrieves the most immediate supertype of the given ``RelationType``. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_relation_type_get_supertypes] -==== relation_type_get_supertypes - -[source,cpp] ----- -struct ConceptIterator* relation_type_get_supertypes(struct Transaction* transaction, const struct Concept* relation_type) ----- - - - -Retrieves all supertypes of the given RelationType. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_relation_type_set_relates] -==== relation_type_set_relates - -[source,cpp] ----- -struct VoidPromise* relation_type_set_relates(struct Transaction* transaction, struct Concept* relation_type, const char* role_label, const char* overridden_role_label) ----- - - - -Sets the new role that this ``RelationType`` relates to. If we are setting an overriding type this way, we have to also pass overridden_role_label. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_relation_type_set_supertype] -==== relation_type_set_supertype - -[source,cpp] ----- -struct VoidPromise* relation_type_set_supertype(struct Transaction* transaction, struct Concept* relation_type, const struct Concept* supertype) ----- - - - -Sets the supplied ``RelationType`` as the supertype of the current ``RelationType``. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_relation_type_unset_relates] -==== relation_type_unset_relates - -[source,cpp] ----- -struct VoidPromise* relation_type_unset_relates(struct Transaction* transaction, struct Concept* relation_type, const char* role_label) ----- - - - -Disallows this ``RelationType`` from relating to the given role. - -[caption=""] -.Returns -`struct VoidPromise*` - diff --git a/c/docs/schema/roletype.adoc b/c/docs/schema/roletype.adoc deleted file mode 100644 index 154d3941b7..0000000000 --- a/c/docs/schema/roletype.adoc +++ /dev/null @@ -1,243 +0,0 @@ -[#_methods__schema__roletype] -=== roletype - -[#_role_type_delete] -==== role_type_delete - -[source,cpp] ----- -struct VoidPromise* role_type_delete(struct Transaction* transaction, const struct Concept* role_type) ----- - - - -Deletes this role type from the database. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_role_type_get_name] -==== role_type_get_name - -[source,cpp] ----- -char* role_type_get_name(const struct Concept* role_type) ----- - - - -Gets the name of this role type. - -[caption=""] -.Returns -`char*` - -[#_role_type_get_player_instances] -==== role_type_get_player_instances - -[source,cpp] ----- -struct ConceptIterator* role_type_get_player_instances(struct Transaction* transaction, const struct Concept* role_type, enum Transitivity transitivity) ----- - - - -Retrieves the ``Thing`` instances that play this role. Specify ``Transitive`` for direct and indirect playing, or ``Explicit`` for direct playing only - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_role_type_get_player_types] -==== role_type_get_player_types - -[source,cpp] ----- -struct ConceptIterator* role_type_get_player_types(struct Transaction* transaction, const struct Concept* role_type, enum Transitivity transitivity) ----- - - - -Retrieves the ``ThingType``s whose instances play this role. Specify ``Transitive`` for direct and indirect playing, or ``Explicit`` for direct playing only - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_role_type_get_relation_instances] -==== role_type_get_relation_instances - -[source,cpp] ----- -struct ConceptIterator* role_type_get_relation_instances(struct Transaction* transaction, const struct Concept* role_type, enum Transitivity transitivity) ----- - - - -Retrieves the ``Relation`` instances that this role is related to. Specify ``Transitive`` for direct and indirect relation, or ``Explicit`` for direct relation only - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_role_type_get_relation_type] -==== role_type_get_relation_type - -[source,cpp] ----- -struct ConceptPromise* role_type_get_relation_type(struct Transaction* transaction, const struct Concept* role_type) ----- - - - -Retrieves the ``RelationType`` that this role is directly related to. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_role_type_get_relation_types] -==== role_type_get_relation_types - -[source,cpp] ----- -struct ConceptIterator* role_type_get_relation_types(struct Transaction* transaction, const struct Concept* role_type) ----- - - - -Retrieves ``RelationType``s that this role is related to (directly or indirectly). - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_role_type_get_scope] -==== role_type_get_scope - -[source,cpp] ----- -char* role_type_get_scope(const struct Concept* role_type) ----- - - - -Gets the 'scope' of this role type. This corresponds to the label of the ``RelationType`` it is directly related to. - -[caption=""] -.Returns -`char*` - -[#_role_type_get_subtypes] -==== role_type_get_subtypes - -[source,cpp] ----- -struct ConceptIterator* role_type_get_subtypes(struct Transaction* transaction, const struct Concept* role_type, enum Transitivity transitivity) ----- - - - -Retrieves all direct and indirect (or direct only) subtypes of the given ``RoleType``. Specify ``Transitive`` for direct and indirect subtypes, Or ``Explicit`` for directly subtypes only. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_role_type_get_supertype] -==== role_type_get_supertype - -[source,cpp] ----- -struct ConceptPromise* role_type_get_supertype(struct Transaction* transaction, const struct Concept* role_type) ----- - - - -Retrieves the most immediate supertype of the given ``RoleType``. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_role_type_get_supertypes] -==== role_type_get_supertypes - -[source,cpp] ----- -struct ConceptIterator* role_type_get_supertypes(struct Transaction* transaction, const struct Concept* role_type) ----- - - - -Retrieves all supertypes of the given ``RoleType``. - -[caption=""] -.Returns -`struct ConceptIterator*` - -[#_role_type_is_abstract] -==== role_type_is_abstract - -[source,cpp] ----- -bool role_type_is_abstract(const struct Concept* role_type) ----- - - - -Checks if the role type is prevented from having data instances (i.e., ``abstract``). - -[caption=""] -.Returns -`bool` - -[#_role_type_is_deleted] -==== role_type_is_deleted - -[source,cpp] ----- -struct BoolPromise* role_type_is_deleted(const struct Transaction* transaction, const struct Concept* role_type) ----- - - - -Check if the role type has been deleted - -[caption=""] -.Returns -`struct BoolPromise*` - -[#_role_type_is_root] -==== role_type_is_root - -[source,cpp] ----- -bool role_type_is_root(const struct Concept* role_type) ----- - - - -Checks if the role type is the root role type, ""relation:role"" - -[caption=""] -.Returns -`bool` - -[#_role_type_set_label] -==== role_type_set_label - -[source,cpp] ----- -struct VoidPromise* role_type_set_label(struct Transaction* transaction, const struct Concept* role_type, const char* new_label) ----- - - - -Renames the label of the type. The new label must remain unique in the hierarchy of a relation type. - -[caption=""] -.Returns -`struct VoidPromise*` - diff --git a/c/docs/schema/transitivity.adoc b/c/docs/schema/transitivity.adoc deleted file mode 100644 index 41665f7355..0000000000 --- a/c/docs/schema/transitivity.adoc +++ /dev/null @@ -1,31 +0,0 @@ -[#_methods__schema__transitivity] -=== transitivity - -[#_Struct_Transitivity] -==== Struct Transitivity - - - -Used for specifying whether we need explicit or transitive subtyping, instances, etc. - - -[#_Enum_Transitivity] -==== Enum Transitivity - - - -Used for specifying whether we need explicit or transitive subtyping, instances, etc. - - -[caption=""] -.Enum constants -// tag::enum_constants[] -[cols="~"] -[options="header"] -|=== -|Name -a| `Explicit` -a| `Transitive` -|=== -// end::enum_constants[] - diff --git a/c/docs/schema/valuetype.adoc b/c/docs/schema/valuetype.adoc deleted file mode 100644 index 818a13f3f7..0000000000 --- a/c/docs/schema/valuetype.adoc +++ /dev/null @@ -1,51 +0,0 @@ -[#_methods__schema__valuetype] -=== valuetype - -[#_Struct_ValueType] -==== Struct ValueType - - - -Represents the type of primitive value is held by a Value or Attribute. - -[#_Enum_ValueType] -==== Enum ValueType - - - -Represents the type of primitive value is held by a Value or Attribute. - -[caption=""] -.Enum constants -// tag::enum_constants[] -[cols="~"] -[options="header"] -|=== -|Name -a| `Boolean` -a| `DateTime` -a| `Double` -a| `Long` -a| `Object` -a| `String` -|=== -// end::enum_constants[] - -[#_Enum_ValueType] -==== Enum ValueType - - - -Retrieves the ``ValueType`` of this ``AttributeType``. - -[caption=""] -.Enum constants -// tag::enum_constants[] -[cols="~"] -[options="header"] -|=== -|Name -a| `attribute_type_get_value_type (const struct Concept *attribute_type)` -|=== -// end::enum_constants[] - diff --git a/c/docs/session/options.adoc b/c/docs/session/options.adoc deleted file mode 100644 index fc7890b757..0000000000 --- a/c/docs/session/options.adoc +++ /dev/null @@ -1,533 +0,0 @@ -[#_methods__session__options] -=== options - -[#_Struct_Options] -==== Struct Options - - - -TypeDB session and transaction options. ``TypeDBOptions`` object can be used to override the default server behaviour. Options are specified using properties assignment. - - -[#_options_drop] -==== options_drop - -[source,cpp] ----- -void options_drop(struct Options* options) ----- - - - -Frees the native rust ``Options`` object. - -[caption=""] -.Returns -`void` - -[#_options_get_explain] -==== options_get_explain - -[source,cpp] ----- -bool options_get_explain(const struct Options* options) ----- - - - -Returns the value set for the explanation in this ``TypeDBOptions`` object. If set to ``true``, explanations for queries are enabled. - -[caption=""] -.Returns -`bool` - -[#_options_get_infer] -==== options_get_infer - -[source,cpp] ----- -bool options_get_infer(const struct Options* options) ----- - - - -Returns the value set for the inference in this ``TypeDBOptions`` object. - -[caption=""] -.Returns -`bool` - -[#_options_get_parallel] -==== options_get_parallel - -[source,cpp] ----- -bool options_get_parallel(const struct Options* options) ----- - - - -Returns the value set for the parallel execution in this ``TypeDBOptions`` object. If set to ``true``, the server uses parallel instead of single-threaded execution. - -[caption=""] -.Returns -`bool` - -[#_options_get_prefetch] -==== options_get_prefetch - -[source,cpp] ----- -bool options_get_prefetch(const struct Options* options) ----- - - - -Returns the value set for the prefetching in this ``TypeDBOptions`` object. If set to ``true``, the first batch of answers is streamed to the driver even without an explicit request for it. - -[caption=""] -.Returns -`bool` - -[#_options_get_prefetch_size] -==== options_get_prefetch_size - -[source,cpp] ----- -int32_t options_get_prefetch_size(const struct Options* options) ----- - - - -Returns the value set for the prefetch size in this ``TypeDBOptions`` object. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request. - -[caption=""] -.Returns -`int32_t` - -[#_options_get_read_any_replica] -==== options_get_read_any_replica - -[source,cpp] ----- -bool options_get_read_any_replica(const struct Options* options) ----- - - - -Returns the value set for reading data from any replica in this ``TypeDBOptions`` object. If set to ``True``, enables reading data from any replica, potentially boosting read throughput. - -[caption=""] -.Returns -`bool` - -[#_options_get_schema_lock_acquire_timeout_millis] -==== options_get_schema_lock_acquire_timeout_millis - -[source,cpp] ----- -int64_t options_get_schema_lock_acquire_timeout_millis(const struct Options* options) ----- - - - -Returns the value set for the schema lock acquire timeout in this ``TypeDBOptions`` object. If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock. - -[caption=""] -.Returns -`int64_t` - -[#_options_get_session_idle_timeout_millis] -==== options_get_session_idle_timeout_millis - -[source,cpp] ----- -int64_t options_get_session_idle_timeout_millis(const struct Options* options) ----- - - - -Returns the value set for the session idle timeout in this ``TypeDBOptions`` object. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. - -[caption=""] -.Returns -`int64_t` - -[#_options_get_trace_inference] -==== options_get_trace_inference - -[source,cpp] ----- -bool options_get_trace_inference(const struct Options* options) ----- - - - -Returns the value set for reasoning tracing in this ``TypeDBOptions`` object. If set to ``true``, reasoning tracing graphs are output in the logging directory. - -[caption=""] -.Returns -`bool` - -[#_options_get_transaction_timeout_millis] -==== options_get_transaction_timeout_millis - -[source,cpp] ----- -int64_t options_get_transaction_timeout_millis(const struct Options* options) ----- - - - -Returns the value set for the transaction timeout in this ``TypeDBOptions`` object. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions. - -[caption=""] -.Returns -`int64_t` - -[#_options_has_explain] -==== options_has_explain - -[source,cpp] ----- -bool options_has_explain(const struct Options* options) ----- - - - -Checks whether the option for explanation was explicitly set for this ``TypeDBOptions`` object. - -[caption=""] -.Returns -`bool` - -[#_options_has_infer] -==== options_has_infer - -[source,cpp] ----- -bool options_has_infer(const struct Options* options) ----- - - - -Checks whether the option for inference was explicitly set for this ``TypeDBOptions`` object. - -[caption=""] -.Returns -`bool` - -[#_options_has_parallel] -==== options_has_parallel - -[source,cpp] ----- -bool options_has_parallel(const struct Options* options) ----- - - - -Checks whether the option for parallel execution was explicitly set for this ``TypeDBOptions`` object. - -[caption=""] -.Returns -`bool` - -[#_options_has_prefetch] -==== options_has_prefetch - -[source,cpp] ----- -bool options_has_prefetch(const struct Options* options) ----- - - - -Checks whether the option for prefetching was explicitly set for this ``TypeDBOptions`` object. - -[caption=""] -.Returns -`bool` - -[#_options_has_prefetch_size] -==== options_has_prefetch_size - -[source,cpp] ----- -bool options_has_prefetch_size(const struct Options* options) ----- - - - -Checks whether the option for prefetch size was explicitly set for this ``TypeDBOptions`` object. - -[caption=""] -.Returns -`bool` - -[#_options_has_read_any_replica] -==== options_has_read_any_replica - -[source,cpp] ----- -bool options_has_read_any_replica(const struct Options* options) ----- - - - -Checks whether the option for reading data from any replica was explicitly set for this ``TypeDBOptions`` object. - -[caption=""] -.Returns -`bool` - -[#_options_has_schema_lock_acquire_timeout_millis] -==== options_has_schema_lock_acquire_timeout_millis - -[source,cpp] ----- -bool options_has_schema_lock_acquire_timeout_millis(const struct Options* options) ----- - - - -Checks whether the option for schema lock acquire timeout was explicitly set for this ``TypeDBOptions`` object. - -[caption=""] -.Returns -`bool` - -[#_options_has_session_idle_timeout_millis] -==== options_has_session_idle_timeout_millis - -[source,cpp] ----- -bool options_has_session_idle_timeout_millis(const struct Options* options) ----- - - - -Checks whether the option for the session idle timeout was explicitly set for this ``TypeDBOptions`` object. - -[caption=""] -.Returns -`bool` - -[#_options_has_trace_inference] -==== options_has_trace_inference - -[source,cpp] ----- -bool options_has_trace_inference(const struct Options* options) ----- - - - -Checks whether the option for reasoning tracing was explicitly set for this ``TypeDBOptions`` object. - -[caption=""] -.Returns -`bool` - -[#_options_has_transaction_timeout_millis] -==== options_has_transaction_timeout_millis - -[source,cpp] ----- -bool options_has_transaction_timeout_millis(const struct Options* options) ----- - - - -Checks whether the option for transaction timeout was explicitly set for this ``TypeDBOptions`` object. - -[caption=""] -.Returns -`bool` - -[#_options_new] -==== options_new - -[source,cpp] ----- -struct Options* options_new(void) ----- - - - -Produces a new ``TypeDBOptions`` object. - -[caption=""] -.Returns -`struct Options*` - -[#_options_set_explain] -==== options_set_explain - -[source,cpp] ----- -void options_set_explain(struct Options* options, bool explain) ----- - - - -Explicitly enables or disables explanations. If set to ``true``, enables explanations for queries. Only affects read transactions. - -[caption=""] -.Returns -`void` - -[#_options_set_infer] -==== options_set_infer - -[source,cpp] ----- -void options_set_infer(struct Options* options, bool infer) ----- - - - -Explicitly enables or disables inference. Only settable at transaction level and above. Only affects read transactions. - -[caption=""] -.Returns -`void` - -[#_options_set_parallel] -==== options_set_parallel - -[source,cpp] ----- -void options_set_parallel(struct Options* options, bool parallel) ----- - - - -Explicitly enables or disables parallel execution. If set to ``true``, the server uses parallel instead of single-threaded execution. - -[caption=""] -.Returns -`void` - -[#_options_set_prefetch] -==== options_set_prefetch - -[source,cpp] ----- -void options_set_prefetch(struct Options* options, bool prefetch) ----- - - - -Explicitly enables or disables prefetching. If set to ``true``, the first batch of answers is streamed to the driver even without an explicit request for it. - -[caption=""] -.Returns -`void` - -[#_options_set_prefetch_size] -==== options_set_prefetch_size - -[source,cpp] ----- -void options_set_prefetch_size(struct Options* options, int32_t prefetch_size) ----- - - - -Explicitly sets a prefetch size. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `prefetchSize` a| Number of answers that the server should send before the driver issues a fresh request a| -|=== - -[caption=""] -.Returns -`void` - -[#_options_set_read_any_replica] -==== options_set_read_any_replica - -[source,cpp] ----- -void options_set_read_any_replica(struct Options* options, bool read_any_replica) ----- - - - -Explicitly enables or disables reading data from any replica. If set to ``True``, enables reading data from any replica, potentially boosting read throughput. Only settable in TypeDB Cloud. - -[caption=""] -.Returns -`void` - -[#_options_set_schema_lock_acquire_timeout_millis] -==== options_set_schema_lock_acquire_timeout_millis - -[source,cpp] ----- -void options_set_schema_lock_acquire_timeout_millis(struct Options* options, int64_t timeout_millis) ----- - - - -Explicitly sets schema lock acquire timeout. If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock. - -[caption=""] -.Returns -`void` - -[#_options_set_session_idle_timeout_millis] -==== options_set_session_idle_timeout_millis - -[source,cpp] ----- -void options_set_session_idle_timeout_millis(struct Options* options, int64_t timeout_millis) ----- - - - -Explicitly sets a session idle timeout. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. - -[caption=""] -.Returns -`void` - -[#_options_set_trace_inference] -==== options_set_trace_inference - -[source,cpp] ----- -void options_set_trace_inference(struct Options* options, bool trace_inference) ----- - - - -Explicitly enables or disables reasoning tracing. If set to ``true``, reasoning tracing graphs are output in the logging directory. Should be used with ``parallel = False``. - -[caption=""] -.Returns -`void` - -[#_options_set_transaction_timeout_millis] -==== options_set_transaction_timeout_millis - -[source,cpp] ----- -void options_set_transaction_timeout_millis(struct Options* options, int64_t timeout_millis) ----- - - - -Explicitly set a transaction timeout. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions. - -[caption=""] -.Returns -`void` - diff --git a/c/docs/session/session.adoc b/c/docs/session/session.adoc deleted file mode 100644 index cae726e351..0000000000 --- a/c/docs/session/session.adoc +++ /dev/null @@ -1,189 +0,0 @@ -[#_methods__session__session] -=== session - -[#_Struct_Session] -==== Struct Session - - - -A session with a TypeDB database. - -[#_Struct_SessionType] -==== Struct SessionType - - - -This enum is used to specify the type of the session. - - -[#_Enum_SessionType] -==== Enum SessionType - - - -This enum is used to specify the type of the session. - - -[caption=""] -.Enum constants -// tag::enum_constants[] -[cols="~"] -[options="header"] -|=== -|Name -a| `Data = 0` -a| `Schema = 1` -|=== -// end::enum_constants[] - -[#_session_close] -==== session_close - -[source,cpp] ----- -void session_close(struct Session* session) ----- - - - -Closes the session. Before opening a new session, the session currently open should first be closed. The native rust object is freed on close. - -[caption=""] -.Returns -`void` - -[#_session_force_close] -==== session_force_close - -[source,cpp] ----- -void session_force_close(struct Session* session) ----- - - - -Forcibly closes the session. To be used in exceptional cases. - -[caption=""] -.Returns -`void` - -[#_session_get_database_name] -==== session_get_database_name - -[source,cpp] ----- -char* session_get_database_name(const struct Session* session) ----- - - - -Returns the name of the database of the session. - -[caption=""] -.Returns -`char*` - -[#_session_is_open] -==== session_is_open - -[source,cpp] ----- -bool session_is_open(const struct Session* session) ----- - - - -Checks whether this session is open. - -[caption=""] -.Returns -`bool` - -[#_session_new] -==== session_new - -[source,cpp] ----- -struct Session* session_new(struct DatabaseManager* databases, const char* database_name, enum SessionType session_type, const struct Options* options) ----- - - - -Opens a session to the given database. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `databases` a| The ``DatabaseManager`` object on this connection. a| -a| `database_name` a| The name of the database with which the session connects a| -a| `session_type` a| The type of session to be created (Schema or Data) a| -a| `options` a| ``Options`` for this session a| -|=== - -[caption=""] -.Returns -`struct Session*` - -[#_session_on_close] -==== session_on_close - -[source,cpp] ----- -void session_on_close(const struct Session* session, void* data, void(*)(void*) callback, void(*)(void*) finished) ----- - - - -Registers a callback function which will be executed when this session is closed. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `session` a| The session on which to register the callback a| -a| `data` a| The argument to be passed to the callback function when it is executed a| -a| `callback` a| The function to be called a| -a| `finished` a| A function which will be executed when the session is destroyed, allowing cleanup a| -|=== - -[caption=""] -.Returns -`void` - -[#_session_on_reopen] -==== session_on_reopen - -[source,cpp] ----- -void session_on_reopen(const struct Session* session, void* data, void(*)(void*) callback, void(*)(void*) finished) ----- - - - -Registers a callback function which will be executed when this session is reopened. A session may be closed if it times out, or loses the connection to the database. In such situations, the session is reopened automatically when opening a new transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `session` a| The session on which to register the callback a| -a| `data` a| The argument to be passed to the callback function when it is executed a| -a| `callback` a| The function to be called a| -a| `finished` a| A function which will be executed when the session is destroyed, allowing cleanup a| -|=== - -[caption=""] -.Returns -`void` - diff --git a/c/docs/transaction/query.adoc b/c/docs/transaction/query.adoc deleted file mode 100644 index cde2116954..0000000000 --- a/c/docs/transaction/query.adoc +++ /dev/null @@ -1,190 +0,0 @@ -[#_methods__transaction__query] -=== query - -[#_query_define] -==== query_define - -[source,cpp] ----- -struct VoidPromise* query_define(struct Transaction* transaction, const char* query, const struct Options* options) ----- - - - -Performs a TypeQL Define query in the transaction. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_query_delete] -==== query_delete - -[source,cpp] ----- -struct VoidPromise* query_delete(struct Transaction* transaction, const char* query, const struct Options* options) ----- - - - -Performs a TypeQL Delete query in the transaction. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_query_explain] -==== query_explain - -[source,cpp] ----- -struct ExplanationIterator* query_explain(struct Transaction* transaction, const struct Explainable* explainable, const struct Options* options) ----- - - - -Performs a TypeQL Explain query in the transaction. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `explainable` a| The Explainable to be explained a| -a| `options` a| Specify query options a| -|=== - -[caption=""] -.Returns -`struct ExplanationIterator*` - -[#_query_fetch] -==== query_fetch - -[source,cpp] ----- -struct StringIterator* query_fetch(struct Transaction* transaction, const char* query, const struct Options* options) ----- - - - -Performs a TypeQL Fetch query in the transaction. - -[caption=""] -.Returns -`struct StringIterator*` - -[#_query_get] -==== query_get - -[source,cpp] ----- -struct ConceptMapIterator* query_get(struct Transaction* transaction, const char* query, const struct Options* options) ----- - - - -Performs a TypeQL Get (Get) query in the transaction. - -[caption=""] -.Returns -`struct ConceptMapIterator*` - -[#_query_get_aggregate] -==== query_get_aggregate - -[source,cpp] ----- -struct ConceptPromise* query_get_aggregate(struct Transaction* transaction, const char* query, const struct Options* options) ----- - - - -Performs a TypeQL Get Aggregate query in the transaction. - -[caption=""] -.Returns -`struct ConceptPromise*` - -[#_query_get_group] -==== query_get_group - -[source,cpp] ----- -struct ConceptMapGroupIterator* query_get_group(struct Transaction* transaction, const char* query, const struct Options* options) ----- - - - -Performs a TypeQL Get Group query in the transaction. - -[caption=""] -.Returns -`struct ConceptMapGroupIterator*` - -[#_query_get_group_aggregate] -==== query_get_group_aggregate - -[source,cpp] ----- -struct ValueGroupIterator* query_get_group_aggregate(struct Transaction* transaction, const char* query, const struct Options* options) ----- - - - -Performs a TypeQL Get Group Aggregate query in the transaction. - -[caption=""] -.Returns -`struct ValueGroupIterator*` - -[#_query_insert] -==== query_insert - -[source,cpp] ----- -struct ConceptMapIterator* query_insert(struct Transaction* transaction, const char* query, const struct Options* options) ----- - - - -Performs a TypeQL Insert query in the transaction. - -[caption=""] -.Returns -`struct ConceptMapIterator*` - -[#_query_undefine] -==== query_undefine - -[source,cpp] ----- -struct VoidPromise* query_undefine(struct Transaction* transaction, const char* query, const struct Options* options) ----- - - - -Performs a TypeQL Undefine query in the transaction. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_query_update] -==== query_update - -[source,cpp] ----- -struct ConceptMapIterator* query_update(struct Transaction* transaction, const char* query, const struct Options* options) ----- - - - -Performs a TypeQL Update query in the transaction. - -[caption=""] -.Returns -`struct ConceptMapIterator*` - diff --git a/c/docs/transaction/transaction.adoc b/c/docs/transaction/transaction.adoc deleted file mode 100644 index 361a4d1d5a..0000000000 --- a/c/docs/transaction/transaction.adoc +++ /dev/null @@ -1,173 +0,0 @@ -[#_methods__transaction__transaction] -=== transaction - -[#_Struct_Transaction] -==== Struct Transaction - - - -A transaction with a TypeDB database. - -[#_Struct_TransactionType] -==== Struct TransactionType - - - -This enum is used to specify the type of transaction. - - -[#_Enum_TransactionType] -==== Enum TransactionType - - - -This enum is used to specify the type of transaction. - - -[caption=""] -.Enum constants -// tag::enum_constants[] -[cols="~"] -[options="header"] -|=== -|Name -a| `Read = 0` -a| `Write = 1` -|=== -// end::enum_constants[] - -[#_transaction_close] -==== transaction_close - -[source,cpp] ----- -void transaction_close(struct Transaction* txn) ----- - - - -Closes the transaction and frees the native rust object. - -[caption=""] -.Returns -`void` - -[#_transaction_commit] -==== transaction_commit - -[source,cpp] ----- -struct VoidPromise* transaction_commit(struct Transaction* txn) ----- - - - -Commits the changes made via this transaction to the TypeDB database. Whether or not the transaction is commited successfully, the transaction is closed after the commit call and the native rust object is freed. - -[caption=""] -.Returns -`struct VoidPromise*` - -[#_transaction_force_close] -==== transaction_force_close - -[source,cpp] ----- -void transaction_force_close(struct Transaction* txn) ----- - - - -Forcibly closes this transaction. To be used in exceptional cases. - -[caption=""] -.Returns -`void` - -[#_transaction_is_open] -==== transaction_is_open - -[source,cpp] ----- -bool transaction_is_open(const struct Transaction* txn) ----- - - - -Checks whether this transaction is open. - -[caption=""] -.Returns -`bool` - -[#_transaction_new] -==== transaction_new - -[source,cpp] ----- -struct Transaction* transaction_new(const struct Session* session, enum TransactionType type_, const struct Options* options) ----- - - - -Opens a transaction to perform read or write queries on the database connected to the session. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `type_` a| The type of transaction to be created (Write or Read). a| -a| `options` a| Options for the transaction a| -|=== - -[caption=""] -.Returns -`struct Transaction*` - -[#_transaction_on_close] -==== transaction_on_close - -[source,cpp] ----- -void transaction_on_close(const struct Transaction* txn, uintptr_t callback_id, void(*)(uintptr_t, struct Error*) callback) ----- - - - -Registers a callback function which will be executed when this transaction is closed. - - -[caption=""] -.Input parameters -[cols="~,~,~"] -[options="header"] -|=== -|Name |Description |Type -a| `txn` a| The transaction on which to register the callback a| -a| `callback_id` a| The argument to be passed to the callback function when it is executed. a| -a| `callback` a| The function to be called a| -|=== - -[caption=""] -.Returns -`void` - -[#_transaction_rollback] -==== transaction_rollback - -[source,cpp] ----- -struct VoidPromise* transaction_rollback(const struct Transaction* txn) ----- - - - -Rolls back the uncommitted changes made via this transaction. - -[caption=""] -.Returns -`struct VoidPromise*` - diff --git a/cpp/README.md b/cpp/README.md index 7eb7a64270..40f921eff5 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -27,7 +27,7 @@ Any error encountered will throw a `TypeDB::DriverException`. Note that methods ## Build TypeDB Driver for C++ from Source -1. Make sure you have [Bazel](https://docs.bazel.build/versions/master/install.html) installed on your machine: +1. Make sure you have [Bazel](https://docs.bazel.build/versions/master/install.html) installed on your machine. 2. Build the shared-library: a) Building just the shared library: diff --git a/csharp/Test/Integration/Examples/BUILD b/csharp/Test/Integration/Examples/BUILD index f6c4097650..c5faae655f 100644 --- a/csharp/Test/Integration/Examples/BUILD +++ b/csharp/Test/Integration/Examples/BUILD @@ -21,8 +21,21 @@ load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") csharp_integration_test( - name = "test", - srcs = ["ExamplesTest.cs"], + name = "test-core", + srcs = ["CoreExamplesTest.cs"], + deps = [ + "//csharp:driver-csharp", + "//csharp/Api:api", + "//csharp/Common:common", + ], + target_frameworks = target_frameworks, + targeting_packs = targeting_packs, +) + + +csharp_integration_test( + name = "test-cloud", + srcs = ["CloudExamplesTest.cs"], deps = [ "//csharp:driver-csharp", "//csharp/Api:api", diff --git a/csharp/Test/Integration/Examples/CloudExamplesTest.cs b/csharp/Test/Integration/Examples/CloudExamplesTest.cs new file mode 100644 index 0000000000..d42f2fefc4 --- /dev/null +++ b/csharp/Test/Integration/Examples/CloudExamplesTest.cs @@ -0,0 +1,125 @@ +/* + * Copyright (C) 2022 Vaticle + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +using NUnit.Framework; +using System; +using System.Collections.Generic; +using System.Linq; + +using TypeDB.Driver.Api; +using TypeDB.Driver.Common; + +namespace TypeDB.Driver.Test.Integration +{ + [TestFixture] + public class CloudExamplesTestFixture + { + [Test] + public void DocExample() + { + string dbName = "access-management-db"; + + // You can also specify all node addresses like: {"localhost:11729", "localhost:21729", "localhost:31729"} + string[] serverAddrs = new string[]{"localhost:11729"}; + + try + { + TypeDBCredential connectCredential = new TypeDBCredential( + "admin", + "password", + Environment.GetEnvironmentVariable("ROOT_CA")!); + + using (ITypeDBDriver driver = TypeDB.CloudDriver(serverAddrs, connectCredential)) + { + driver.Databases.Create(dbName); + IDatabase database = driver.Databases.Get(dbName); + + TypeDBOptions options = new TypeDBOptions(); + + // Example of one transaction for one session with options + using (ITypeDBSession session = driver.Session(dbName, SessionType.Schema, options)) + { + // Example of multiple queries for one transaction with options + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Write, options)) + { + transaction.Query.Define("define person sub entity;").Resolve(); + + string longQuery = "define name sub attribute, value string; person owns name;"; + transaction.Query.Define(longQuery).Resolve(); + + transaction.Commit(); + } + } + + // Example of multiple transactions for one session without options + using (ITypeDBSession session = driver.Session(dbName, SessionType.Data)) + { + // Examples of one query for one transaction without options + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Write)) + { + string query = "insert $p isa person, has name 'Alice';"; + IEnumerable insertResults = transaction.Query.Insert(query); + + Console.WriteLine($"Inserted with {insertResults.Count()} result(s)"); + + transaction.Commit(); + } + + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Write)) + { + IEnumerable insertResults = + transaction.Query.Insert("insert $p isa person, has name 'Bob';"); + + foreach (IConceptMap insertResult in insertResults) + { + Console.WriteLine($"Inserted: {insertResult}"); + } + + // transaction.Commit(); // Not committed + } + + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Read)) + { + IConceptMap[] matchResults = + transaction.Query.Get("match $p isa person, has name $n; get $n;").ToArray(); + + // Matches only Alice as Bob has not been committed + var resultName = matchResults[0].Get("n"); + Console.WriteLine($"Found the first name: {resultName.AsAttribute().Value.AsString()}"); + + if (matchResults.Length > 1) // Will work only if the previous transaction is committed + { + Console.WriteLine($"Found the second name as concept: {matchResults[1]}"); + } + } + } + + database.Delete(); + } + } + catch (TypeDBDriverException e) + { + Console.WriteLine($"Caught TypeDB Driver Exception: {e}"); + // ... + } + } + } +} diff --git a/csharp/Test/Integration/Examples/ExamplesTest.cs b/csharp/Test/Integration/Examples/CoreExamplesTest.cs similarity index 98% rename from csharp/Test/Integration/Examples/ExamplesTest.cs rename to csharp/Test/Integration/Examples/CoreExamplesTest.cs index b366a153c1..841745814a 100644 --- a/csharp/Test/Integration/Examples/ExamplesTest.cs +++ b/csharp/Test/Integration/Examples/CoreExamplesTest.cs @@ -28,66 +28,10 @@ namespace TypeDB.Driver.Test.Integration { [TestFixture] - public class QuickstartTestFixture + public class CoreExamplesTestFixture { - private void ProcessPersonInsertResult( - IConceptMap[] results, - string variableName, - string expectedVariableTypeLabel, - string expectedAttributeValue) - { - Assert.AreEqual(1, results.Length); - - var result = results[0]; - Assert.AreEqual(2, result.GetVariables().Count()); - Assert.AreEqual(2, result.GetConcepts().Count()); - - var entity = result.Get(variableName); - Assert.IsNotNull(entity); - Assert.IsTrue(entity.IsEntity()); - - var entityType = entity.AsEntity().Type; - Assert.IsNotNull(entityType); - Assert.IsTrue(entityType.IsType() && entityType.IsEntityType()); - Assert.AreEqual(expectedVariableTypeLabel, entityType.Label.ToString()); - - var attribute = result.Get("_0"); - Assert.IsNotNull(attribute); - Assert.IsTrue(attribute.IsAttribute()); - - var attributeValue = attribute.AsAttribute().Value; - Assert.IsNotNull(attributeValue); - Assert.IsTrue(attributeValue.IsString()); - Assert.AreEqual(expectedAttributeValue, attributeValue.AsString()); - } - - private void ProcessPersonMatchResult( - IConceptMap[] results, - string variableName, - string expectedVariableTypeLabel, - string expectedAttributeValue) - { - Assert.AreEqual(1, results.Length); // Only one insert has been committed - - var result = results[0]; - - var attribute = result.Get(variableName); - Assert.IsNotNull(attribute); - Assert.IsTrue(attribute.IsAttribute()); - - var attributeValue = attribute.AsAttribute().Value; - Assert.IsNotNull(attributeValue); - Assert.IsTrue(attributeValue.IsString()); - Assert.AreEqual(expectedAttributeValue, attributeValue.AsString()); - - var attributeType = attribute.AsAttribute().Type; - Assert.IsNotNull(attributeType); - Assert.IsTrue(attributeType.IsType() && attributeType.IsAttributeType()); - Assert.AreEqual(expectedVariableTypeLabel, attributeType.Label.ToString()); - } - [Test] - public void Usings() + public void UsingsExample() { string dbName = "access-management-db"; string serverAddr = "127.0.0.1:1729"; @@ -157,7 +101,7 @@ public void Usings() } [Test] - public void Manual() + public void ManualExample() { string dbName = "access-management-db"; string serverAddr = "127.0.0.1:1729"; @@ -281,7 +225,7 @@ public void DocExample() var resultName = matchResults[0].Get("n"); Console.WriteLine($"Found the first name: {resultName.AsAttribute().Value.AsString()}"); - if (matchResults.Length > 1) // Will work only if the previous transaction is committed. + if (matchResults.Length > 1) // Will work only if the previous transaction is committed { Console.WriteLine($"Found the second name as concept: {matchResults[1]}"); } @@ -297,5 +241,61 @@ public void DocExample() // ... } } + + private void ProcessPersonInsertResult( + IConceptMap[] results, + string variableName, + string expectedVariableTypeLabel, + string expectedAttributeValue) + { + Assert.AreEqual(1, results.Length); + + var result = results[0]; + Assert.AreEqual(2, result.GetVariables().Count()); + Assert.AreEqual(2, result.GetConcepts().Count()); + + var entity = result.Get(variableName); + Assert.IsNotNull(entity); + Assert.IsTrue(entity.IsEntity()); + + var entityType = entity.AsEntity().Type; + Assert.IsNotNull(entityType); + Assert.IsTrue(entityType.IsType() && entityType.IsEntityType()); + Assert.AreEqual(expectedVariableTypeLabel, entityType.Label.ToString()); + + var attribute = result.Get("_0"); + Assert.IsNotNull(attribute); + Assert.IsTrue(attribute.IsAttribute()); + + var attributeValue = attribute.AsAttribute().Value; + Assert.IsNotNull(attributeValue); + Assert.IsTrue(attributeValue.IsString()); + Assert.AreEqual(expectedAttributeValue, attributeValue.AsString()); + } + + private void ProcessPersonMatchResult( + IConceptMap[] results, + string variableName, + string expectedVariableTypeLabel, + string expectedAttributeValue) + { + Assert.AreEqual(1, results.Length); // Only one insert has been committed + + var result = results[0]; + + var attribute = result.Get(variableName); + Assert.IsNotNull(attribute); + Assert.IsTrue(attribute.IsAttribute()); + + var attributeValue = attribute.AsAttribute().Value; + Assert.IsNotNull(attributeValue); + Assert.IsTrue(attributeValue.IsString()); + Assert.AreEqual(expectedAttributeValue, attributeValue.AsString()); + + var attributeType = attribute.AsAttribute().Type; + Assert.IsNotNull(attributeType); + Assert.IsTrue(attributeType.IsType() && attributeType.IsAttributeType()); + Assert.AreEqual(expectedVariableTypeLabel, attributeType.Label.ToString()); + } } } diff --git a/csharp/docs/answer/IConceptMap.adoc b/csharp/docs/answer/IConceptMap.adoc index 9f1ab81112..7120cf685e 100644 --- a/csharp/docs/answer/IConceptMap.adoc +++ b/csharp/docs/answer/IConceptMap.adoc @@ -8,6 +8,30 @@ Contains a mapping of variables to concepts. // tag::methods[] +[#_IExplainables_TypeDB_Driver_Api_IConceptMap_AllExplainables] +==== AllExplainables + +[source,cs] +---- +IExplainables TypeDB.Driver.Api.IConceptMap.AllExplainables +---- + + + +Gets the ``IExplainables`` object for this ``IConceptMap``, exposing which of the concepts in this ``IConceptMap`` are explainable. + + +[caption=""] +.Returns +`IExplainables` + +[caption=""] +.Code examples +[source,cs] +---- +conceptMap.AllExplainables; +---- + [#_IConcept_TypeDB_Driver_Api_IConceptMap_Get___string_variable_] ==== Get diff --git a/csharp/docs/answer/IConceptMapGroup.adoc b/csharp/docs/answer/IConceptMapGroup.adoc index 4d7944b9db..455ef1d7c1 100644 --- a/csharp/docs/answer/IConceptMapGroup.adoc +++ b/csharp/docs/answer/IConceptMapGroup.adoc @@ -32,5 +32,29 @@ Retrieves the ``IConceptMap``s of the group. conceptMapGroup.GetConceptMaps(); ---- +[#_IConcept_TypeDB_Driver_Api_IConceptMapGroup_Owner] +==== Owner + +[source,cs] +---- +IConcept TypeDB.Driver.Api.IConceptMapGroup.Owner +---- + + + +Retrieves the concept that is the group owner. + + +[caption=""] +.Returns +`IConcept` + +[caption=""] +.Code examples +[source,cs] +---- +conceptMapGroup.Owner; +---- + // end::methods[] diff --git a/csharp/docs/answer/IExplainable.adoc b/csharp/docs/answer/IExplainable.adoc index 98ec92193b..d0efa533aa 100644 --- a/csharp/docs/answer/IExplainable.adoc +++ b/csharp/docs/answer/IExplainable.adoc @@ -7,3 +7,54 @@ Contains an explainable object. +// tag::methods[] +[#_string_TypeDB_Driver_Api_IConceptMap_IExplainable_Conjunction] +==== Conjunction + +[source,cs] +---- +string TypeDB.Driver.Api.IConceptMap.IExplainable.Conjunction +---- + + + +Retrieves the subquery of the original query that is actually being explained. + + +[caption=""] +.Returns +`string` + +[caption=""] +.Code examples +[source,cs] +---- +explainable.Conjunction; +---- + +[#_long_TypeDB_Driver_Api_IConceptMap_IExplainable_Id] +==== Id + +[source,cs] +---- +long TypeDB.Driver.Api.IConceptMap.IExplainable.Id +---- + + + +Retrieves the unique ID that identifies this ``IExplainable``. + + +[caption=""] +.Returns +`long` + +[caption=""] +.Code examples +[source,cs] +---- +explainable.Id; +---- + +// end::methods[] + diff --git a/csharp/docs/answer/IExplanation.adoc b/csharp/docs/answer/IExplanation.adoc index 66b5bf0b30..3e1d706f58 100644 --- a/csharp/docs/answer/IExplanation.adoc +++ b/csharp/docs/answer/IExplanation.adoc @@ -8,6 +8,54 @@ An explanation of which rule was used for inferring the explained concept, the condition of the rule, the conclusion of the rule, and the mapping of variables between the query and the rule’s conclusion. // tag::methods[] +[#_IConceptMap_TypeDB_Driver_Api_IExplanation_Conclusion] +==== Conclusion + +[source,cs] +---- +IConceptMap TypeDB.Driver.Api.IExplanation.Conclusion +---- + + + +Retrieves the Conclusion for this Explanation. + + +[caption=""] +.Returns +`IConceptMap` + +[caption=""] +.Code examples +[source,cs] +---- +explanation.Conclusion +---- + +[#_IConceptMap_TypeDB_Driver_Api_IExplanation_Condition] +==== Condition + +[source,cs] +---- +IConceptMap TypeDB.Driver.Api.IExplanation.Condition +---- + + + +Retrieves the Condition for this Explanation. + + +[caption=""] +.Returns +`IConceptMap` + +[caption=""] +.Code examples +[source,cs] +---- +explanation.Condition +---- + [#_ISet__string___TypeDB_Driver_Api_IExplanation_GetQueryVariables___] ==== GetQueryVariables @@ -65,5 +113,29 @@ a| `variable` a| The query variable to map to rule variables. a| explanation.VariableMapping(variable) ---- +[#_IRule_TypeDB_Driver_Api_IExplanation_Rule] +==== Rule + +[source,cs] +---- +IRule TypeDB.Driver.Api.IExplanation.Rule +---- + + + +Retrieves the Rule for this Explanation. + + +[caption=""] +.Returns +`IRule` + +[caption=""] +.Code examples +[source,cs] +---- +explanation.Rule; +---- + // end::methods[] diff --git a/csharp/docs/answer/IValueGroup.adoc b/csharp/docs/answer/IValueGroup.adoc index 1731be72fc..8ac5143692 100644 --- a/csharp/docs/answer/IValueGroup.adoc +++ b/csharp/docs/answer/IValueGroup.adoc @@ -7,3 +7,54 @@ Contains an element of the group aggregate query result. +// tag::methods[] +[#_IConcept_TypeDB_Driver_Api_IValueGroup_Owner] +==== Owner + +[source,cs] +---- +IConcept TypeDB.Driver.Api.IValueGroup.Owner +---- + + + +Retrieves the concept that is the group owner. + + +[caption=""] +.Returns +`IConcept` + +[caption=""] +.Code examples +[source,cs] +---- +conceptMapGroup.Owner; +---- + +[#_IValue_TypeDB_Driver_Api_IValueGroup_Value] +==== Value + +[source,cs] +---- +IValue? TypeDB.Driver.Api.IValueGroup.Value +---- + + + +Retrieves the ``Value`` answer of the group. + + +[caption=""] +.Returns +`IValue?` + +[caption=""] +.Code examples +[source,cs] +---- +valueGroup.Value; +---- + +// end::methods[] + diff --git a/csharp/docs/concept/IConceptManager.adoc b/csharp/docs/concept/IConceptManager.adoc index 02353eab46..7fbe072e1a 100644 --- a/csharp/docs/concept/IConceptManager.adoc +++ b/csharp/docs/concept/IConceptManager.adoc @@ -330,5 +330,77 @@ a| `label` a| The label of the ``IRelationType`` to create or retrieve. a| transaction.Concepts.PutRelationType(label).Resolve(); ---- +[#_IAttributeType_TypeDB_Driver_Api_IConceptManager_RootAttributeType] +==== RootAttributeType + +[source,cs] +---- +IAttributeType TypeDB.Driver.Api.IConceptManager.RootAttributeType +---- + + + +The root ``IAttributeType``, “attribute”. + + +[caption=""] +.Returns +`IAttributeType` + +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.RootAttributeType; +---- + +[#_IEntityType_TypeDB_Driver_Api_IConceptManager_RootEntityType] +==== RootEntityType + +[source,cs] +---- +IEntityType TypeDB.Driver.Api.IConceptManager.RootEntityType +---- + + + +The root ``IEntityType``, “entity”. + + +[caption=""] +.Returns +`IEntityType` + +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.RootEntityType; +---- + +[#_IRelationType_TypeDB_Driver_Api_IConceptManager_RootRelationType] +==== RootRelationType + +[source,cs] +---- +IRelationType TypeDB.Driver.Api.IConceptManager.RootRelationType +---- + + + +The root ``IRelationType``, “relation”. + + +[caption=""] +.Returns +`IRelationType` + +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts.RootRelationType; +---- + // end::methods[] diff --git a/csharp/docs/connection/IDatabase.adoc b/csharp/docs/connection/IDatabase.adoc index 1da987922e..bfff7593f2 100644 --- a/csharp/docs/connection/IDatabase.adoc +++ b/csharp/docs/connection/IDatabase.adoc @@ -124,5 +124,77 @@ The types in the schema as a valid TypeQL define query string. database.GetTypeSchema(); ---- +[#_string_TypeDB_Driver_Api_IDatabase_Name] +==== Name + +[source,cs] +---- +string TypeDB.Driver.Api.IDatabase.Name +---- + + + +The database name as a string. + + +[caption=""] +.Returns +`string` + +[caption=""] +.Code examples +[source,cs] +---- +database.Name; +---- + +[#_IReplica_TypeDB_Driver_Api_IDatabase_PreferredReplica] +==== PreferredReplica + +[source,cs] +---- +IReplica? TypeDB.Driver.Api.IDatabase.PreferredReplica +---- + + + +Returns the preferred replica for this database. Operations which can be run on any replica will prefer to use this replica. _Only works in TypeDB Cloud_ + + +[caption=""] +.Returns +`IReplica?` + +[caption=""] +.Code examples +[source,cs] +---- +database.PreferredReplica; +---- + +[#_IReplica_TypeDB_Driver_Api_IDatabase_PrimaryReplica] +==== PrimaryReplica + +[source,cs] +---- +IReplica? TypeDB.Driver.Api.IDatabase.PrimaryReplica +---- + + + +Returns the primary replica for this database. _Only works in TypeDB Cloud_ + + +[caption=""] +.Returns +`IReplica?` + +[caption=""] +.Code examples +[source,cs] +---- +database.PrimaryReplica; +---- + // end::methods[] diff --git a/csharp/docs/connection/IReplica.adoc b/csharp/docs/connection/IReplica.adoc index e26be886e8..edf44d3b13 100644 --- a/csharp/docs/connection/IReplica.adoc +++ b/csharp/docs/connection/IReplica.adoc @@ -8,6 +8,22 @@ The metadata and state of an individual raft replica of a database. // tag::methods[] +[#_string_TypeDB_Driver_Api_IDatabase_IReplica_Address] +==== Address + +[source,cs] +---- +string TypeDB.Driver.Api.IDatabase.IReplica.Address +---- + + + +Retrieves the address of the server hosting this replica. + +[caption=""] +.Returns +`string` + [#_bool_TypeDB_Driver_Api_IDatabase_IReplica_IsPreferred___] ==== IsPreferred @@ -40,5 +56,21 @@ Checks whether this is the primary replica of the raft cluster. .Returns `bool` +[#_long_TypeDB_Driver_Api_IDatabase_IReplica_Term] +==== Term + +[source,cs] +---- +long TypeDB.Driver.Api.IDatabase.IReplica.Term +---- + + + +The raft protocol ‘term’ of this replica. + +[caption=""] +.Returns +`long` + // end::methods[] diff --git a/csharp/docs/connection/ITypeDBDriver.adoc b/csharp/docs/connection/ITypeDBDriver.adoc index 8041d77f5a..bf99c996a0 100644 --- a/csharp/docs/connection/ITypeDBDriver.adoc +++ b/csharp/docs/connection/ITypeDBDriver.adoc @@ -28,6 +28,30 @@ Closes the driver. Before instantiating a new driver, the driver that’s curren driver.Close(); ---- +[#_IDatabaseManager_TypeDB_Driver_Api_ITypeDBDriver_Databases] +==== Databases + +[source,cs] +---- +IDatabaseManager TypeDB.Driver.Api.ITypeDBDriver.Databases +---- + + + +The ``IDatabaseManager`` for this connection, providing access to database management methods. + + +[caption=""] +.Returns +`IDatabaseManager` + +[caption=""] +.Code examples +[source,cs] +---- +driver.Databases; +---- + [#_IUser_TypeDB_Driver_Api_ITypeDBDriver_GetCurrentUser___] ==== GetCurrentUser @@ -135,5 +159,29 @@ a| `options` a| ``TypeDBOptions`` for the session a| driver.Session(database, sessionType, options); ---- +[#_IUserManager_TypeDB_Driver_Api_ITypeDBDriver_Users] +==== Users + +[source,cs] +---- +IUserManager TypeDB.Driver.Api.ITypeDBDriver.Users +---- + + + +The ``UserManager`` instance for this connection, providing access to user management methods. Only for TypeDB Cloud. + + +[caption=""] +.Returns +`IUserManager` + +[caption=""] +.Code examples +[source,cs] +---- +driver.Users; +---- + // end::methods[] diff --git a/csharp/docs/connection/IUser.adoc b/csharp/docs/connection/IUser.adoc index 609393e85b..9e709faaaf 100644 --- a/csharp/docs/connection/IUser.adoc +++ b/csharp/docs/connection/IUser.adoc @@ -8,6 +8,22 @@ TypeDB user information // tag::methods[] +[#_long_TypeDB_Driver_Api_IUser_PasswordExpirySeconds] +==== PasswordExpirySeconds + +[source,cs] +---- +long? TypeDB.Driver.Api.IUser.PasswordExpirySeconds +---- + + + +Returns the number of seconds remaining till this user’s current password expires. + +[caption=""] +.Returns +`long?` + [#_void_TypeDB_Driver_Api_IUser_UpdatePassword___string_passwordOld__string_passwordNew_] ==== UpdatePassword @@ -53,5 +69,21 @@ a| `passwordNew` a| The new password a| .Returns `void` +[#_string_TypeDB_Driver_Api_IUser_Username] +==== Username + +[source,cs] +---- +string TypeDB.Driver.Api.IUser.Username +---- + + + +Returns the name of this user. + +[caption=""] +.Returns +`string` + // end::methods[] diff --git a/csharp/docs/data/IAttribute.adoc b/csharp/docs/data/IAttribute.adoc index 43b48e4b61..cdfb52e4a7 100644 --- a/csharp/docs/data/IAttribute.adoc +++ b/csharp/docs/data/IAttribute.adoc @@ -134,5 +134,29 @@ Implements TypeDB.Driver.Api.IConcept. attribute.IsAttribute(); ---- +[#_IValue_TypeDB_Driver_Api_IAttribute_Value] +==== Value + +[source,cs] +---- +IValue TypeDB.Driver.Api.IAttribute.Value +---- + + + +Retrieves the value which the ``IAttribute`` instance holds. + + +[caption=""] +.Returns +`IValue` + +[caption=""] +.Code examples +[source,cs] +---- +attribute.Value; +---- + // end::methods[] diff --git a/csharp/docs/data/IThing.adoc b/csharp/docs/data/IThing.adoc index 5d7d969f21..eb88582112 100644 --- a/csharp/docs/data/IThing.adoc +++ b/csharp/docs/data/IThing.adoc @@ -204,6 +204,30 @@ a| `roleTypes` a| The array of roles to filter the relations by. a| thing.GetRelations(transaction, roleTypes); ---- +[#_string_TypeDB_Driver_Api_IThing_IID] +==== IID + +[source,cs] +---- +string TypeDB.Driver.Api.IThing.IID +---- + + + +The unique id of the ``IThing``. + + +[caption=""] +.Returns +`string` + +[caption=""] +.Code examples +[source,cs] +---- +thing.IID; +---- + [#_Promise__bool___TypeDB_Driver_Api_IThing_IsDeleted___ITypeDBTransaction_transaction_] ==== IsDeleted @@ -321,6 +345,30 @@ a| `attribute` a| The ``IAttribute`` to be owned by this ``IThing``. a| thing.SetHas(transaction, attribute).Resolve(); ---- +[#_IThingType_TypeDB_Driver_Api_IThing_Type] +==== Type + +[source,cs] +---- +IThingType TypeDB.Driver.Api.IThing.Type +---- + + + +The type which this ``IThing`` belongs to. + + +[caption=""] +.Returns +`IThingType` + +[caption=""] +.Code examples +[source,cs] +---- +thing.Type; +---- + [#_VoidPromise_TypeDB_Driver_Api_IThing_UnsetHas___ITypeDBTransaction_transaction__IAttribute_attribute_] ==== UnsetHas diff --git a/csharp/docs/data/IValue.adoc b/csharp/docs/data/IValue.adoc index fc2f2298fc..e01b9553e3 100644 --- a/csharp/docs/data/IValue.adoc +++ b/csharp/docs/data/IValue.adoc @@ -328,5 +328,29 @@ Implements TypeDB.Driver.Api.IConcept. concept.IsValue(); ---- +[#_ValueType_TypeDB_Driver_Api_IValue_Type] +==== Type + +[source,cs] +---- +ValueType TypeDB.Driver.Api.IValue.Type +---- + + + +Retrieves the ``IValue.ValueType`` of this value concept. + + +[caption=""] +.Returns +`ValueType` + +[caption=""] +.Code examples +[source,cs] +---- +value.Type; +---- + // end::methods[] diff --git a/csharp/docs/logic/IRule.adoc b/csharp/docs/logic/IRule.adoc index bf92279636..aca12eeefd 100644 --- a/csharp/docs/logic/IRule.adoc +++ b/csharp/docs/logic/IRule.adoc @@ -74,6 +74,22 @@ a| `transaction` a| The current ``Transaction`` a| rule.IsDeleted(transaction).Resolve(); ---- +[#_string_TypeDB_Driver_Api_IRule_Label] +==== Label + +[source,cs] +---- +string TypeDB.Driver.Api.IRule.Label +---- + + + +Retrieves the unique label of the rule. + +[caption=""] +.Returns +`string` + [#_VoidPromise_TypeDB_Driver_Api_IRule_SetLabel___ITypeDBTransaction_transaction__string_label_] ==== SetLabel @@ -108,5 +124,37 @@ a| `label` a| The new label to be given to the rule a| rule.SetLabel(transaction, newLabel).Resolve(); ---- +[#_string_TypeDB_Driver_Api_IRule_Then] +==== Then + +[source,cs] +---- +string TypeDB.Driver.Api.IRule.Then +---- + + + +The single statement that constitutes the ‘then’ of the rule. + +[caption=""] +.Returns +`string` + +[#_string_TypeDB_Driver_Api_IRule_When] +==== When + +[source,cs] +---- +string TypeDB.Driver.Api.IRule.When +---- + + + +The statements that constitute the ‘when’ of the rule. + +[caption=""] +.Returns +`string` + // end::methods[] diff --git a/csharp/docs/schema/IAttributeType.adoc b/csharp/docs/schema/IAttributeType.adoc index 0bc9bf2c09..47432346d0 100644 --- a/csharp/docs/schema/IAttributeType.adoc +++ b/csharp/docs/schema/IAttributeType.adoc @@ -945,5 +945,29 @@ a| `transaction` a| The current transaction a| attributeType.UnsetRegex(transaction).Resolve(); ---- +[#_IValue_ValueType_TypeDB_Driver_Api_IAttributeType_ValueType] +==== ValueType + +[source,cs] +---- +IValue.ValueType TypeDB.Driver.Api.IAttributeType.ValueType +---- + + + +The ``IValue.ValueType`` of this ``IAttributeType``. + + +[caption=""] +.Returns +`IValue.ValueType` + +[caption=""] +.Code examples +[source,cs] +---- +attributeType.ValueType; +---- + // end::methods[] diff --git a/csharp/docs/schema/IType.adoc b/csharp/docs/schema/IType.adoc index 502c3abe3a..c7eee17ff7 100644 --- a/csharp/docs/schema/IType.adoc +++ b/csharp/docs/schema/IType.adoc @@ -303,6 +303,30 @@ Implements TypeDB.Driver.Api.IConcept. concept.IsType(); ---- +[#_Label_TypeDB_Driver_Api_IType_Label] +==== Label + +[source,cs] +---- +Label TypeDB.Driver.Api.IType.Label +---- + + + +The unique label of the type. + + +[caption=""] +.Returns +`Label` + +[caption=""] +.Code examples +[source,cs] +---- +type.Label; +---- + [#_VoidPromise_TypeDB_Driver_Api_IType_SetLabel___ITypeDBTransaction_transaction__string_label_] ==== SetLabel diff --git a/csharp/docs/schema/Label.adoc b/csharp/docs/schema/Label.adoc index 8343cdc880..91ef2bdeb3 100644 --- a/csharp/docs/schema/Label.adoc +++ b/csharp/docs/schema/Label.adoc @@ -152,6 +152,30 @@ a| `name` a| Label name a| new Label("entity"); ---- +[#_string_TypeDB_Driver_Common_Label_ScopedName] +==== ScopedName + +[source,cs] +---- +string TypeDB.Driver.Common.Label.ScopedName +---- + + + +Returns the string representation of the scoped name. + + +[caption=""] +.Returns +`string` + +[caption=""] +.Code examples +[source,cs] +---- +label.ScopedName; +---- + [#_override_string_TypeDB_Driver_Common_Label_ToString___] ==== ToString diff --git a/csharp/docs/session/ITypeDBSession.adoc b/csharp/docs/session/ITypeDBSession.adoc index 3351e85cd9..d35bc7a365 100644 --- a/csharp/docs/session/ITypeDBSession.adoc +++ b/csharp/docs/session/ITypeDBSession.adoc @@ -28,6 +28,30 @@ Closes the session. Before opening a new session, the session currently open sho session.Close(); ---- +[#_string_TypeDB_Driver_Api_ITypeDBSession_DatabaseName] +==== DatabaseName + +[source,cs] +---- +string TypeDB.Driver.Api.ITypeDBSession.DatabaseName +---- + + + +Returns the name of the database of the session. + + +[caption=""] +.Returns +`string` + +[caption=""] +.Code examples +[source,cs] +---- +session.DatabaseName; +---- + [#_bool_TypeDB_Driver_Api_ITypeDBSession_IsOpen___] ==== IsOpen @@ -118,6 +142,30 @@ a| `function` a| The callback function. a| session.OnReopen(function); ---- +[#_TypeDBOptions_TypeDB_Driver_Api_ITypeDBSession_Options] +==== Options + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.ITypeDBSession.Options +---- + + + +Gets the options for the session. + + +[caption=""] +.Returns +`TypeDBOptions` + +[caption=""] +.Code examples +[source,cs] +---- +session.Options; +---- + [#_ITypeDBTransaction_TypeDB_Driver_Api_ITypeDBSession_Transaction___TransactionType_type_] ==== Transaction @@ -176,5 +224,29 @@ a| `options` a| Options for the session a| session.Transaction(transactionType, options); ---- +[#_SessionType_TypeDB_Driver_Api_ITypeDBSession_Type] +==== Type + +[source,cs] +---- +SessionType TypeDB.Driver.Api.ITypeDBSession.Type +---- + + + +The current session’s type (Schema or Data). + + +[caption=""] +.Returns +`SessionType` + +[caption=""] +.Code examples +[source,cs] +---- +session.Type; +---- + // end::methods[] diff --git a/csharp/docs/transaction/ITypeDBTransaction.adoc b/csharp/docs/transaction/ITypeDBTransaction.adoc index 53074b4188..88602059b1 100644 --- a/csharp/docs/transaction/ITypeDBTransaction.adoc +++ b/csharp/docs/transaction/ITypeDBTransaction.adoc @@ -52,6 +52,30 @@ Commits the changes made via this transaction to the TypeDB database. Whether or transaction.Commit(); ---- +[#_IConceptManager_TypeDB_Driver_Api_ITypeDBTransaction_Concepts] +==== Concepts + +[source,cs] +---- +IConceptManager TypeDB.Driver.Api.ITypeDBTransaction.Concepts +---- + + + +The ``ConceptManager`` for this transaction, providing access to all Concept API methods. + + +[caption=""] +.Returns +`IConceptManager` + +[caption=""] +.Code examples +[source,cs] +---- +transaction.Concepts; +---- + [#_bool_TypeDB_Driver_Api_ITypeDBTransaction_IsOpen___] ==== IsOpen @@ -76,6 +100,30 @@ Checks whether this transaction is open. transaction.IsOpen(); ---- +[#_ILogicManager_TypeDB_Driver_Api_ITypeDBTransaction_Logic] +==== Logic + +[source,cs] +---- +ILogicManager TypeDB.Driver.Api.ITypeDBTransaction.Logic +---- + + + +The ``LogicManager`` for this Transaction, providing access to all Concept API - Logic methods. + + +[caption=""] +.Returns +`ILogicManager` + +[caption=""] +.Code examples +[source,cs] +---- +transaction.Logic; +---- + [#_void_TypeDB_Driver_Api_ITypeDBTransaction_OnClose___Action__Exception___function_] ==== OnClose @@ -109,6 +157,54 @@ a| `function` a| The callback function. a| transaction.OnClose(function); ---- +[#_TypeDBOptions_TypeDB_Driver_Api_ITypeDBTransaction_Options] +==== Options + +[source,cs] +---- +TypeDBOptions TypeDB.Driver.Api.ITypeDBTransaction.Options +---- + + + +The options for the transaction. + + +[caption=""] +.Returns +`TypeDBOptions` + +[caption=""] +.Code examples +[source,cs] +---- +transaction.Options; +---- + +[#_IQueryManager_TypeDB_Driver_Api_ITypeDBTransaction_Query] +==== Query + +[source,cs] +---- +IQueryManager TypeDB.Driver.Api.ITypeDBTransaction.Query +---- + + + +The````QueryManager```` for this Transaction, from which any TypeQL query can be executed. + + +[caption=""] +.Returns +`IQueryManager` + +[caption=""] +.Code examples +[source,cs] +---- +transaction.Query; +---- + [#_void_TypeDB_Driver_Api_ITypeDBTransaction_Rollback___] ==== Rollback @@ -133,5 +229,29 @@ Rolls back the uncommitted changes made via this transaction. transaction.Rollback(); ---- +[#_TransactionType_TypeDB_Driver_Api_ITypeDBTransaction_Type] +==== Type + +[source,cs] +---- +TransactionType TypeDB.Driver.Api.ITypeDBTransaction.Type +---- + + + +The transaction’s type (Read or Write). + + +[caption=""] +.Returns +`TransactionType` + +[caption=""] +.Code examples +[source,cs] +---- +transaction.Type; +---- + // end::methods[] diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index 371c33c9f9..2733e8cbc2 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -83,8 +83,8 @@ class DoxygenParserCsharp : Callable { (it.toString().startsWith(htmlDocsDirectoryName + "class_type_") || it.toString().startsWith(htmlDocsDirectoryName + "interface_type_") || it.toString().startsWith(htmlDocsDirectoryName + "struct_type_")) - && it.toString().endsWith(".html") - && !it.toString().contains("-members") + && it.toString().endsWith(".html") + && !it.toString().contains("-members") }.forEach { val html = File(it.path).readText(Charsets.UTF_8) val parsed = Jsoup.parse(html) @@ -93,7 +93,7 @@ class DoxygenParserCsharp : Callable { if (parsedClass.isNotEmpty()) { classes.add(parsedClass) } - nestedParsedClasses.forEach{ element -> classes.add(element) } + nestedParsedClasses.forEach { element -> classes.add(element) } } classes.forEach { parsedClass -> @@ -125,12 +125,11 @@ class DoxygenParserCsharp : Callable { document.select("table.memberdecls").forEach { table -> val heading: String = table.selectFirst("tr.heading > td > h2 > a")!!.attr("name") - println(heading) val members: MutableList = ArrayList() table.select("tr") .filter { element -> - element.className().matches(Regex("memitem:[a-f0-9]+")) + element.className().matches(Regex("memitem:[a-f0-9]+")) }.forEach { element -> val id = element.className().substringAfter("memitem:") val type = element.selectFirst("td.memItemLeft")?.text() @@ -140,15 +139,13 @@ class DoxygenParserCsharp : Callable { if (memberDetails == null) { missingDeclarations.add(element.selectFirst("td.memItemRight")!!.text()) - } - else { + } else { if (type == "enum") { // Enums that are members of a class val parsedEnum = parseEnum(element, memberDetails) if (parsedEnum.isNotEmpty()) { nestedClasses.add(parsedEnum) } - } - else { + } else { members.add(memberDetails) idToAnchor[id] = replaceSymbolsForAnchor(memberDetails.select("table.memname").text()) } @@ -184,7 +181,8 @@ class DoxygenParserCsharp : Callable { val fields = memberDecls.getOrDefault("pub-attribs", listOf()).map { parseField(it, idToAnchor) } val methods: List = ( memberDecls.getOrDefault("pub-methods", listOf()) + - memberDecls.getOrDefault("pub-static-methods", listOf()) + memberDecls.getOrDefault("pub-static-methods", listOf()) + + memberDecls.getOrDefault("properties", listOf()) ).map { parseMethod(it, idToAnchor) } @@ -198,13 +196,15 @@ class DoxygenParserCsharp : Callable { fields = fields, methods = methods, packagePath = packagePath, - superClasses = superClasses), - nestedClasses) + superClasses = superClasses + ), + nestedClasses + ) } private fun parseEnum(constantsElement: Element, detailsElement: Element): Class { val typeAndName = detailsElement - ?.selectFirst("div.memitem > div.memproto > table.memname > tbody > tr > td.memname") + .selectFirst("div.memitem > div.memproto > table.memname > tbody > tr > td.memname") ?.text()?.split(" ")!! assert(typeAndName.size > 1) @@ -219,10 +219,10 @@ class DoxygenParserCsharp : Callable { val classExamples = detailsElement.select("div.memdoc > pre").map { replaceSpaces(it.text()) } val enumConstantsText = constantsElement - ?.selectFirst("td.memItemRight") + .selectFirst("td.memItemRight") ?.text()!! val enumConstants = Regex("[A-Za-z]+ = [A-Za-z.]+") - .findAll(enumConstantsText).map{ EnumConstant(it.value.substringBefore(" ")) }.toList() + .findAll(enumConstantsText).map { EnumConstant(it.value.substringBefore(" ")) }.toList() return Class( name = className, @@ -267,7 +267,6 @@ class DoxygenParserCsharp : Callable { examples = methodExamples, returnType = methodReturnType, ) - } private fun parseField(element: Element, idToAnchor: Map): Variable { diff --git a/tool/docs/update.sh b/tool/docs/update.sh index 5edf6076d7..148f17c14c 100755 --- a/tool/docs/update.sh +++ b/tool/docs/update.sh @@ -22,3 +22,4 @@ bazel run //python:docs_adoc bazel run //rust:docs_adoc bazel run //cpp:docs_adoc bazel run //c:docs_adoc +bazel run //csharp:docs_adoc From 482dd447224efd5500516d2029813cc51393c6e6 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Fri, 22 Mar 2024 16:51:09 +0000 Subject: [PATCH 036/118] Update deps temporarily --- dependencies/vaticle/repositories.bzl | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/dependencies/vaticle/repositories.bzl b/dependencies/vaticle/repositories.bzl index 9e2fde1dc1..d633c40f02 100644 --- a/dependencies/vaticle/repositories.bzl +++ b/dependencies/vaticle/repositories.bzl @@ -18,6 +18,11 @@ load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository") def vaticle_dependencies(): +# git_repository( +# name = "vaticle_dependencies", +# remote = "https://github.com/vaticle/dependencies", +# commit = "7518f8adaf5714512a8af96128b15cca7dedd475", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies +# ) git_repository( name = "vaticle_dependencies", remote = "https://github.com/vaticle/dependencies", From c0ac949a98b832edd3709ea50668748ff80063df Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 25 Mar 2024 11:31:52 +0000 Subject: [PATCH 037/118] Fix integration tests --- .factory/automation.yml | 4 +++- csharp/Test/Integration/Examples/CloudExamplesTest.cs | 1 + csharp/Test/Integration/Examples/CoreExamplesTest.cs | 3 +++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.factory/automation.yml b/.factory/automation.yml index ecb5d03620..07cdaefc62 100644 --- a/.factory/automation.yml +++ b/.factory/automation.yml @@ -460,7 +460,9 @@ build: bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh bazel run @vaticle_dependencies//distribution/artifact:create-netrc tool/test/start-core-server.sh && - bazel test //csharp/Test/Integration/... --test_output=streamed --jobs=1 && + bazel test //csharp/Test/Integration/Data/... --test_output=streamed --jobs=1 && + bazel test //csharp/Test/Integration/Marshal/... --test_output=streamed --jobs=1 && + .factory/test-core.sh //csharp/Test/Integration/Examples/... --test_output=streamed --jobs=1 && export TEST_SUCCESS=0 || export TEST_SUCCESS=1 tool/test/stop-core-server.sh exit $TEST_SUCCESS diff --git a/csharp/Test/Integration/Examples/CloudExamplesTest.cs b/csharp/Test/Integration/Examples/CloudExamplesTest.cs index d42f2fefc4..d32854198c 100644 --- a/csharp/Test/Integration/Examples/CloudExamplesTest.cs +++ b/csharp/Test/Integration/Examples/CloudExamplesTest.cs @@ -119,6 +119,7 @@ public void DocExample() { Console.WriteLine($"Caught TypeDB Driver Exception: {e}"); // ... + Assert.Fail("You can handle exceptions here. However, we do not expect exceptions in CI, so we fail."); } } } diff --git a/csharp/Test/Integration/Examples/CoreExamplesTest.cs b/csharp/Test/Integration/Examples/CoreExamplesTest.cs index 841745814a..8537672094 100644 --- a/csharp/Test/Integration/Examples/CoreExamplesTest.cs +++ b/csharp/Test/Integration/Examples/CoreExamplesTest.cs @@ -97,6 +97,7 @@ public void UsingsExample() { Console.WriteLine($"Caught TypeDB Driver Exception: {e}"); // ... + Assert.Fail("You can handle exceptions here. However, we do not expect exceptions in CI, so we fail."); } } @@ -158,6 +159,7 @@ public void ManualExample() { Console.WriteLine($"Caught TypeDB Driver Exception: {e}"); // ... + Assert.Fail("You can handle exceptions here. However, we do not expect exceptions in CI, so we fail."); } } @@ -239,6 +241,7 @@ public void DocExample() { Console.WriteLine($"Caught TypeDB Driver Exception: {e}"); // ... + Assert.Fail("You can handle exceptions here. However, we do not expect exceptions in CI, so we fail."); } } From 8551d4bdf00ec9bb3766ada931f9397b3756bb3f Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 25 Mar 2024 12:03:27 +0000 Subject: [PATCH 038/118] Fix merge conflicts in error messages --- cpp/lib/common/error_message.cpp | 12 ------------ java/common/exception/ErrorMessage.java | 8 ++------ 2 files changed, 2 insertions(+), 18 deletions(-) diff --git a/cpp/lib/common/error_message.cpp b/cpp/lib/common/error_message.cpp index b12e777587..c40952b5e6 100644 --- a/cpp/lib/common/error_message.cpp +++ b/cpp/lib/common/error_message.cpp @@ -30,11 +30,7 @@ namespace TypeDB { namespace DriverError { -<<<<<<< HEAD #define ERR_DRIVER(ID, MSG) ERRMSG("CCDR", "Driver Error", ID, MSG) -======= -#define ERR_DRIVER(ID, MSG) ERRMSG("DRI", "Driver Error", ID, MSG) ->>>>>>> 08a62756 (Refactor error messages codes. Update deps) DECLSPEC_DLL extern const ErrorMessage DRIVER_CLOSED = ERR_DRIVER(1, "The driver has been closed and no further operation is allowed."); DECLSPEC_DLL extern const ErrorMessage SESSION_CLOSED = ERR_DRIVER(2, "The session has been closed and no further operation is allowed."); DECLSPEC_DLL extern const ErrorMessage TRANSACTION_CLOSED = ERR_DRIVER(3, "The transaction has been closed and no further operation is allowed."); @@ -50,11 +46,7 @@ DECLSPEC_DLL extern const ErrorMessage CALLBACK_EXCEPTION = ERR_DRIVER(9, "An ex namespace ConceptError { -<<<<<<< HEAD #define ERR_CONCEPT(ID, MSG) ERRMSG("CCCO", "Concept Error", ID, MSG) -======= -#define ERR_CONCEPT(ID, MSG) ERRMSG("CON", "Concept Error", ID, MSG) ->>>>>>> 08a62756 (Refactor error messages codes. Update deps) DECLSPEC_DLL extern const ErrorMessage INVALID_CONCEPT_CASTING = ERR_CONCEPT(1, "Invalid concept conversion from '%s' to '%s'."); DECLSPEC_DLL extern const ErrorMessage MISSING_TRANSACTION = ERR_CONCEPT(2, "Transaction cannot be null."); DECLSPEC_DLL extern const ErrorMessage MISSING_IID = ERR_CONCEPT(3, "IID cannot be null or empty."); @@ -70,11 +62,7 @@ DECLSPEC_DLL extern const ErrorMessage UNRECOGNISED_ANNOTATION = ERR_CONCEPT(9, namespace QueryError { -<<<<<<< HEAD #define ERR_QUERY(ID, MSG) ERRMSG("CCQR", "Query Error", ID, MSG) -======= -#define ERR_QUERY(ID, MSG) ERRMSG("QRY", "Query Error", ID, MSG) ->>>>>>> 08a62756 (Refactor error messages codes. Update deps) DECLSPEC_DLL extern const ErrorMessage VARIABLE_DOES_NOT_EXIST = ERR_QUERY(1, "The variable '%s' does not exist."); DECLSPEC_DLL extern const ErrorMessage MISSING_QUERY = ERR_QUERY(2, "Query cannot be null or empty."); #undef ERR_QUERY diff --git a/java/common/exception/ErrorMessage.java b/java/common/exception/ErrorMessage.java index 88f60a120f..91176cd898 100644 --- a/java/common/exception/ErrorMessage.java +++ b/java/common/exception/ErrorMessage.java @@ -79,7 +79,7 @@ public static class Concept extends ErrorMessage { public static final Concept UNRECOGNISED_ANNOTATION = new Concept(9, "The annotation '%s' is not recognised."); - private static final String codePrefix = "CON"; + private static final String codePrefix = "JCO"; private static final String messagePrefix = "Concept Error"; Concept(int number, String message) { @@ -93,11 +93,7 @@ public static class Query extends ErrorMessage { public static final Query MISSING_QUERY = new Query(2, "Query cannot be null or empty."); -<<<<<<< HEAD private static final String codePrefix = "JQR"; -======= - private static final String codePrefix = "QRY"; ->>>>>>> 08a62756 (Refactor error messages codes. Update deps) private static final String messagePrefix = "Query Error"; Query(int number, String message) { @@ -115,7 +111,7 @@ public static class Internal extends ErrorMessage { public static final Internal NULL_NATIVE_VALUE = new Internal(4, "Unhandled null pointer to a native object encountered!"); - private static final String codePrefix = "INT"; + private static final String codePrefix = "JIN"; private static final String messagePrefix = "Java Internal Error"; Internal(int number, String message) { From 593c3710345fa1d47e88b824919674be96f637e9 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 25 Mar 2024 12:11:12 +0000 Subject: [PATCH 039/118] Fix typos --- cpp/README.md | 2 +- python/typedb/common/exception.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cpp/README.md b/cpp/README.md index 40f921eff5..d76a39473b 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -17,7 +17,7 @@ As usual, Add the include paths to your compile step & the library to your link A [sample `CMakeLists`](https://github.com/vaticle/typedb-driver/blob/master/cpp/test/assembly/CMakeLists.txt) is available on the TypeDB Driver repository. ## API Reference -To learn about the methods available for executing queries and retrieving their answers using Driver Java, refer to the [API Reference](https://typedb.com/docs/drivers/cpp/api-reference). +To learn about the methods available for executing queries and retrieving their answers using the C++ driver, refer to the [API Reference](https://typedb.com/docs/drivers/cpp/api-reference). ## Driver Architecture The C++ driver is a thin wrapper around the TypeDB rust driver, introducing classes for a more intuitive interface. Each C++ object holds a unique pointer to the corresponding native rust object and is the unique owner of that rust object. To ensure this, we enforce move-semantics on the C++ objects. The rust object is freed when the C++ object owning it is destructed. diff --git a/python/typedb/common/exception.py b/python/typedb/common/exception.py index ca1a92e702..dab23170ec 100644 --- a/python/typedb/common/exception.py +++ b/python/typedb/common/exception.py @@ -138,7 +138,7 @@ class InternalErrorMessage(ErrorMessage): """ def __init__(self, code: int, message: str): - super(InternalErrorMessage, self).__init__(code_prefix="INT", code_number=code, + super(InternalErrorMessage, self).__init__(code_prefix="PIN", code_number=code, message_prefix="Python Internal Error", message_body=message) From fc53872d715cc138d04f1c59fae754f7a3368123 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 25 Mar 2024 12:33:32 +0000 Subject: [PATCH 040/118] Fix copyright header --- tool/docs/csharp/DoxygenParserCsharp.kt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index 2733e8cbc2..3da1788bf6 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -3,7 +3,7 @@ * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file - * distributed with this work for nested information + * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance From c58373018f549a8ff2f0046a1f12a87363231621 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 25 Mar 2024 12:42:11 +0000 Subject: [PATCH 041/118] Add static members generation for docs --- csharp/Api/Concept/Value/IValue.cs | 2 +- csharp/docs/connection/TypeDB.adoc | 109 ++++++++++++++++++++++ csharp/docs/data/ValueTypeExtensions.adoc | 84 +++++++++++++++++ csharp/docs_structure.bzl | 1 + 4 files changed, 195 insertions(+), 1 deletion(-) create mode 100644 csharp/docs/connection/TypeDB.adoc create mode 100644 csharp/docs/data/ValueTypeExtensions.adoc diff --git a/csharp/Api/Concept/Value/IValue.cs b/csharp/Api/Concept/Value/IValue.cs index c2afcc47bb..51f59915da 100644 --- a/csharp/Api/Concept/Value/IValue.cs +++ b/csharp/Api/Concept/Value/IValue.cs @@ -196,7 +196,7 @@ public enum ValueType } /** - * Extension class with additional methods describing characteristics of ValueType enum values. // TODO: Is not generated in doxygen + * Extension class with additional methods describing characteristics of ValueType enum values. */ public static class ValueTypeExtensions { diff --git a/csharp/docs/connection/TypeDB.adoc b/csharp/docs/connection/TypeDB.adoc new file mode 100644 index 0000000000..184609b8fa --- /dev/null +++ b/csharp/docs/connection/TypeDB.adoc @@ -0,0 +1,109 @@ +[#_TypeDB] +=== TypeDB + +*Package*: `TypeDB.Driver` + +// tag::methods[] +[#_static_ITypeDBDriver_TypeDB_Driver_TypeDB_CloudDriver___string_address__TypeDBCredential_credential_] +==== CloudDriver + +[source,cs] +---- +static ITypeDBDriver CloudDriver(string address, TypeDBCredential credential) +---- + + + +Open a TypeDB Driver to a TypeDB Cloud server available at the provided address, using the provided credential. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `address` a| The address of the TypeDB server a| +a| `credential` a| The credential to connect with a| +|=== + +[caption=""] +.Returns +`static ITypeDBDriver` + +[caption=""] +.Code examples +[source,cs] +---- +TypeDB.CloudDriver(address, credential); +---- + +[#_static_ITypeDBDriver_TypeDB_Driver_TypeDB_CloudDriver___ICollection__string___addresses__TypeDBCredential_credential_] +==== CloudDriver + +[source,cs] +---- +static ITypeDBDriver CloudDriver(ICollection< string > addresses, TypeDBCredential credential) +---- + + + +Open a TypeDB Driver to TypeDB Cloud server(s) available at the provided addresses, using the provided credential. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `addresses` a| The address(es) of the TypeDB server(s) a| +a| `credential` a| The credential to connect with a| +|=== + +[caption=""] +.Returns +`static ITypeDBDriver` + +[caption=""] +.Code examples +[source,cs] +---- +TypeDB.CloudDriver(addresses, credential); +---- + +[#_static_ITypeDBDriver_TypeDB_Driver_TypeDB_CoreDriver___string_address_] +==== CoreDriver + +[source,cs] +---- +static ITypeDBDriver CoreDriver(string address) +---- + + + +Open a TypeDB Driver to a TypeDB Core server available at the provided address. + + +[caption=""] +.Input parameters +[cols="~,~,~"] +[options="header"] +|=== +|Name |Description |Type +a| `address` a| The address of the TypeDB server a| +|=== + +[caption=""] +.Returns +`static ITypeDBDriver` + +[caption=""] +.Code examples +[source,cs] +---- +TypeDB.CoreDriver(address); +---- + +// end::methods[] + diff --git a/csharp/docs/data/ValueTypeExtensions.adoc b/csharp/docs/data/ValueTypeExtensions.adoc new file mode 100644 index 0000000000..56a050af17 --- /dev/null +++ b/csharp/docs/data/ValueTypeExtensions.adoc @@ -0,0 +1,84 @@ +[#_ValueTypeExtensions] +=== ValueTypeExtensions + +*Package*: `TypeDB.Driver.Api` + + + +Extension class with additional methods describing characteristics of ``ValueType`` enum values. + +// tag::methods[] +[#_static_System_Type_TypeDB_Driver_Api_ValueTypeExtensions_GetValueClass___this_IValueValueType_valueType_] +==== GetValueClass + +[source,cs] +---- +static System.Type GetValueClass(this IValue::ValueType valueType) +---- + + + +Returns a ``System.Type`` equivalent of this value concept for this programming language. + + +[caption=""] +.Returns +`static System.Type` + +[caption=""] +.Code examples +[source,cs] +---- +valueType.GetValueClass(); +---- + +[#_static_bool_TypeDB_Driver_Api_ValueTypeExtensions_IsKeyable___this_ValueType_valueType_] +==== IsKeyable + +[source,cs] +---- +static bool IsKeyable(this ValueType valueType) +---- + + + +Returns ``true`` if this value concept can be used as a key via the @key annotation. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`static bool` + +[caption=""] +.Code examples +[source,cs] +---- +valueType.IsKeyable(); +---- + +[#_static_bool_TypeDB_Driver_Api_ValueTypeExtensions_IsWritable___this_IValueValueType_valueType_] +==== IsWritable + +[source,cs] +---- +static bool IsWritable(this IValue::ValueType valueType) +---- + + + +Returns ``true`` if this value concept can be written to a database. Otherwise, returns ``false``. + + +[caption=""] +.Returns +`static bool` + +[caption=""] +.Code examples +[source,cs] +---- +valueType.IsWritable(); +---- + +// end::methods[] + diff --git a/csharp/docs_structure.bzl b/csharp/docs_structure.bzl index 20a4dcdc8c..ba533773c5 100644 --- a/csharp/docs_structure.bzl +++ b/csharp/docs_structure.bzl @@ -58,6 +58,7 @@ dir_mapping = { "IAttribute.adoc": "data", "IValue.adoc": "data", "ValueType.adoc": "data", + "ValueTypeExtensions.adoc": "data", "IThing.adoc": "data", "ITypeDBSession.adoc": "session", "SessionType.adoc": "session", From 79ca5f848781f074ec6cafc71664ea01931abbd9 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 25 Mar 2024 12:47:08 +0000 Subject: [PATCH 042/118] Update deps ref for static members generation --- dependencies/vaticle/repositories.bzl | 5 ----- 1 file changed, 5 deletions(-) diff --git a/dependencies/vaticle/repositories.bzl b/dependencies/vaticle/repositories.bzl index d633c40f02..9e2fde1dc1 100644 --- a/dependencies/vaticle/repositories.bzl +++ b/dependencies/vaticle/repositories.bzl @@ -18,11 +18,6 @@ load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository") def vaticle_dependencies(): -# git_repository( -# name = "vaticle_dependencies", -# remote = "https://github.com/vaticle/dependencies", -# commit = "7518f8adaf5714512a8af96128b15cca7dedd475", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies -# ) git_repository( name = "vaticle_dependencies", remote = "https://github.com/vaticle/dependencies", From 62500cb79d19ecfe547d56fc61348d9f5e4d5247 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 25 Mar 2024 14:00:28 +0000 Subject: [PATCH 043/118] Fix c parser bug with old files --- tool/docs/c/DoxygenParserC.kt | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tool/docs/c/DoxygenParserC.kt b/tool/docs/c/DoxygenParserC.kt index 26c41bff1c..d50b10ece4 100644 --- a/tool/docs/c/DoxygenParserC.kt +++ b/tool/docs/c/DoxygenParserC.kt @@ -63,6 +63,8 @@ class DoxygenParserC : Callable { @CommandLine.Option(names = ["--forcefile", "-f"], required = true) private lateinit var unnormalisedFilenameOverrides: MutableMap + private var recreatedFiles: MutableSet = mutableSetOf() + @Override override fun call() { val inputDirectoryName = inputDirectoryNames[0] @@ -138,7 +140,13 @@ class DoxygenParserC : Callable { if (!fileDir.toFile().exists()) { Files.createDirectory(fileDir) } + val outputFile = fileDir.resolve(filename).toFile() + if (!recreatedFiles.contains(outputFile)) { + recreatedFiles.add(outputFile) + outputFile.delete() + } + outputFile.createNewFile() return outputFile } From 5647f1f25311110071dd6c51819e19e9a0037538 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 25 Mar 2024 14:20:44 +0000 Subject: [PATCH 044/118] Add paket.lock file to git: https://fsprojects.github.io/Paket/faq.html\#Why-should-I-commit-the-lock-file --- .gitignore | 1 - csharp/nuget/paket.lock | 68 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+), 1 deletion(-) create mode 100644 csharp/nuget/paket.lock diff --git a/.gitignore b/.gitignore index b18fc97ccf..4257197f29 100644 --- a/.gitignore +++ b/.gitignore @@ -97,4 +97,3 @@ Cargo.toml # Temporary paket files for C# paket-files/ -paket.lock diff --git a/csharp/nuget/paket.lock b/csharp/nuget/paket.lock new file mode 100644 index 0000000000..a185e9f649 --- /dev/null +++ b/csharp/nuget/paket.lock @@ -0,0 +1,68 @@ + + +GROUP csharp_deps +STORAGE: NONE +RESTRICTION: == net6.0 +NUGET + remote: https://api.nuget.org/v3/index.json + Gherkin (5.0) + NETStandard.Library (>= 1.6.1) + Newtonsoft.Json (>= 9.0.1) + Microsoft.NETCore.Platforms (7.0.4) + Microsoft.NETCore.Targets (5.0) + NETStandard.Library (2.0.3) + Microsoft.NETCore.Platforms (>= 1.1) + Newtonsoft.Json (13.0.3) + System.IO (4.3) + Microsoft.NETCore.Platforms (>= 1.1) + Microsoft.NETCore.Targets (>= 1.1) + System.Runtime (>= 4.3) + System.Text.Encoding (>= 4.3) + System.Threading.Tasks (>= 4.3) + System.Reflection (4.3) + Microsoft.NETCore.Platforms (>= 1.1) + Microsoft.NETCore.Targets (>= 1.1) + System.IO (>= 4.3) + System.Reflection.Primitives (>= 4.3) + System.Runtime (>= 4.3) + System.Reflection.Primitives (4.3) + Microsoft.NETCore.Platforms (>= 1.1) + Microsoft.NETCore.Targets (>= 1.1) + System.Runtime (>= 4.3) + System.Runtime (4.3.1) + Microsoft.NETCore.Platforms (>= 1.1.1) + Microsoft.NETCore.Targets (>= 1.1.3) + System.Runtime.Loader (4.3) + System.IO (>= 4.3) + System.Reflection (>= 4.3) + System.Runtime (>= 4.3) + System.Text.Encoding (4.3) + Microsoft.NETCore.Platforms (>= 1.1) + Microsoft.NETCore.Targets (>= 1.1) + System.Runtime (>= 4.3) + System.Threading.Tasks (4.3) + Microsoft.NETCore.Platforms (>= 1.1) + Microsoft.NETCore.Targets (>= 1.1) + System.Runtime (>= 4.3) + xunit (2.7) + xunit.analyzers (>= 1.11) + xunit.assert (>= 2.7) + xunit.core (2.7) + xunit.abstractions (2.0.3) + xunit.analyzers (1.11) + xunit.assert (2.7) + xunit.core (2.7) + xunit.extensibility.core (2.7) + xunit.extensibility.execution (2.7) + xunit.extensibility.core (2.7) + xunit.abstractions (>= 2.0.3) + xunit.extensibility.execution (2.7) + xunit.extensibility.core (2.7) + XUnit.Gherkin.Quick (4.5) + Gherkin (>= 5.0) + NETStandard.Library (>= 1.6.1) + xunit (>= 2.3.1) + xunit.runner.utility (2.6.4) + NETStandard.Library (>= 1.6) + System.Runtime.Loader (>= 4.0) + xunit.abstractions (>= 2.0.3) From 5b3f418b9306102edef63f688ae2f6c96213c531 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 25 Mar 2024 14:43:49 +0000 Subject: [PATCH 045/118] Fix checkstyle by ignoring paket.lock --- csharp/nuget/BUILD | 1 + 1 file changed, 1 insertion(+) diff --git a/csharp/nuget/BUILD b/csharp/nuget/BUILD index 533884c7d2..6f4de1bdeb 100644 --- a/csharp/nuget/BUILD +++ b/csharp/nuget/BUILD @@ -24,6 +24,7 @@ checkstyle_test( exclude = glob([ "paket.csharp_deps.bzl", "paket.csharp_deps_extension.bzl", + "paket.lock", ]), license_type = "apache-header", ) From 93dd34e93b036f17e67f3f1465c11da8ccf87f59 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 26 Mar 2024 09:42:39 +0000 Subject: [PATCH 046/118] Change output dlls names to align with namespaces --- csharp/Api/BUILD | 1 + csharp/BUILD | 1 + csharp/Common/BUILD | 1 + csharp/Concept/BUILD | 1 + csharp/Connection/BUILD | 1 + csharp/Logic/BUILD | 1 + csharp/Query/BUILD | 1 + csharp/User/BUILD | 1 + csharp/rules.bzl | 4 ++-- 9 files changed, 10 insertions(+), 2 deletions(-) diff --git a/csharp/Api/BUILD b/csharp/Api/BUILD index 81344993e6..f91417eca1 100644 --- a/csharp/Api/BUILD +++ b/csharp/Api/BUILD @@ -31,6 +31,7 @@ csharp_library( "//csharp:typedb_driver_pinvoke", "@paket.csharp_deps//newtonsoft.json", ], + out = "TypeDB.Driver.Api", runtime_identifier = "any", nullable = nullable_context, target_frameworks = target_frameworks, diff --git a/csharp/BUILD b/csharp/BUILD index 2926106062..9a3feb2834 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -55,6 +55,7 @@ csharp_library( "//csharp/Connection:connection", "//csharp:typedb_driver_pinvoke", ], + out = "TypeDB.Driver", visibility = ["//visibility:public"], target_frameworks = target_frameworks, targeting_packs = targeting_packs, diff --git a/csharp/Common/BUILD b/csharp/Common/BUILD index f858e726e6..553c514eed 100644 --- a/csharp/Common/BUILD +++ b/csharp/Common/BUILD @@ -26,6 +26,7 @@ csharp_library( name = "common", srcs = glob(["*.cs", "*/*.cs"]), deps = ["//csharp:typedb_driver_pinvoke"], + out = "TypeDB.Driver.Common", runtime_identifier = "any", nullable = nullable_context, target_frameworks = target_frameworks, diff --git a/csharp/Concept/BUILD b/csharp/Concept/BUILD index 0e8335e100..036cc4bd53 100644 --- a/csharp/Concept/BUILD +++ b/csharp/Concept/BUILD @@ -30,6 +30,7 @@ csharp_library( "//csharp/Common:common", "//csharp:typedb_driver_pinvoke", ], + out = "TypeDB.Driver.Concept", nullable = nullable_context, target_frameworks = target_frameworks, targeting_packs = targeting_packs, diff --git a/csharp/Connection/BUILD b/csharp/Connection/BUILD index 86d2ad60d2..645dc7f229 100644 --- a/csharp/Connection/BUILD +++ b/csharp/Connection/BUILD @@ -35,6 +35,7 @@ csharp_library( "//csharp/User:user", "//csharp:typedb_driver_pinvoke", ], + out = "TypeDB.Driver.Connection", nullable = nullable_context, target_frameworks = target_frameworks, targeting_packs = targeting_packs, diff --git a/csharp/Logic/BUILD b/csharp/Logic/BUILD index 6215769e46..4d6a584722 100644 --- a/csharp/Logic/BUILD +++ b/csharp/Logic/BUILD @@ -31,6 +31,7 @@ csharp_library( "//csharp/Concept:concept", "//csharp:typedb_driver_pinvoke", ], + out = "TypeDB.Driver.Logic", nullable = nullable_context, target_frameworks = target_frameworks, targeting_packs = targeting_packs, diff --git a/csharp/Query/BUILD b/csharp/Query/BUILD index fc787451d3..e20303d4d9 100644 --- a/csharp/Query/BUILD +++ b/csharp/Query/BUILD @@ -33,6 +33,7 @@ csharp_library( "//csharp:typedb_driver_pinvoke", "@paket.csharp_deps//newtonsoft.json", ], + out = "TypeDB.Driver.Query", nullable = nullable_context, target_frameworks = target_frameworks, targeting_packs = targeting_packs, diff --git a/csharp/User/BUILD b/csharp/User/BUILD index 451e6a6151..0633c46f7c 100644 --- a/csharp/User/BUILD +++ b/csharp/User/BUILD @@ -30,6 +30,7 @@ csharp_library( "//csharp/Common:common", "//csharp:typedb_driver_pinvoke", ], + out = "TypeDB.Driver.User", nullable = nullable_context, target_frameworks = target_frameworks, targeting_packs = targeting_packs, diff --git a/csharp/rules.bzl b/csharp/rules.bzl index df586bc531..393282e792 100644 --- a/csharp/rules.bzl +++ b/csharp/rules.bzl @@ -18,10 +18,10 @@ load("@vaticle_dependencies//builder/swig:csharp.bzl", "swig_csharp") -def swig_native_csharp_library(name, nullable_context, target_frameworks, targeting_packs, visibility, tags=[], **kwargs): +def swig_native_csharp_library(name, namespace, nullable_context, target_frameworks, targeting_packs, visibility, tags=[], **kwargs): swig_csharp( name = "__" + name, - shared_lib_name = name, + namespace = namespace, nullable_context = nullable_context, target_frameworks = target_frameworks, targeting_packs = targeting_packs, From c647b094b555cfa5a4cd7cb3738bc506c28d9529 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 26 Mar 2024 11:06:26 +0000 Subject: [PATCH 047/118] Fix argument type parsing error for CS, CPP and C. Not pushing CS for now. --- cpp/docs/answer/Explainables.adoc | 8 +- cpp/docs/answer/Explanation.adoc | 2 +- cpp/docs/concept/ConceptManager.adoc | 20 ++--- cpp/docs/connection/Credential.adoc | 6 +- cpp/docs/connection/Driver.adoc | 4 +- cpp/docs/connection/User.adoc | 4 +- cpp/docs/connection/UserManager.adoc | 14 +-- cpp/docs/data/Attribute.adoc | 6 +- cpp/docs/data/Relation.adoc | 20 ++--- cpp/docs/data/Thing.adoc | 22 ++--- cpp/docs/logic/LogicManager.adoc | 8 +- cpp/docs/logic/Rule.adoc | 8 +- cpp/docs/schema/AttributeType.adoc | 74 ++++++++-------- cpp/docs/schema/EntityType.adoc | 10 +-- cpp/docs/schema/RelationType.adoc | 32 +++---- cpp/docs/schema/RoleType.adoc | 22 ++--- cpp/docs/schema/ThingType.adoc | 54 ++++++------ cpp/docs/schema/Type.adoc | 12 +-- cpp/docs/session/Options.adoc | 14 +-- cpp/docs/session/Session.adoc | 2 +- cpp/docs/transaction/QueryManager.adoc | 22 ++--- csharp/Api/Concept/Type/IThingType.cs | 4 +- .../Common/Exception/TypeDBDriverException.cs | 8 +- csharp/Common/Label.cs | 4 +- csharp/Common/Promise/Promise.cs | 8 +- csharp/docs/answer/IConceptMap.adoc | 2 +- csharp/docs/answer/IExplainables.adoc | 8 +- csharp/docs/answer/IExplanation.adoc | 2 +- csharp/docs/answer/Promise__T__.adoc | 8 +- csharp/docs/concept/IConceptManager.adoc | 20 ++--- csharp/docs/connection/IDatabaseManager.adoc | 6 +- csharp/docs/connection/ITypeDBDriver.adoc | 6 +- csharp/docs/connection/IUser.adoc | 4 +- csharp/docs/connection/IUserManager.adoc | 14 +-- csharp/docs/connection/TypeDB.adoc | 10 +-- csharp/docs/connection/TypeDBCredential.adoc | 12 +-- csharp/docs/data/IAttribute.adoc | 6 +- csharp/docs/data/IRelation.adoc | 20 ++--- csharp/docs/data/IThing.adoc | 26 +++--- csharp/docs/errors/TypeDBDriverException.adoc | 64 -------------- csharp/docs/logic/ILogicManager.adoc | 8 +- csharp/docs/logic/IRule.adoc | 8 +- csharp/docs/schema/Annotation.adoc | 18 +--- csharp/docs/schema/IAttributeType.adoc | 86 +++++++++---------- csharp/docs/schema/IEntityType.adoc | 6 +- csharp/docs/schema/IRelationType.adoc | 28 +++--- csharp/docs/schema/IRoleType.adoc | 14 +-- csharp/docs/schema/IThingType.adoc | 52 +++++------ csharp/docs/schema/IType.adoc | 16 ++-- csharp/docs/schema/Label.adoc | 24 +----- csharp/docs/session/ITypeDBSession.adoc | 8 +- csharp/docs/session/TypeDBOptions.adoc | 20 ++--- csharp/docs/transaction/IQueryManager.adoc | 44 +++++----- .../docs/transaction/ITypeDBTransaction.adoc | 2 +- tool/docs/c/DoxygenParserC.kt | 2 +- tool/docs/cpp/DoxygenParserCpp.kt | 2 +- 56 files changed, 418 insertions(+), 516 deletions(-) diff --git a/cpp/docs/answer/Explainables.adoc b/cpp/docs/answer/Explainables.adoc index cfeb76e943..c10fbf4c0f 100644 --- a/cpp/docs/answer/Explainables.adoc +++ b/cpp/docs/answer/Explainables.adoc @@ -27,7 +27,7 @@ Retrieves the explainable attribute with the given variable name. [options="header"] |=== |Name |Description |Type -a| `variable` a| The string representation of a variable a| +a| `variable` a| The string representation of a variable a| `std::string&` |=== [caption=""] @@ -84,8 +84,8 @@ Retrieves the explainable attribute ownership with the pair of (owner, attribute [options="header"] |=== |Name |Description |Type -a| `owner` a| The string representation of the owner variable a| -a| `attribute` a| The string representation of the attribute variable a| +a| `owner` a| The string representation of the owner variable a| `std::string&` +a| `attribute` a| The string representation of the attribute variable a| `std::string&` |=== [caption=""] @@ -142,7 +142,7 @@ Retrieves the explainable relation with the given variable name. [options="header"] |=== |Name |Description |Type -a| `variable` a| The string representation of a variable a| +a| `variable` a| The string representation of a variable a| `std::string&` |=== [caption=""] diff --git a/cpp/docs/answer/Explanation.adoc b/cpp/docs/answer/Explanation.adoc index 1003b40107..8f88f9e9f8 100644 --- a/cpp/docs/answer/Explanation.adoc +++ b/cpp/docs/answer/Explanation.adoc @@ -77,7 +77,7 @@ Retrieves the rule variables corresponding to the query variable var for this `` [options="header"] |=== |Name |Description |Type -a| `var` a| The query variable to map to rule variables. a| +a| `var` a| The query variable to map to rule variables. a| `const std::string&` |=== [caption=""] diff --git a/cpp/docs/concept/ConceptManager.adoc b/cpp/docs/concept/ConceptManager.adoc index a376e97b5c..6cf2f6caa9 100644 --- a/cpp/docs/concept/ConceptManager.adoc +++ b/cpp/docs/concept/ConceptManager.adoc @@ -27,7 +27,7 @@ Retrieves an ``Attribute`` by its iid. [options="header"] |=== |Name |Description |Type -a| `iid` a| The iid of the ``Attribute`` to retrieve a| +a| `iid` a| The iid of the ``Attribute`` to retrieve a| `const std::string&` |=== [caption=""] @@ -60,7 +60,7 @@ Retrieves an ``AttributeType`` by its label. [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``AttributeType`` to retrieve a| +a| `label` a| The label of the ``AttributeType`` to retrieve a| `const std::string&` |=== [caption=""] @@ -93,7 +93,7 @@ Retrieves an ``Entity`` by its iid. [options="header"] |=== |Name |Description |Type -a| `iid` a| The iid of the ``Entity`` to retrieve a| +a| `iid` a| The iid of the ``Entity`` to retrieve a| `const std::string&` |=== [caption=""] @@ -126,7 +126,7 @@ Retrieves an ``EntityType`` by its label. [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``EntityType`` to retrieve a| +a| `label` a| The label of the ``EntityType`` to retrieve a| `const std::string&` |=== [caption=""] @@ -159,7 +159,7 @@ Retrieves a ``Relation`` by its iid. [options="header"] |=== |Name |Description |Type -a| `iid` a| The iid of the ``Relation`` to retrieve a| +a| `iid` a| The iid of the ``Relation`` to retrieve a| `const std::string&` |=== [caption=""] @@ -192,7 +192,7 @@ Retrieves a ``RelationType`` by its label. [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``RelationType`` to retrieve a| +a| `label` a| The label of the ``RelationType`` to retrieve a| `const std::string&` |=== [caption=""] @@ -321,8 +321,8 @@ Creates a new ``AttributeType`` if none exists with the given label, or retrieve [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``AttributeType`` to create or retrieve a| -a| `valueType` a| The value type of the ``AttributeType`` to create a| +a| `label` a| The label of the ``AttributeType`` to create or retrieve a| `const std::string&` +a| `valueType` a| The value type of the ``AttributeType`` to create a| `ValueType` |=== [caption=""] @@ -355,7 +355,7 @@ Creates a new ``EntityType`` if none exists with the given label, otherwise retr [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``EntityType`` to create or retrieve a| +a| `label` a| The label of the ``EntityType`` to create or retrieve a| `const std::string&` |=== [caption=""] @@ -388,7 +388,7 @@ Creates a new ``RelationType`` if none exists with the given label, otherwise re [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``RelationType`` to create or retrieve a| +a| `label` a| The label of the ``RelationType`` to create or retrieve a| `const std::string&` |=== [caption=""] diff --git a/cpp/docs/connection/Credential.adoc b/cpp/docs/connection/Credential.adoc index eea89af7da..d7940da2b7 100644 --- a/cpp/docs/connection/Credential.adoc +++ b/cpp/docs/connection/Credential.adoc @@ -39,9 +39,9 @@ TypeDB::Credential::Credential(const std::string& username, const std::string& p [options="header"] |=== |Name |Description |Type -a| `username` a| The name of the user to connect as a| -a| `password` a| The password for the user a| -a| `withTLS` a| Specify whether the connection to TypeDB Cloud must be done over TLS a| +a| `username` a| The name of the user to connect as a| `const std::string&` +a| `password` a| The password for the user a| `const std::string&` +a| `withTLS` a| Specify whether the connection to TypeDB Cloud must be done over TLS a| `bool` a| `customRootCAPath` a| Optional, Path to a custom CA certificate to use for authenticating server certificates. a| |=== diff --git a/cpp/docs/connection/Driver.adoc b/cpp/docs/connection/Driver.adoc index 5ba2e9e778..17beaf8661 100644 --- a/cpp/docs/connection/Driver.adoc +++ b/cpp/docs/connection/Driver.adoc @@ -64,7 +64,7 @@ Open a TypeDB Driver to TypeDB Cloud server(s) available at the provided address |=== |Name |Description |Type a| `addresses` a| The address(es) of the TypeDB server(s) a| -a| `credential` a| The Credential to connect with a| +a| `credential` a| The Credential to connect with a| `const Credential&` |=== [caption=""] @@ -178,7 +178,7 @@ Opens a communication tunnel (session) to the given database on the running Type [options="header"] |=== |Name |Description |Type -a| `database` a| The name of the database with which the session connects a| +a| `database` a| The name of the database with which the session connects a| `const std::string&` a| `type` a| The type of session to be created (DATA or SCHEMA) a| a| `options` a| ``TypeDBOptions`` for the session a| |=== diff --git a/cpp/docs/connection/User.adoc b/cpp/docs/connection/User.adoc index 2e09af5a85..417f795a76 100644 --- a/cpp/docs/connection/User.adoc +++ b/cpp/docs/connection/User.adoc @@ -43,8 +43,8 @@ Updates the password for this user. [options="header"] |=== |Name |Description |Type -a| `passwordOld` a| The current password of this user a| -a| `passwordNew` a| The new password a| +a| `passwordOld` a| The current password of this user a| `const std::string&` +a| `passwordNew` a| The new password a| `const std::string&` |=== [caption=""] diff --git a/cpp/docs/connection/UserManager.adoc b/cpp/docs/connection/UserManager.adoc index 9fae0e8d56..6668deb28b 100644 --- a/cpp/docs/connection/UserManager.adoc +++ b/cpp/docs/connection/UserManager.adoc @@ -51,7 +51,7 @@ Checks if a user with the given name exists. [options="header"] |=== |Name |Description |Type -a| `username` a| The user name to be checked a| +a| `username` a| The user name to be checked a| `const std::string&` |=== [caption=""] @@ -84,8 +84,8 @@ Creates a user with the given name & password. [options="header"] |=== |Name |Description |Type -a| `username` a| The name of the user to be created a| -a| `password` a| The password of the user to be created a| +a| `username` a| The name of the user to be created a| `const std::string&` +a| `password` a| The password of the user to be created a| `const std::string&` |=== [caption=""] @@ -118,7 +118,7 @@ Deletes a user with the given name. [options="header"] |=== |Name |Description |Type -a| `username` a| The name of the user to be deleted a| +a| `username` a| The name of the user to be deleted a| `const std::string&` |=== [caption=""] @@ -151,7 +151,7 @@ Retrieves a user with the given name. [options="header"] |=== |Name |Description |Type -a| `username` a| The name of the user to retrieve a| +a| `username` a| The name of the user to retrieve a| `const std::string&` |=== [caption=""] @@ -184,8 +184,8 @@ Sets a new password for a user. This operation can only be performed by administ [options="header"] |=== |Name |Description |Type -a| `username` a| The name of the user to set the password of a| -a| `password` a| The new password a| +a| `username` a| The name of the user to set the password of a| `const std::string&` +a| `password` a| The new password a| `const std::string&` |=== [caption=""] diff --git a/cpp/docs/data/Attribute.adoc b/cpp/docs/data/Attribute.adoc index c3fb746c61..f030c6325d 100644 --- a/cpp/docs/data/Attribute.adoc +++ b/cpp/docs/data/Attribute.adoc @@ -34,7 +34,7 @@ Retrieves the instances that own this ``Attribute``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -67,8 +67,8 @@ Retrieves the instances that own this ``Attribute``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `ownerType` a| Filter results for only owners of the given type a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `ownerType` a| Filter results for only owners of the given type a| `const ThingType*` |=== [caption=""] diff --git a/cpp/docs/data/Relation.adoc b/cpp/docs/data/Relation.adoc index 94d45c7c9b..54d57e5997 100644 --- a/cpp/docs/data/Relation.adoc +++ b/cpp/docs/data/Relation.adoc @@ -34,9 +34,9 @@ Adds a new role player to play the given role in this ``Relation``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to be played by the ``player`` a| -a| `player` a| The thing to play the role a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `roleType` a| The role to be played by the ``player`` a| `RoleType*` +a| `player` a| The thing to play the role a| `Thing*` |=== [caption=""] @@ -69,7 +69,7 @@ Retrieves a mapping of all instances involved in the ``Relation`` and the role e [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -102,8 +102,8 @@ Retrieves all role players of this ``Relation``, optionally filtered by given ro [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleTypes` a| 0 or more role types a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `roleTypes` a| 0 or more role types a| `const std::vector< std::unique_ptr< RoleType > >&` |=== [caption=""] @@ -152,7 +152,7 @@ Retrieves all role types currently played in this ``Relation``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -209,9 +209,9 @@ Removes the association of the given instance that plays the given role in this [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to no longer be played by the thing in this ``Relation`` a| -a| `player` a| The instance to no longer play the role in this ``Relation`` a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `roleType` a| The role to no longer be played by the thing in this ``Relation`` a| `RoleType*` +a| `player` a| The instance to no longer play the role in this ``Relation`` a| `Thing*` |=== [caption=""] diff --git a/cpp/docs/data/Thing.adoc b/cpp/docs/data/Thing.adoc index 6dae765dd9..e616895e11 100644 --- a/cpp/docs/data/Thing.adoc +++ b/cpp/docs/data/Thing.adoc @@ -31,7 +31,7 @@ Deletes this ``Thing``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -64,7 +64,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns, filtered by ``Annotation` [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `annotations` a| Only retrieve attributes with all given ``Annotation``s a| |=== @@ -115,8 +115,8 @@ Retrieves the ``Attribute``s of the specified ``AttributeType``s that this ``Thi [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeTypes` a| The ``AttributeType``s to filter the attributes by a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `attributeTypes` a| The ``AttributeType``s to filter the attributes by a| `const std::vector< std::unique_ptr< AttributeType > >&` |=== [caption=""] @@ -205,7 +205,7 @@ Retrieves the roles that this ``Thing`` is currently playing. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -238,7 +238,7 @@ Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `roleTypes` a| The array of roles to filter the relations by. a| |=== @@ -313,7 +313,7 @@ Checks if this ``Thing`` is deleted. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -370,8 +370,8 @@ Assigns an ``Attribute`` to be owned by this ``Thing``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attribute` a| The ``Attribute`` to be owned by this ``Thing``. a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `attribute` a| The ``Attribute`` to be owned by this ``Thing``. a| `Attribute*` |=== [caption=""] @@ -404,8 +404,8 @@ Unassigns an ``Attribute`` from this ``Thing``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attribute` a| The ``Attribute`` to be disowned from this ``Thing``. a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `attribute` a| The ``Attribute`` to be disowned from this ``Thing``. a| `Attribute*` |=== [caption=""] diff --git a/cpp/docs/logic/LogicManager.adoc b/cpp/docs/logic/LogicManager.adoc index 87fee9ed03..f1f7729838 100644 --- a/cpp/docs/logic/LogicManager.adoc +++ b/cpp/docs/logic/LogicManager.adoc @@ -27,7 +27,7 @@ Retrieves the Rule that has the given label. [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the Rule to create or retrieve a| +a| `label` a| The label of the Rule to create or retrieve a| `const std::string&` |=== [caption=""] @@ -84,9 +84,9 @@ Creates a new Rule if none exists with the given label, or replaces the existing [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the Rule to create or replace a| -a| `when` a| The when body of the rule to create a| -a| `then` a| The then body of the rule to create a| +a| `label` a| The label of the Rule to create or replace a| `const std::string&` +a| `when` a| The when body of the rule to create a| `const std::string&` +a| `then` a| The then body of the rule to create a| `const std::string&` |=== [caption=""] diff --git a/cpp/docs/logic/Rule.adoc b/cpp/docs/logic/Rule.adoc index dbd2bb1b8f..aefcdf7cb6 100644 --- a/cpp/docs/logic/Rule.adoc +++ b/cpp/docs/logic/Rule.adoc @@ -29,7 +29,7 @@ Deletes this rule. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current ``Transaction`` a| +a| `transaction` a| The current ``Transaction`` a| `Transaction&` |=== [caption=""] @@ -62,7 +62,7 @@ Check if this rule has been deleted. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current ``Transaction`` a| +a| `transaction` a| The current ``Transaction`` a| `Transaction&` |=== [caption=""] @@ -111,8 +111,8 @@ Renames the label of the rule. The new label must remain unique. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current ``Transaction`` a| -a| `label` a| The new label to be given to the rule a| +a| `transaction` a| The current ``Transaction`` a| `Transaction&` +a| `label` a| The new label to be given to the rule a| `const std::string&` |=== [caption=""] diff --git a/cpp/docs/schema/AttributeType.adoc b/cpp/docs/schema/AttributeType.adoc index 23abfd4c77..7f50021d43 100644 --- a/cpp/docs/schema/AttributeType.adoc +++ b/cpp/docs/schema/AttributeType.adoc @@ -39,8 +39,8 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| ``Attribute``’s value a| `Value*` |=== [caption=""] @@ -73,8 +73,8 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| ``Attribute``’s value a| `const std::string&` |=== [caption=""] @@ -107,8 +107,8 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| ``Attribute``’s value a| `int64_t` |=== [caption=""] @@ -141,8 +141,8 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| ``Attribute``’s value a| `double` |=== [caption=""] @@ -175,8 +175,8 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| ``Attribute``’s value a| `bool` |=== [caption=""] @@ -209,8 +209,8 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| ``Attribute``’s value a| `DateTime` |=== [caption=""] @@ -244,7 +244,7 @@ Retrieves all direct and indirect ``Attributes`` that are instances of this ``At |=== |Name |Description |Type a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtypes, ``Transitivity::EXPLICIT`` for direct subtypes only a| -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -282,7 +282,7 @@ Retrieve all ``Things`` that own an attribute of this ``AttributeType`` directly [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtypes, ``Transitivity::EXPLICIT`` for direct subtypes only a| |=== @@ -316,8 +316,8 @@ Variant of <<#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Trans [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``AttributeType`` with all given ``Annotation``s a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``AttributeType`` with all given ``Annotation``s a| `const std::vector< Annotation >&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtypes, ``Transitivity::EXPLICIT`` for direct subtypes only a| |=== @@ -373,7 +373,7 @@ Retrieves the regular expression that is defined for this ``AttributeType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -406,7 +406,7 @@ Retrieves all direct and indirect subtypes of this ``AttributeType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtypes, ``Transitivity::EXPLICIT`` for direct subtypes only a| |=== @@ -441,8 +441,8 @@ Retrieves all direct and indirect (or direct only) subtypes of this ``AttributeT [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `valueType` a| ``Value.Type`` for retrieving subtypes a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `valueType` a| ``Value.Type`` for retrieving subtypes a| `ValueType` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtypes, ``Transitivity::EXPLICIT`` for direct subtypes only a| |=== @@ -500,8 +500,8 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given value [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| New ``Attribute``’s value a| `Value*` |=== [caption=""] @@ -534,8 +534,8 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given ``Str [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| New ``Attribute``’s value a| `const std::string&` |=== [caption=""] @@ -568,8 +568,8 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given ``lon [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| New ``Attribute``’s value a| `int64_t` |=== [caption=""] @@ -602,8 +602,8 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given ``dou [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| New ``Attribute``’s value a| `double` |=== [caption=""] @@ -636,8 +636,8 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given ``boo [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| New ``Attribute``’s value a| `bool` |=== [caption=""] @@ -670,8 +670,8 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given ``Dat [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``Attribute``’s value a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `value` a| New ``Attribute``’s value a| `DateTime` |=== [caption=""] @@ -706,8 +706,8 @@ Can only be applied for ``AttributeType``s with a ``string`` value type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `regex` a| Regular expression a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `regex` a| Regular expression a| `const std::string&` |=== [caption=""] @@ -740,8 +740,8 @@ Sets the supplied ``AttributeType`` as the supertype of the current ``AttributeT [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``AttributeType`` to set as the supertype of this ``AttributeType`` a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `attributeType` a| The ``AttributeType`` to set as the supertype of this ``AttributeType`` a| `AttributeType*` |=== [caption=""] @@ -774,7 +774,7 @@ Removes the regular expression that is defined for this ``AttributeType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] diff --git a/cpp/docs/schema/EntityType.adoc b/cpp/docs/schema/EntityType.adoc index 83978b4c62..b19d4b2faa 100644 --- a/cpp/docs/schema/EntityType.adoc +++ b/cpp/docs/schema/EntityType.adoc @@ -33,7 +33,7 @@ Creates and returns a new instance of this ``EntityType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -66,7 +66,7 @@ Retrieves ``Entity`` objects that are instances of this exact ``EntityType`` OR [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::EXPLICIT`` for direct instances only, ``Transitivity::TRANSITIVE`` to include subtypes a| |=== @@ -100,7 +100,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``EntityType` [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtypes, ``Transitivity::EXPLICIT`` for direct subtypes only a| |=== @@ -134,8 +134,8 @@ Sets the supplied ``EntityType`` as the supertype of the current ``EntityType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `superEntityType` a| The ``EntityType`` to set as the supertype of this ``EntityType`` a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `superEntityType` a| The ``EntityType`` to set as the supertype of this ``EntityType`` a| `EntityType*` |=== [caption=""] diff --git a/cpp/docs/schema/RelationType.adoc b/cpp/docs/schema/RelationType.adoc index 6536988352..94ed3b5d6a 100644 --- a/cpp/docs/schema/RelationType.adoc +++ b/cpp/docs/schema/RelationType.adoc @@ -35,7 +35,7 @@ Creates and returns an instance of this ``RelationType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -68,7 +68,7 @@ Retrieves ``Relation``s that are instances of this exact ``RelationType``, OR th [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect instances, ``Transitivity::EXPLICIT`` for direct relates only a| |=== @@ -102,7 +102,7 @@ Retrieves roles that this ``RelationType`` relates to directly or via inheritanc [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and inherited relates, ``Transitivity::EXPLICIT`` for direct relates only a| |=== @@ -136,8 +136,8 @@ Retrieves the role with the specified label that this ``RelationType`` relates t [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| Label of the role we wish to retrieve a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `roleLabel` a| Label of the role we wish to retrieve a| `const std::string&` |=== [caption=""] @@ -170,7 +170,7 @@ Retrieves a ``RoleType`` that is overridden by the role with the ``role_label``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `roleLabel` a| Label of the role that overrides an inherited role a| |=== @@ -204,8 +204,8 @@ Retrieves a ``RoleType`` that is overridden by the role with the ``role_label``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| Label of the role that overrides an inherited role a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `roleLabel` a| Label of the role that overrides an inherited role a| `const std::string&` |=== [caption=""] @@ -238,7 +238,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``RelationTyp [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtypes, ``Transitivity::EXPLICIT`` for direct subtypes only a| |=== @@ -304,9 +304,9 @@ Sets the new role that this ``RelationType`` relates to. If we are setting an ov [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| The new role for the ``RelationType`` to relate to a| -a| `overriddenLabel` a| The label being overridden, if applicable a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `roleLabel` a| The new role for the ``RelationType`` to relate to a| `const std::string&` +a| `overriddenLabel` a| The label being overridden, if applicable a| `const std::string&` |=== [caption=""] @@ -340,8 +340,8 @@ Sets the supplied ``RelationType`` as the supertype of the current ``RelationTyp [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `superRelationType` a| The ``RelationType`` to set as the supertype of this ``RelationType`` a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `superRelationType` a| The ``RelationType`` to set as the supertype of this ``RelationType`` a| `RelationType*` |=== [caption=""] @@ -390,8 +390,8 @@ Disallows this ``RelationType`` from relating to the given role. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| The role to not relate to the relation type. a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `roleLabel` a| The role to not relate to the relation type. a| `const std::string&` |=== [caption=""] diff --git a/cpp/docs/schema/RoleType.adoc b/cpp/docs/schema/RoleType.adoc index f7207353f1..42099e28bb 100644 --- a/cpp/docs/schema/RoleType.adoc +++ b/cpp/docs/schema/RoleType.adoc @@ -38,7 +38,7 @@ Implements TypeDB::Type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -123,7 +123,7 @@ Retrieves the ``Thing`` instances that play this role. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect playing, ``Transitivity::EXPLICIT`` for direct playing only a| |=== @@ -157,7 +157,7 @@ Retrieves the ``ThingType``s whose instances play this role. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity.TRANSITIVE`` for direct and indirect playing, ``Transitivity.EXPLICIT`` for direct playing only a| |=== @@ -191,7 +191,7 @@ Retrieves the ``Relation`` instances that this role is related to. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect relation, ``Transitivity::EXPLICIT`` for direct relation only a| |=== @@ -225,7 +225,7 @@ Retrieves the ``RelationType`` that this role is directly related to. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -258,7 +258,7 @@ Retrieves ``RelationType``s that this role is related to (directly or indirectly [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -315,7 +315,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``RoleType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtypes, ``Transitivity::EXPLICIT`` for direct subtypes only a| |=== @@ -349,7 +349,7 @@ Retrieves the most immediate supertype of the ``RoleType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -382,7 +382,7 @@ Retrieves all supertypes of the ``RoleType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -447,7 +447,7 @@ Implements TypeDB::Type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -508,7 +508,7 @@ Implements TypeDB::Type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `label` a| The new ``Label`` to be given to the type. a| |=== diff --git a/cpp/docs/schema/ThingType.adoc b/cpp/docs/schema/ThingType.adoc index 169024cf9e..710a4bfce0 100644 --- a/cpp/docs/schema/ThingType.adoc +++ b/cpp/docs/schema/ThingType.adoc @@ -36,7 +36,7 @@ Implements TypeDB::Type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -179,10 +179,10 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `valueType` a| If specified, only attribute types of this ``ValueType`` will be retrieved. a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `valueType` a| If specified, only attribute types of this ``ValueType`` will be retrieved. a| `ValueType` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and inherited ownership, ``Transitivity::EXPLICIT`` for direct ownership only a| -a| `annotations` a| Only retrieve attribute types owned with annotations. a| +a| `annotations` a| Only retrieve attribute types owned with annotations. a| `const std::vector< Annotation >&` |=== [caption=""] @@ -216,8 +216,8 @@ Retrieves an ``AttributeType``, ownership of which is overridden for this ``Thin [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``AttributeType`` that overrides requested ``AttributeType`` a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `attributeType` a| The ``AttributeType`` that overrides requested ``AttributeType`` a| `AttributeType*` |=== [caption=""] @@ -250,7 +250,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| transitivity: ``Transitivity::TRANSITIVE`` for direct and indirect playing, ``Transitivity::EXPLICIT`` for direct playing only a| |=== @@ -285,8 +285,8 @@ Retrieves a ``RoleType`` that is overridden by the given ``role_type`` for this [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The ``RoleType`` that overrides an inherited role a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `roleType` a| The ``RoleType`` that overrides an inherited role a| `RoleType*` |=== [caption=""] @@ -321,7 +321,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtypes, ``Transitivity.EXPLICIT`` for direct subtypes only a| |=== @@ -358,7 +358,7 @@ Retrieves the most immediate supertype of the type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -393,7 +393,7 @@ Retrieves all supertypes of the type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -426,7 +426,7 @@ Produces a pattern for creating this ``ThingType`` in a ``define`` query. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -491,7 +491,7 @@ Implements TypeDB::Type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -548,7 +548,7 @@ Set a ``ThingType`` to be abstract, meaning it cannot have instances. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -585,7 +585,7 @@ Implements TypeDB::Type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `label` a| The new ``Label`` to be given to the type. a| |=== @@ -669,10 +669,10 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. O [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``AttributeType`` to be owned by the instances of this type. a| -a| `overriddenType` a| The ``AttributeType`` that this attribute ownership overrides, if applicable. a| -a| `annotations` a| Adds annotations to the ownership. a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `attributeType` a| The ``AttributeType`` to be owned by the instances of this type. a| `AttributeType*` +a| `overriddenType` a| The ``AttributeType`` that this attribute ownership overrides, if applicable. a| `AttributeType*` +a| `annotations` a| Adds annotations to the ownership. a| `const std::vector< Annotation >&` |=== [caption=""] @@ -722,8 +722,8 @@ Allows the instances of this ``ThingType`` to play the given role. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to be played by the instances of this type a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `roleType` a| The role to be played by the instances of this type a| `RoleType*` a| `overriddenType` a| The role type that this role overrides, if applicable a| |=== @@ -758,7 +758,7 @@ Set a ``ThingType`` to be non-abstract, meaning it can have instances. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -791,8 +791,8 @@ Disallows the instances of this ``ThingType`` from owning the given ``AttributeT [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``AttributeType`` to not be owned by the type. a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `attributeType` a| The ``AttributeType`` to not be owned by the type. a| `AttributeType*` |=== [caption=""] @@ -825,8 +825,8 @@ Disallows the instances of this ``ThingType`` from playing the given role. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to not be played by the instances of this type. a| +a| `transaction` a| The current transaction a| `Transaction&` +a| `roleType` a| The role to not be played by the instances of this type. a| `RoleType*` |=== [caption=""] diff --git a/cpp/docs/schema/Type.adoc b/cpp/docs/schema/Type.adoc index b94cd7fa0b..5320eb3f9e 100644 --- a/cpp/docs/schema/Type.adoc +++ b/cpp/docs/schema/Type.adoc @@ -33,7 +33,7 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -92,7 +92,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtypes, ``Transitivity.EXPLICIT`` for direct subtypes only a| |=== @@ -127,7 +127,7 @@ Retrieves the most immediate supertype of the type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -160,7 +160,7 @@ Retrieves all supertypes of the type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -221,7 +221,7 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` |=== [caption=""] @@ -256,7 +256,7 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `Transaction&` a| `label` a| The new ``Label`` to be given to the type. a| |=== diff --git a/cpp/docs/session/Options.adoc b/cpp/docs/session/Options.adoc index b4b562e8ee..8c889a6280 100644 --- a/cpp/docs/session/Options.adoc +++ b/cpp/docs/session/Options.adoc @@ -77,7 +77,7 @@ Explicitly enables or disables explanations. If set to ``true``, enables explana [options="header"] |=== |Name |Description |Type -a| `explain` a| Explicitly enable or disable explanations a| +a| `explain` a| Explicitly enable or disable explanations a| `bool` |=== [caption=""] @@ -134,7 +134,7 @@ Explicitly enables or disables inference. Only settable at transaction level and [options="header"] |=== |Name |Description |Type -a| `infer` a| Explicitly enable or disable inference a| +a| `infer` a| Explicitly enable or disable inference a| `bool` |=== [caption=""] @@ -191,7 +191,7 @@ Explicitly enables or disables parallel execution. If set to ``true``, the serve [options="header"] |=== |Name |Description |Type -a| `parallel` a| Explicitly enable or disable parallel execution a| +a| `parallel` a| Explicitly enable or disable parallel execution a| `bool` |=== [caption=""] @@ -248,7 +248,7 @@ Explicitly enables or disables prefetching. If set to ``true``, the first batch [options="header"] |=== |Name |Description |Type -a| `prefetch` a| Explicitly enable or disable prefetching a| +a| `prefetch` a| Explicitly enable or disable prefetching a| `bool` |=== [caption=""] @@ -305,7 +305,7 @@ Explicitly sets a prefetch size. If set, specifies a guideline number of answers [options="header"] |=== |Name |Description |Type -a| `prefetchSize` a| Number of answers that the server should send before the driver issues a fresh request a| +a| `prefetchSize` a| Number of answers that the server should send before the driver issues a fresh request a| `int32_t` |=== [caption=""] @@ -362,7 +362,7 @@ Explicitly enables or disables reading data from any replica. If set to ``True`` [options="header"] |=== |Name |Description |Type -a| `readAnyReplica` a| Explicitly enable or disable reading data from any replica a| +a| `readAnyReplica` a| Explicitly enable or disable reading data from any replica a| `bool` |=== [caption=""] @@ -533,7 +533,7 @@ Explicitly enables or disables reasoning tracing. If set to ``true``, reasoning [options="header"] |=== |Name |Description |Type -a| `traceInference` a| Explicitly enable or disable reasoning tracing a| +a| `traceInference` a| Explicitly enable or disable reasoning tracing a| `bool` |=== [caption=""] diff --git a/cpp/docs/session/Session.adoc b/cpp/docs/session/Session.adoc index 89a47c9bbe..982cd0bd63 100644 --- a/cpp/docs/session/Session.adoc +++ b/cpp/docs/session/Session.adoc @@ -165,7 +165,7 @@ Opens a transaction to perform read or write queries on the database connected t [options="header"] |=== |Name |Description |Type -a| `type` a| The type of transaction to be created (READ or WRITE) a| +a| `type` a| The type of transaction to be created (READ or WRITE) a| `TransactionType` a| `options` a| Options for the session a| |=== diff --git a/cpp/docs/transaction/QueryManager.adoc b/cpp/docs/transaction/QueryManager.adoc index 378bab038c..5366cd75cc 100644 --- a/cpp/docs/transaction/QueryManager.adoc +++ b/cpp/docs/transaction/QueryManager.adoc @@ -27,7 +27,7 @@ Performs a TypeQL Define query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Define query to be executed a| +a| `query` a| The TypeQL Define query to be executed a| `const std::string&` a| `options` a| Specify query options a| |=== @@ -61,7 +61,7 @@ Performs a TypeQL Explain query in the transaction. [options="header"] |=== |Name |Description |Type -a| `explainable` a| The Explainable to be explained a| +a| `explainable` a| The Explainable to be explained a| `const Explainable&` a| `options` a| Specify query options a| |=== @@ -95,7 +95,7 @@ Performs a TypeQL Fetch query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Fetch query to be executed a| +a| `query` a| The TypeQL Fetch query to be executed a| `const std::string&` a| `options` a| Specify query options a| |=== @@ -129,7 +129,7 @@ Performs a TypeQL Get query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Get query to be executed a| +a| `query` a| The TypeQL Get query to be executed a| `const std::string&` a| `options` a| Specify query options a| |=== @@ -163,7 +163,7 @@ Performs a TypeQL Get Aggregate query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Get Aggregate query to be executed a| +a| `query` a| The TypeQL Get Aggregate query to be executed a| `const std::string&` a| `options` a| Specify query options a| |=== @@ -197,7 +197,7 @@ Performs a TypeQL Get Group query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Get Group query to be executed a| +a| `query` a| The TypeQL Get Group query to be executed a| `const std::string&` a| `options` a| Specify query options a| |=== @@ -231,7 +231,7 @@ Performs a TypeQL Get Group Aggregate query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Get Group Aggregate query to be executed a| +a| `query` a| The TypeQL Get Group Aggregate query to be executed a| `const std::string&` a| `options` a| Specify query options a| |=== @@ -265,7 +265,7 @@ Performs a TypeQL Insert query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Insert query to be executed a| +a| `query` a| The TypeQL Insert query to be executed a| `const std::string&` a| `options` a| Specify query options a| |=== @@ -299,7 +299,7 @@ Performs a TypeQL Delete query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Delete query to be executed a| +a| `query` a| The TypeQL Delete query to be executed a| `const std::string&` a| `options` a| Specify query options a| |=== @@ -333,7 +333,7 @@ Performs a TypeQL Undefine query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Undefine query to be executed a| +a| `query` a| The TypeQL Undefine query to be executed a| `const std::string&` a| `options` a| Specify query options a| |=== @@ -367,7 +367,7 @@ Performs a TypeQL Update query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Update query to be executed a| +a| `query` a| The TypeQL Update query to be executed a| `const std::string&` a| `options` a| Specify query options a| |=== diff --git a/csharp/Api/Concept/Type/IThingType.cs b/csharp/Api/Concept/Type/IThingType.cs index aff01eb3e5..5e061727e5 100644 --- a/csharp/Api/Concept/Type/IThingType.cs +++ b/csharp/Api/Concept/Type/IThingType.cs @@ -335,7 +335,7 @@ IEnumerable GetOwns( public class Annotation : NativeObjectWrapper { /** - * @hidden + * @private */ private readonly int _hash; @@ -439,7 +439,7 @@ public override bool Equals(object? obj) } /** - * @hidden + * @private */ public override int GetHashCode() { diff --git a/csharp/Common/Exception/TypeDBDriverException.cs b/csharp/Common/Exception/TypeDBDriverException.cs index 816ef59d5a..8c067675a8 100644 --- a/csharp/Common/Exception/TypeDBDriverException.cs +++ b/csharp/Common/Exception/TypeDBDriverException.cs @@ -30,7 +30,7 @@ namespace TypeDB.Driver.Common public class TypeDBDriverException : System.Exception { /** - * @hidden + * @private */ public TypeDBDriverException(ErrorMessage error, params object?[] errorParams) : base(error.ToString(errorParams)) @@ -38,7 +38,7 @@ public TypeDBDriverException(ErrorMessage error, params object?[] errorParams) } /** - * @hidden + * @private */ public TypeDBDriverException(string message) : base(message) @@ -46,7 +46,7 @@ public TypeDBDriverException(string message) } /** - * @hidden + * @private */ public TypeDBDriverException(System.Exception error) : base(error.Message) @@ -54,7 +54,7 @@ public TypeDBDriverException(System.Exception error) } /** - * @hidden + * @private */ public TypeDBDriverException(Pinvoke.Error nativeError) : base(nativeError.Message) diff --git a/csharp/Common/Label.cs b/csharp/Common/Label.cs index fe0cb8a6d7..4be566b3cd 100644 --- a/csharp/Common/Label.cs +++ b/csharp/Common/Label.cs @@ -50,7 +50,7 @@ public struct Label public readonly string Name; /** - * @hidden + * @private */ private readonly int _hash; @@ -141,7 +141,7 @@ public override bool Equals(object? obj) } /** - * @hidden + * @private */ public override int GetHashCode() { diff --git a/csharp/Common/Promise/Promise.cs b/csharp/Common/Promise/Promise.cs index e53bc4d186..c0eb69081a 100644 --- a/csharp/Common/Promise/Promise.cs +++ b/csharp/Common/Promise/Promise.cs @@ -27,7 +27,7 @@ namespace TypeDB.Driver.Common /** * A Promise represents an asynchronous network operation. *

The request it represents is performed immediately. The response is only retrieved - * once the Promise is Resolved.

. + * once the Promise is Resolved.

*/ public class Promise { @@ -41,7 +41,7 @@ public class Promise * new Promise(supplier); * * - * @param promise The function to wrap into the promise + * @param resolver The function to wrap into the promise */ public Promise(Func resolver) { @@ -76,8 +76,8 @@ public Promise(Func resolver) * Promise<TFrom>.Map<TTo, T>(supplier, selector); * * - * @param promise The function to wrap into the promise - * @param fn The mapping function + * @param resolver The function to wrap into the promise + * @param selector The mapping (like Select from Linq) function */ public static Promise Map(Func resolver, Func selector) { diff --git a/csharp/docs/answer/IConceptMap.adoc b/csharp/docs/answer/IConceptMap.adoc index 7120cf685e..fef5ae67f1 100644 --- a/csharp/docs/answer/IConceptMap.adoc +++ b/csharp/docs/answer/IConceptMap.adoc @@ -51,7 +51,7 @@ Retrieves a concept for a given variable name. [options="header"] |=== |Name |Description |Type -a| `variable` a| The string representation of a variable a| +a| `variable` a| The string representation of a variable a| `string` |=== [caption=""] diff --git a/csharp/docs/answer/IExplainables.adoc b/csharp/docs/answer/IExplainables.adoc index 1401678157..fb13f98c9c 100644 --- a/csharp/docs/answer/IExplainables.adoc +++ b/csharp/docs/answer/IExplainables.adoc @@ -27,7 +27,7 @@ Retrieves the explainable attribute with the given variable name. [options="header"] |=== |Name |Description |Type -a| `variable` a| The string representation of a variable a| +a| `variable` a| The string representation of a variable a| `string` |=== [caption=""] @@ -132,8 +132,8 @@ Retrieves the explainable attribute ownership with the pair of (owner, attribute [options="header"] |=== |Name |Description |Type -a| `owner` a| The string representation of the owner variable a| -a| `attribute` a| The string representation of the attribute variable a| +a| `owner` a| The string representation of the owner variable a| `string` +a| `attribute` a| The string representation of the attribute variable a| `string` |=== [caption=""] @@ -166,7 +166,7 @@ Retrieves the explainable relation with the given variable name. [options="header"] |=== |Name |Description |Type -a| `variable` a| The string representation of a variable a| +a| `variable` a| The string representation of a variable a| `string` |=== [caption=""] diff --git a/csharp/docs/answer/IExplanation.adoc b/csharp/docs/answer/IExplanation.adoc index 3e1d706f58..38d86798ef 100644 --- a/csharp/docs/answer/IExplanation.adoc +++ b/csharp/docs/answer/IExplanation.adoc @@ -99,7 +99,7 @@ Retrieves the rule variables corresponding to the query variable var for this `` [options="header"] |=== |Name |Description |Type -a| `variable` a| The query variable to map to rule variables. a| +a| `variable` a| The query variable to map to rule variables. a| `string` |=== [caption=""] diff --git a/csharp/docs/answer/Promise__T__.adoc b/csharp/docs/answer/Promise__T__.adoc index a9d980b869..2999ddb477 100644 --- a/csharp/docs/answer/Promise__T__.adoc +++ b/csharp/docs/answer/Promise__T__.adoc @@ -9,8 +9,6 @@ A ``Promise`` represents an asynchronous network operation. The request it represents is performed immediately. The response is only retrieved once the ``Promise`` is ``Resolve``d. -. - // tag::methods[] [#_static_Promise__TTo___TypeDB_Driver_Common_Promise__T___Map__TFrom__TTo_____Func__TFrom__resolver__Func__TFrom__TTo___selector_] ==== Map< TFrom, TTo > @@ -31,8 +29,8 @@ Helper function to map promises. [options="header"] |=== |Name |Description |Type -a| `promise` a| The function to wrap into the promise a| -a| `fn` a| The mapping function a| +a| `resolver` a| The function to wrap into the promise a| `Func< TFrom?>` +a| `selector` a| The mapping (like Select from Linq) function a| `TTo >` |=== [caption=""] @@ -65,7 +63,7 @@ Promise constructor [options="header"] |=== |Name |Description |Type -a| `promise` a| The function to wrap into the promise a| +a| `resolver` a| The function to wrap into the promise a| `Func< T?>` |=== [caption=""] diff --git a/csharp/docs/concept/IConceptManager.adoc b/csharp/docs/concept/IConceptManager.adoc index 7fbe072e1a..27b0f2b20d 100644 --- a/csharp/docs/concept/IConceptManager.adoc +++ b/csharp/docs/concept/IConceptManager.adoc @@ -27,7 +27,7 @@ Retrieves an ``IAttribute`` by its iid. [options="header"] |=== |Name |Description |Type -a| `iid` a| The iid of the ``Attribute`` to retrieve. a| +a| `iid` a| The iid of the ``Attribute`` to retrieve. a| `string` |=== [caption=""] @@ -60,7 +60,7 @@ Retrieves an ``IAttributeType`` by its label. [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``AttributeType`` to retrieve. a| +a| `label` a| The label of the ``AttributeType`` to retrieve. a| `string` |=== [caption=""] @@ -93,7 +93,7 @@ Retrieves an ``IEntity`` by its iid. [options="header"] |=== |Name |Description |Type -a| `iid` a| The iid of the ``Entity`` to retrieve. a| +a| `iid` a| The iid of the ``Entity`` to retrieve. a| `string` |=== [caption=""] @@ -126,7 +126,7 @@ Retrieves an ``IEntityType`` by its label. [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``IEntityType`` to retrieve. a| +a| `label` a| The label of the ``IEntityType`` to retrieve. a| `string` |=== [caption=""] @@ -159,7 +159,7 @@ Retrieves a ``IRelation`` by its iid. [options="header"] |=== |Name |Description |Type -a| `iid` a| The iid of the ``Relation`` to retrieve. a| +a| `iid` a| The iid of the ``Relation`` to retrieve. a| `string` |=== [caption=""] @@ -192,7 +192,7 @@ Retrieves a ``IRelationType`` by its label. [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``IRelationType`` to retrieve. a| +a| `label` a| The label of the ``IRelationType`` to retrieve. a| `string` |=== [caption=""] @@ -249,8 +249,8 @@ Creates a new ``IAttributeType`` if none exists with the given label, or retriev [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``IAttributeType`` to create or retrieve. a| -a| `valueType` a| The value type of the ``IAttributeType`` to create. a| +a| `label` a| The label of the ``IAttributeType`` to create or retrieve. a| `string` +a| `valueType` a| The value type of the ``IAttributeType`` to create. a| `IValue.ValueType` |=== [caption=""] @@ -283,7 +283,7 @@ Creates a new ``IEntityType`` if none exists with the given label, otherwise ret [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``IEntityType`` to create or retrieve. a| +a| `label` a| The label of the ``IEntityType`` to create or retrieve. a| `string` |=== [caption=""] @@ -316,7 +316,7 @@ Creates a new ``IRelationType`` if none exists with the given label, otherwise r [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the ``IRelationType`` to create or retrieve. a| +a| `label` a| The label of the ``IRelationType`` to create or retrieve. a| `string` |=== [caption=""] diff --git a/csharp/docs/connection/IDatabaseManager.adoc b/csharp/docs/connection/IDatabaseManager.adoc index 476119404d..9cbf48dffa 100644 --- a/csharp/docs/connection/IDatabaseManager.adoc +++ b/csharp/docs/connection/IDatabaseManager.adoc @@ -27,7 +27,7 @@ Checks if a database with the given name exists. [options="header"] |=== |Name |Description |Type -a| `name` a| The database name to be checked a| +a| `name` a| The database name to be checked a| `string` |=== [caption=""] @@ -60,7 +60,7 @@ Create a database with the given name. [options="header"] |=== |Name |Description |Type -a| `name` a| The name of the database to be created a| +a| `name` a| The name of the database to be created a| `string` |=== [caption=""] @@ -93,7 +93,7 @@ Retrieve the database with the given name. [options="header"] |=== |Name |Description |Type -a| `name` a| The name of the database to retrieve a| +a| `name` a| The name of the database to retrieve a| `string` |=== [caption=""] diff --git a/csharp/docs/connection/ITypeDBDriver.adoc b/csharp/docs/connection/ITypeDBDriver.adoc index bf99c996a0..bc32bf0938 100644 --- a/csharp/docs/connection/ITypeDBDriver.adoc +++ b/csharp/docs/connection/ITypeDBDriver.adoc @@ -143,9 +143,9 @@ Opens a communication tunnel (session) to the given database on the running Type [options="header"] |=== |Name |Description |Type -a| `database` a| The name of the database with which the session connects a| -a| `type` a| The type of session to be created (Data or Schema) a| -a| `options` a| ``TypeDBOptions`` for the session a| +a| `database` a| The name of the database with which the session connects a| `string` +a| `type` a| The type of session to be created (Data or Schema) a| `SessionType` +a| `options` a| ``TypeDBOptions`` for the session a| `TypeDBOptions` |=== [caption=""] diff --git a/csharp/docs/connection/IUser.adoc b/csharp/docs/connection/IUser.adoc index 9e709faaaf..3252252eec 100644 --- a/csharp/docs/connection/IUser.adoc +++ b/csharp/docs/connection/IUser.adoc @@ -61,8 +61,8 @@ Updates the password for this user. [options="header"] |=== |Name |Description |Type -a| `passwordOld` a| The current password of this user a| -a| `passwordNew` a| The new password a| +a| `passwordOld` a| The current password of this user a| `string` +a| `passwordNew` a| The new password a| `string` |=== [caption=""] diff --git a/csharp/docs/connection/IUserManager.adoc b/csharp/docs/connection/IUserManager.adoc index b55e0a3abd..e9b5ad23dc 100644 --- a/csharp/docs/connection/IUserManager.adoc +++ b/csharp/docs/connection/IUserManager.adoc @@ -27,7 +27,7 @@ Checks if a user with the given name exists. [options="header"] |=== |Name |Description |Type -a| `username` a| The user name to be checked a| +a| `username` a| The user name to be checked a| `string` |=== [caption=""] @@ -60,8 +60,8 @@ Creates a user with the given name & password. [options="header"] |=== |Name |Description |Type -a| `username` a| The name of the user to be created a| -a| `password` a| The password of the user to be created a| +a| `username` a| The name of the user to be created a| `string` +a| `password` a| The password of the user to be created a| `string` |=== [caption=""] @@ -94,7 +94,7 @@ Deletes a user with the given name. [options="header"] |=== |Name |Description |Type -a| `username` a| The name of the user to be deleted a| +a| `username` a| The name of the user to be deleted a| `string` |=== [caption=""] @@ -127,7 +127,7 @@ Retrieves a user with the given name. [options="header"] |=== |Name |Description |Type -a| `username` a| The name of the user to retrieve a| +a| `username` a| The name of the user to retrieve a| `string` |=== [caption=""] @@ -184,8 +184,8 @@ Sets a new password for a user. This operation can only be performed by administ [options="header"] |=== |Name |Description |Type -a| `username` a| The name of the user to set the password of a| -a| `password` a| The new password a| +a| `username` a| The name of the user to set the password of a| `string` +a| `password` a| The new password a| `string` |=== [caption=""] diff --git a/csharp/docs/connection/TypeDB.adoc b/csharp/docs/connection/TypeDB.adoc index 184609b8fa..fb85bdb206 100644 --- a/csharp/docs/connection/TypeDB.adoc +++ b/csharp/docs/connection/TypeDB.adoc @@ -23,8 +23,8 @@ Open a TypeDB Driver to a TypeDB Cloud server available at the provided address, [options="header"] |=== |Name |Description |Type -a| `address` a| The address of the TypeDB server a| -a| `credential` a| The credential to connect with a| +a| `address` a| The address of the TypeDB server a| `string` +a| `credential` a| The credential to connect with a| `TypeDBCredential` |=== [caption=""] @@ -57,8 +57,8 @@ Open a TypeDB Driver to TypeDB Cloud server(s) available at the provided address [options="header"] |=== |Name |Description |Type -a| `addresses` a| The address(es) of the TypeDB server(s) a| -a| `credential` a| The credential to connect with a| +a| `addresses` a| The address(es) of the TypeDB server(s) a| `ICollection< string >` +a| `credential` a| The credential to connect with a| `TypeDBCredential` |=== [caption=""] @@ -91,7 +91,7 @@ Open a TypeDB Driver to a TypeDB Core server available at the provided address. [options="header"] |=== |Name |Description |Type -a| `address` a| The address of the TypeDB server a| +a| `address` a| The address of the TypeDB server a| `string` |=== [caption=""] diff --git a/csharp/docs/connection/TypeDBCredential.adoc b/csharp/docs/connection/TypeDBCredential.adoc index 393d234d50..2be95cb55e 100644 --- a/csharp/docs/connection/TypeDBCredential.adoc +++ b/csharp/docs/connection/TypeDBCredential.adoc @@ -58,9 +58,9 @@ TypeDBCredential(string username, string password, bool tlsEnabled) [options="header"] |=== |Name |Description |Type -a| `username` a| The name of the user to connect as a| -a| `password` a| The password for the user a| -a| `tlsEnabled` a| Specify whether the connection to TypeDB Cloud must be done over TLS a| +a| `username` a| The name of the user to connect as a| `string` +a| `password` a| The password for the user a| `string` +a| `tlsEnabled` a| Specify whether the connection to TypeDB Cloud must be done over TLS a| `bool` |=== [caption=""] @@ -105,9 +105,9 @@ TypeDBCredential(string username, string password, string? tlsRootCAPath) [options="header"] |=== |Name |Description |Type -a| `username` a| The name of the user to connect as a| -a| `password` a| The password for the user a| -a| `tlsRootCAPath` a| Path to the CA certificate to use for authenticating server certificates a| +a| `username` a| The name of the user to connect as a| `string` +a| `password` a| The password for the user a| `string` +a| `tlsRootCAPath` a| Path to the CA certificate to use for authenticating server certificates a| `string?` |=== [caption=""] diff --git a/csharp/docs/data/IAttribute.adoc b/csharp/docs/data/IAttribute.adoc index cdfb52e4a7..1f0aa4013d 100644 --- a/csharp/docs/data/IAttribute.adoc +++ b/csharp/docs/data/IAttribute.adoc @@ -60,7 +60,7 @@ Retrieves the instances that own this ``IAttribute``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -93,8 +93,8 @@ Retrieves the instances that own this ``IAttribute``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `ownerType` a| Filter results for only owners of the given type a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `ownerType` a| Filter results for only owners of the given type a| `IThingType` |=== [caption=""] diff --git a/csharp/docs/data/IRelation.adoc b/csharp/docs/data/IRelation.adoc index fa844cf944..e53857b4e6 100644 --- a/csharp/docs/data/IRelation.adoc +++ b/csharp/docs/data/IRelation.adoc @@ -32,9 +32,9 @@ Adds a new role player to play the given role in this ``IRelation``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to be played by the ``player`` a| -a| `player` a| The thing to play the role a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `roleType` a| The role to be played by the ``player`` a| `IRoleType` +a| `player` a| The thing to play the role a| `IThing` |=== [caption=""] @@ -93,7 +93,7 @@ Retrieves a mapping of all instances involved in the ``IRelation`` and the role [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -126,8 +126,8 @@ Retrieves all role players of this ``IRelation``, optionally filtered by given r [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleTypes` a| 0 or more role types a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `roleTypes` a| 0 or more role types a| `params IRoleType[]` |=== [caption=""] @@ -160,7 +160,7 @@ Retrieves all role types currently played in this ``IRelation``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -219,9 +219,9 @@ Removes the association of the given instance that plays the given role in this [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to no longer be played by the thing in this ``IRelation`` a| -a| `player` a| The instance to no longer play the role in this ``IRelation`` a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `roleType` a| The role to no longer be played by the thing in this ``IRelation`` a| `IRoleType` +a| `player` a| The instance to no longer play the role in this ``IRelation`` a| `IThing` |=== [caption=""] diff --git a/csharp/docs/data/IThing.adoc b/csharp/docs/data/IThing.adoc index eb88582112..5ad36b5b9a 100644 --- a/csharp/docs/data/IThing.adoc +++ b/csharp/docs/data/IThing.adoc @@ -53,7 +53,7 @@ Deletes this ``IThing``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -86,8 +86,8 @@ Retrieves the ``IAttribute``s that this ``IThing`` owns, optionally filtered by [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeTypes` a| The ``IAttributeType``s to filter the attributes by a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `attributeTypes` a| The ``IAttributeType``s to filter the attributes by a| `params IAttributeType[]` |=== [caption=""] @@ -121,8 +121,8 @@ Retrieves the ``IAttribute``s that this ``IThing`` owns, filtered by ``Annotatio [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `annotations` a| Only retrieve attributes with all given ``Annotation``s a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `annotations` a| Only retrieve attributes with all given ``Annotation``s a| `ICollection< Annotation >` |=== [caption=""] @@ -156,7 +156,7 @@ Retrieves the roles that this ``IThing`` is currently playing. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -189,8 +189,8 @@ Retrieves all the ``Relations`` which this ``IThing`` plays a role in, optionall [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleTypes` a| The array of roles to filter the relations by. a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `roleTypes` a| The array of roles to filter the relations by. a| `params IRoleType[]` |=== [caption=""] @@ -247,7 +247,7 @@ Checks if this ``IThing`` is deleted. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -330,8 +330,8 @@ Assigns an ``IAttribute`` to be owned by this ``IThing``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attribute` a| The ``IAttribute`` to be owned by this ``IThing``. a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `attribute` a| The ``IAttribute`` to be owned by this ``IThing``. a| `IAttribute` |=== [caption=""] @@ -388,8 +388,8 @@ Unassigns an ``IAttribute`` from this ``IThing``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attribute` a| The ``IAttribute`` to be disowned from this ``IThing``. a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `attribute` a| The ``IAttribute`` to be disowned from this ``IThing``. a| `IAttribute` |=== [caption=""] diff --git a/csharp/docs/errors/TypeDBDriverException.adoc b/csharp/docs/errors/TypeDBDriverException.adoc index be0232e91a..f80b6648a1 100644 --- a/csharp/docs/errors/TypeDBDriverException.adoc +++ b/csharp/docs/errors/TypeDBDriverException.adoc @@ -46,69 +46,5 @@ catch (TypeDBDriverException e) } ---- -[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___ErrorMessage_error__params_object___errorParams_] -==== TypeDBDriverException - -[source,cs] ----- -TypeDBDriverException(ErrorMessage error, params object?[] errorParams) ----- - - - -@hidden - -[caption=""] -.Returns -`TypeDBDriverException` - -[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___string_message_] -==== TypeDBDriverException - -[source,cs] ----- -TypeDBDriverException(string message) ----- - - - -@hidden - -[caption=""] -.Returns -`TypeDBDriverException` - -[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___SystemException_error_] -==== TypeDBDriverException - -[source,cs] ----- -TypeDBDriverException(System::Exception error) ----- - - - -@hidden - -[caption=""] -.Returns -`TypeDBDriverException` - -[#_TypeDB_Driver_Common_TypeDBDriverException_TypeDBDriverException___PinvokeError_nativeError_] -==== TypeDBDriverException - -[source,cs] ----- -TypeDBDriverException(Pinvoke::Error nativeError) ----- - - - -@hidden - -[caption=""] -.Returns -`TypeDBDriverException` - // end::methods[] diff --git a/csharp/docs/logic/ILogicManager.adoc b/csharp/docs/logic/ILogicManager.adoc index 155d51c394..139ceba0d6 100644 --- a/csharp/docs/logic/ILogicManager.adoc +++ b/csharp/docs/logic/ILogicManager.adoc @@ -27,7 +27,7 @@ Retrieves the Rule that has the given label. [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the Rule to create or retrieve a| +a| `label` a| The label of the Rule to create or retrieve a| `string` |=== [caption=""] @@ -84,9 +84,9 @@ Creates a new Rule if none exists with the given label, or replaces the existing [options="header"] |=== |Name |Description |Type -a| `label` a| The label of the IRule to create or replace a| -a| `when` a| The when body of the rule to create a| -a| `then` a| The then body of the rule to create a| +a| `label` a| The label of the IRule to create or replace a| `string` +a| `when` a| The when body of the rule to create a| `string` +a| `then` a| The then body of the rule to create a| `string` |=== [caption=""] diff --git a/csharp/docs/logic/IRule.adoc b/csharp/docs/logic/IRule.adoc index aca12eeefd..6e1c812b9e 100644 --- a/csharp/docs/logic/IRule.adoc +++ b/csharp/docs/logic/IRule.adoc @@ -27,7 +27,7 @@ Deletes this rule. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current ``Transaction`` a| +a| `transaction` a| The current ``Transaction`` a| `ITypeDBTransaction` |=== [caption=""] @@ -60,7 +60,7 @@ Check if this rule has been deleted. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current ``Transaction`` a| +a| `transaction` a| The current ``Transaction`` a| `ITypeDBTransaction` |=== [caption=""] @@ -109,8 +109,8 @@ Renames the label of the rule. The new label must remain unique. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current ``Transaction`` a| -a| `label` a| The new label to be given to the rule a| +a| `transaction` a| The current ``Transaction`` a| `ITypeDBTransaction` +a| `label` a| The new label to be given to the rule a| `string` |=== [caption=""] diff --git a/csharp/docs/schema/Annotation.adoc b/csharp/docs/schema/Annotation.adoc index 37986ce09b..38197fe5ba 100644 --- a/csharp/docs/schema/Annotation.adoc +++ b/csharp/docs/schema/Annotation.adoc @@ -27,7 +27,7 @@ Checks if this ``Annotation`` is equal to another object. [options="header"] |=== |Name |Description |Type -a| `obj` a| Object to compare with a| +a| `obj` a| Object to compare with a| `object?` |=== [caption=""] @@ -41,22 +41,6 @@ a| `obj` a| Object to compare with a| annotation.Equals(obj); ---- -[#_override_int_TypeDB_Driver_Api_IThingType_Annotation_GetHashCode___] -==== GetHashCode - -[source,cs] ----- -override int GetHashCode() ----- - - - -@hidden - -[caption=""] -.Returns -`override int` - [#_bool_TypeDB_Driver_Api_IThingType_Annotation_IsKey___] ==== IsKey diff --git a/csharp/docs/schema/IAttributeType.adoc b/csharp/docs/schema/IAttributeType.adoc index 47432346d0..acc405ff65 100644 --- a/csharp/docs/schema/IAttributeType.adoc +++ b/csharp/docs/schema/IAttributeType.adoc @@ -67,8 +67,8 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| ``IAttribute``’s value a| `IValue` |=== [caption=""] @@ -101,8 +101,8 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| ``IAttribute``’s value a| `string` |=== [caption=""] @@ -135,8 +135,8 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| ``IAttribute``’s value a| `long` |=== [caption=""] @@ -169,8 +169,8 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| ``IAttribute``’s value a| `double` |=== [caption=""] @@ -203,8 +203,8 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| ``IAttribute``’s value a| `bool` |=== [caption=""] @@ -237,8 +237,8 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| ``IAttribute``’s value a| `System.DateTime` |=== [caption=""] @@ -271,7 +271,7 @@ Retrieve all ``Things`` that own an attribute of this ``IAttributeType`` directl [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -304,8 +304,8 @@ Retrieve all ``Things`` that own an attribute of this ``IAttributeType``, filter [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``IAttributeType`` with all given ``Annotation``s a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``IAttributeType`` with all given ``Annotation``s a| `ICollection< Annotation >` |=== [caption=""] @@ -338,8 +338,8 @@ Retrieve all ``Things`` that own an attribute of this ``IAttributeType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| `IConcept.Transitivity` |=== [caption=""] @@ -372,9 +372,9 @@ Retrieve all ``Things`` that own an attribute of this ``IAttributeType``, filter [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``IAttributeType`` with all given ``Annotation``s a| -a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``IAttributeType`` with all given ``Annotation``s a| `ICollection< Annotation >` +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| `IConcept.Transitivity` |=== [caption=""] @@ -407,7 +407,7 @@ Retrieves the regular expression that is defined for this ``IAttributeType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -440,8 +440,8 @@ Retrieves all direct and indirect subtypes of this ``IAttributeType`` with given [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| `IValue.ValueType` |=== [caption=""] @@ -474,9 +474,9 @@ Retrieves all direct and indirect (or direct only) subtypes of this ``IAttribute [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| -a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| `IValue.ValueType` +a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| `IConcept.Transitivity` |=== [caption=""] @@ -657,8 +657,8 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given val [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| New ``IAttribute``’s value a| `IValue` |=== [caption=""] @@ -691,8 +691,8 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``s [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| New ``IAttribute``’s value a| `string` |=== [caption=""] @@ -725,8 +725,8 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``l [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| New ``IAttribute``’s value a| `long` |=== [caption=""] @@ -759,8 +759,8 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``d [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| New ``IAttribute``’s value a| `double` |=== [caption=""] @@ -793,8 +793,8 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``b [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| New ``IAttribute``’s value a| `bool` |=== [caption=""] @@ -827,8 +827,8 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``D [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `value` a| New ``IAttribute``’s value a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `value` a| New ``IAttribute``’s value a| `System.DateTime` |=== [caption=""] @@ -863,8 +863,8 @@ Can only be applied for ``IAttributeType``s with a ``string`` value type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `regex` a| Regular expression a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `regex` a| Regular expression a| `string` |=== [caption=""] @@ -897,8 +897,8 @@ Sets the supplied ``IAttributeType`` as the supertype of the current ``IAttribut [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``IAttributeType`` to set as the supertype of this ``IAttributeType`` a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `attributeType` a| The ``IAttributeType`` to set as the supertype of this ``IAttributeType`` a| `IAttributeType` |=== [caption=""] @@ -931,7 +931,7 @@ Removes the regular expression that is defined for this ``IAttributeType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] diff --git a/csharp/docs/schema/IEntityType.adoc b/csharp/docs/schema/IEntityType.adoc index 67ea7779d4..2bac874ef3 100644 --- a/csharp/docs/schema/IEntityType.adoc +++ b/csharp/docs/schema/IEntityType.adoc @@ -61,7 +61,7 @@ Creates and returns a new instance of this ``IEntityType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -122,8 +122,8 @@ Sets the supplied ``IEntityType`` as the supertype of the current ``IEntityType` [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `superEntityType` a| The ``IEntityType`` to set as the supertype of this ``IEntityType`` a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `superEntityType` a| The ``IEntityType`` to set as the supertype of this ``IEntityType`` a| `IEntityType` |=== [caption=""] diff --git a/csharp/docs/schema/IRelationType.adoc b/csharp/docs/schema/IRelationType.adoc index eeb49235e7..9db3eec329 100644 --- a/csharp/docs/schema/IRelationType.adoc +++ b/csharp/docs/schema/IRelationType.adoc @@ -61,7 +61,7 @@ Creates and returns an instance of this ``IRelationType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -118,8 +118,8 @@ Retrieves roles that this ``IRelationType`` relates to directly or via inheritan [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and inherited relates, ``Explicit`` for direct relates only a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `transitivity` a| ``Transitive`` for direct and inherited relates, ``Explicit`` for direct relates only a| `IConcept.Transitivity` |=== [caption=""] @@ -152,8 +152,8 @@ Retrieves roles that this ``IRelationType`` relates to directly or via inheritan [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| Label of the role we wish to retrieve a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `roleLabel` a| Label of the role we wish to retrieve a| `string` |=== [caption=""] @@ -210,8 +210,8 @@ Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label`` [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| Label of the role that overrides an inherited role a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `roleLabel` a| Label of the role that overrides an inherited role a| `string` |=== [caption=""] @@ -320,9 +320,9 @@ Sets the new role that this ``IRelationType`` relates to. If we are setting an o [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| The new role for the ``IRelationType`` to relate to a| -a| `overriddenLabel` a| The label being overridden, if applicable a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `roleLabel` a| The new role for the ``IRelationType`` to relate to a| `string` +a| `overriddenLabel` a| The label being overridden, if applicable a| `string?` |=== [caption=""] @@ -356,8 +356,8 @@ Sets the supplied ``IRelationType`` as the supertype of the current ``IRelationT [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `superRelationType` a| The ``IRelationType`` to set as the supertype of this ``IRelationType`` a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `superRelationType` a| The ``IRelationType`` to set as the supertype of this ``IRelationType`` a| `IRelationType` |=== [caption=""] @@ -414,8 +414,8 @@ Disallows this ``IRelationType`` from relating to the given role. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleLabel` a| The role to not relate to the relation type. a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `roleLabel` a| The role to not relate to the relation type. a| `string` |=== [caption=""] diff --git a/csharp/docs/schema/IRoleType.adoc b/csharp/docs/schema/IRoleType.adoc index 0ab89ed960..93f15c96ba 100644 --- a/csharp/docs/schema/IRoleType.adoc +++ b/csharp/docs/schema/IRoleType.adoc @@ -84,8 +84,8 @@ Retrieves the ``Thing`` instances that play this role. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| `IConcept.Transitivity` |=== [caption=""] @@ -142,8 +142,8 @@ Retrieves the ``ThingType``s whose instances play this role. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| `IConcept.Transitivity` |=== [caption=""] @@ -200,8 +200,8 @@ Retrieves the ``Relation`` instances that this role is related to. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and indirect relation, ``Explicit`` for direct relation only a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `transitivity` a| ``Transitive`` for direct and indirect relation, ``Explicit`` for direct relation only a| `IConcept.Transitivity` |=== [caption=""] @@ -234,7 +234,7 @@ Retrieves ``RelationType``s that this role is related to (directly or indirectly [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] diff --git a/csharp/docs/schema/IThingType.adoc b/csharp/docs/schema/IThingType.adoc index 4870b3a537..b315092e65 100644 --- a/csharp/docs/schema/IThingType.adoc +++ b/csharp/docs/schema/IThingType.adoc @@ -80,8 +80,8 @@ Retrieves ``IThing`` objects that are instances of this exact ``IThingType``, OR [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Explicit`` for direct instances only, ``Transitive`` to include instances of subtypes a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `transitivity` a| ``Explicit`` for direct instances only, ``Transitive`` to include instances of subtypes a| `IConcept.Transitivity` |=== [caption=""] @@ -283,10 +283,10 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `valueType` a| If specified, only attribute types of this ``ValueType`` will be retrieved. a| -a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| -a| `annotations` a| Only retrieve attribute types owned with annotations. a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `valueType` a| If specified, only attribute types of this ``ValueType`` will be retrieved. a| `IValue.ValueType?` +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| `IConcept.Transitivity` +a| `annotations` a| Only retrieve attribute types owned with annotations. a| `ICollection< Annotation >` |=== [caption=""] @@ -320,8 +320,8 @@ Retrieves an ``IAttributeType``, ownership of which is overridden for this ``ITh [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``IAttributeType`` that overrides requested ``IAttributeType`` a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `attributeType` a| The ``IAttributeType`` that overrides requested ``IAttributeType`` a| `IAttributeType` |=== [caption=""] @@ -378,8 +378,8 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| transitivity: ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `transitivity` a| transitivity: ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| `IConcept.Transitivity` |=== [caption=""] @@ -413,8 +413,8 @@ Retrieves a ``IRoleType`` that is overridden by the given ``role_type`` for this [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The ``IRoleType`` that overrides an inherited role a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `roleType` a| The ``IRoleType`` that overrides an inherited role a| `IRoleType` |=== [caption=""] @@ -447,7 +447,7 @@ Produces a pattern for creating this ``IThingType`` in a ``define`` query. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -508,7 +508,7 @@ Set a ``IThingType`` to be abstract, meaning it cannot have instances. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -541,10 +541,10 @@ Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``IAttributeType`` to be owned by the instances of this type. a| -a| `overriddenType` a| The ``IAttributeType`` that this attribute ownership overrides, if applicable. a| -a| `annotations` a| Adds annotations to the ownership. a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `attributeType` a| The ``IAttributeType`` to be owned by the instances of this type. a| `IAttributeType` +a| `overriddenType` a| The ``IAttributeType`` that this attribute ownership overrides, if applicable. a| `IAttributeType?` +a| `annotations` a| Adds annotations to the ownership. a| `ICollection< Annotation >` |=== [caption=""] @@ -674,9 +674,9 @@ Allows the instances of this ``IThingType`` to play the given role. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to be played by the instances of this type a| -a| `overriddenType` a| The role type that this role overrides, if applicable a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `roleType` a| The role to be played by the instances of this type a| `IRoleType` +a| `overriddenType` a| The role type that this role overrides, if applicable a| `IRoleType` |=== [caption=""] @@ -710,7 +710,7 @@ Set a ``IThingType`` to be non-abstract, meaning it can have instances. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -743,8 +743,8 @@ Disallows the instances of this ``IThingType`` from owning the given ``IAttribut [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `attributeType` a| The ``IAttributeType`` to not be owned by the type. a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `attributeType` a| The ``IAttributeType`` to not be owned by the type. a| `IAttributeType` |=== [caption=""] @@ -777,8 +777,8 @@ Disallows the instances of this ``IThingType`` from playing the given role. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `roleType` a| The role to not be played by the instances of this type. a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `roleType` a| The role to not be played by the instances of this type. a| `IRoleType` |=== [caption=""] diff --git a/csharp/docs/schema/IType.adoc b/csharp/docs/schema/IType.adoc index c7eee17ff7..f03fab4381 100644 --- a/csharp/docs/schema/IType.adoc +++ b/csharp/docs/schema/IType.adoc @@ -55,7 +55,7 @@ Deletes this type from the database. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -112,8 +112,8 @@ Retrieves all direct and indirect (or direct only) subtypes of the type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| `IConcept.Transitivity` |=== [caption=""] @@ -147,7 +147,7 @@ Retrieves the most immediate supertype of the type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -180,7 +180,7 @@ Retrieves all supertypes of the type. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -237,7 +237,7 @@ Check if the concept has been deleted. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` |=== [caption=""] @@ -346,8 +346,8 @@ Renames the label of the type. The new label must remain unique. [options="header"] |=== |Name |Description |Type -a| `transaction` a| The current transaction a| -a| `label` a| The new ``Label`` to be given to the type. a| +a| `transaction` a| The current transaction a| `ITypeDBTransaction` +a| `label` a| The new ``Label`` to be given to the type. a| `string` |=== [caption=""] diff --git a/csharp/docs/schema/Label.adoc b/csharp/docs/schema/Label.adoc index 91ef2bdeb3..5bac5fca9f 100644 --- a/csharp/docs/schema/Label.adoc +++ b/csharp/docs/schema/Label.adoc @@ -55,7 +55,7 @@ Checks if this Label is equal to another object. [options="header"] |=== |Name |Description |Type -a| `obj` a| Object to compare with a| +a| `obj` a| Object to compare with a| `object?` |=== [caption=""] @@ -69,22 +69,6 @@ a| `obj` a| Object to compare with a| label.Equals(obj); ---- -[#_override_int_TypeDB_Driver_Common_Label_GetHashCode___] -==== GetHashCode - -[source,cs] ----- -override int GetHashCode() ----- - - - -@hidden - -[caption=""] -.Returns -`override int` - [#_TypeDB_Driver_Common_Label_Label___string_scope__string_name_] ==== Label @@ -104,8 +88,8 @@ Creates a Label from a specified scope and name. [options="header"] |=== |Name |Description |Type -a| `scope` a| Label scope a| -a| `name` a| Label name a| +a| `scope` a| Label scope a| `string?` +a| `name` a| Label name a| `string` |=== [caption=""] @@ -138,7 +122,7 @@ Creates a Label from a specified name. [options="header"] |=== |Name |Description |Type -a| `name` a| Label name a| +a| `name` a| Label name a| `string` |=== [caption=""] diff --git a/csharp/docs/session/ITypeDBSession.adoc b/csharp/docs/session/ITypeDBSession.adoc index d35bc7a365..3789595469 100644 --- a/csharp/docs/session/ITypeDBSession.adoc +++ b/csharp/docs/session/ITypeDBSession.adoc @@ -95,7 +95,7 @@ Registers a callback function which will be executed when this session is closed [options="header"] |=== |Name |Description |Type -a| `function` a| The callback function. a| +a| `function` a| The callback function. a| `Action` |=== [caption=""] @@ -128,7 +128,7 @@ Registers a callback function which will be executed when this session is reopen [options="header"] |=== |Name |Description |Type -a| `function` a| The callback function. a| +a| `function` a| The callback function. a| `Action` |=== [caption=""] @@ -209,8 +209,8 @@ Opens a transaction to perform read or write queries on the database connected t [options="header"] |=== |Name |Description |Type -a| `type` a| The type of transaction to be created (Read or Write) a| -a| `options` a| Options for the session a| +a| `type` a| The type of transaction to be created (Read or Write) a| `TransactionType` +a| `options` a| Options for the session a| `TypeDBOptions` |=== [caption=""] diff --git a/csharp/docs/session/TypeDBOptions.adoc b/csharp/docs/session/TypeDBOptions.adoc index e9e73cfc94..ca65f6dd48 100644 --- a/csharp/docs/session/TypeDBOptions.adoc +++ b/csharp/docs/session/TypeDBOptions.adoc @@ -51,7 +51,7 @@ Explicitly enables or disables explanations. If set to ``true``, enables explana [options="header"] |=== |Name |Description |Type -a| `explain` a| Explicitly enable or disable explanations a| +a| `explain` a| Explicitly enable or disable explanations a| `bool` |=== [caption=""] @@ -108,7 +108,7 @@ Explicitly enables or disables inference. Only settable at transaction level and [options="header"] |=== |Name |Description |Type -a| `infer` a| Explicitly enable or disable inference a| +a| `infer` a| Explicitly enable or disable inference a| `bool` |=== [caption=""] @@ -165,7 +165,7 @@ Explicitly enables or disables parallel execution. If set to ``true``, the serve [options="header"] |=== |Name |Description |Type -a| `parallel` a| Explicitly enable or disable parallel execution a| +a| `parallel` a| Explicitly enable or disable parallel execution a| `bool` |=== [caption=""] @@ -222,7 +222,7 @@ Explicitly enables or disables prefetching. If set to ``true``, the first batch [options="header"] |=== |Name |Description |Type -a| `prefetch` a| Explicitly enable or disable prefetching a| +a| `prefetch` a| Explicitly enable or disable prefetching a| `bool` |=== [caption=""] @@ -279,7 +279,7 @@ Explicitly sets a prefetch size. If set, specifies a guideline number of answers [options="header"] |=== |Name |Description |Type -a| `prefetchSize` a| Number of answers that the server should send before the driver issues a fresh request a| +a| `prefetchSize` a| Number of answers that the server should send before the driver issues a fresh request a| `int` |=== [caption=""] @@ -336,7 +336,7 @@ Explicitly enables or disables reading data from any replica. If set to ``True`` [options="header"] |=== |Name |Description |Type -a| `readAnyReplica` a| Explicitly enable or disable reading data from any replica a| +a| `readAnyReplica` a| Explicitly enable or disable reading data from any replica a| `bool` |=== [caption=""] @@ -393,7 +393,7 @@ Explicitly sets schema lock acquire timeout. If set, specifies how long the driv [options="header"] |=== |Name |Description |Type -a| `schemaLockAcquireTimeoutMillis` a| How long the driver should wait if opening a session or transaction is blocked by a schema write lock. a| +a| `schemaLockAcquireTimeoutMillis` a| How long the driver should wait if opening a session or transaction is blocked by a schema write lock. a| `int` |=== [caption=""] @@ -450,7 +450,7 @@ Explicitly sets a session idle timeout. If set, specifies a timeout that allows [options="header"] |=== |Name |Description |Type -a| `sessionIdleTimeoutMillis` a| timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. a| +a| `sessionIdleTimeoutMillis` a| timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. a| `int` |=== [caption=""] @@ -507,7 +507,7 @@ Explicitly enables or disables reasoning tracing. If set to ``true``, reasoning [options="header"] |=== |Name |Description |Type -a| `traceInference` a| Explicitly enable or disable reasoning tracing a| +a| `traceInference` a| Explicitly enable or disable reasoning tracing a| `bool` |=== [caption=""] @@ -564,7 +564,7 @@ Explicitly set a transaction timeout. If set, specifies a timeout for killing tr [options="header"] |=== |Name |Description |Type -a| `transactionTimeoutMillis` a| Timeout for killing transactions automatically. a| +a| `transactionTimeoutMillis` a| Timeout for killing transactions automatically. a| `int` |=== [caption=""] diff --git a/csharp/docs/transaction/IQueryManager.adoc b/csharp/docs/transaction/IQueryManager.adoc index 805019e7b8..b32c1ee99e 100644 --- a/csharp/docs/transaction/IQueryManager.adoc +++ b/csharp/docs/transaction/IQueryManager.adoc @@ -51,8 +51,8 @@ Performs a TypeQL Define query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Define query to be executed a| -a| `options` a| Specify query options a| +a| `query` a| The TypeQL Define query to be executed a| `string` +a| `options` a| Specify query options a| `TypeDBOptions` |=== [caption=""] @@ -109,8 +109,8 @@ Performs a TypeQL Delete query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Delete query to be executed a| -a| `options` a| Specify query options a| +a| `query` a| The TypeQL Delete query to be executed a| `string` +a| `options` a| Specify query options a| `TypeDBOptions` |=== [caption=""] @@ -167,8 +167,8 @@ Performs a TypeQL Explain query in the transaction. [options="header"] |=== |Name |Description |Type -a| `explainable` a| The IExplainable to be explained a| -a| `options` a| Specify query options a| +a| `explainable` a| The IExplainable to be explained a| `IEnumerable< IExplanation > IExplainable` +a| `options` a| Specify query options a| `TypeDBOptions` |=== [caption=""] @@ -225,8 +225,8 @@ Performs a TypeQL Fetch (Fetch) query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Fetch (Fetch) query to be executed a| -a| `options` a| Specify query options a| +a| `query` a| The TypeQL Fetch (Fetch) query to be executed a| `string` +a| `options` a| Specify query options a| `TypeDBOptions` |=== [caption=""] @@ -283,8 +283,8 @@ Performs a TypeQL Get (Get) query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Get (Get) query to be executed a| -a| `options` a| Specify query options a| +a| `query` a| The TypeQL Get (Get) query to be executed a| `string` +a| `options` a| Specify query options a| `TypeDBOptions` |=== [caption=""] @@ -341,8 +341,8 @@ Performs a TypeQL Get Aggregate query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Get Aggregate query to be executed a| -a| `options` a| Specify query options a| +a| `query` a| The TypeQL Get Aggregate query to be executed a| `string` +a| `options` a| Specify query options a| `TypeDBOptions` |=== [caption=""] @@ -399,8 +399,8 @@ Performs a TypeQL Get Group query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Get Group query to be executed a| -a| `options` a| Specify query options a| +a| `query` a| The TypeQL Get Group query to be executed a| `string` +a| `options` a| Specify query options a| `TypeDBOptions` |=== [caption=""] @@ -457,8 +457,8 @@ Performs a TypeQL Get Group Aggregate query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Get Group Aggregate query to be executed a| -a| `options` a| Specify query options a| +a| `query` a| The TypeQL Get Group Aggregate query to be executed a| `string` +a| `options` a| Specify query options a| `TypeDBOptions` |=== [caption=""] @@ -515,8 +515,8 @@ Performs a TypeQL Insert query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Insert query to be executed a| -a| `options` a| Specify query options a| +a| `query` a| The TypeQL Insert query to be executed a| `string` +a| `options` a| Specify query options a| `TypeDBOptions` |=== [caption=""] @@ -573,8 +573,8 @@ Performs a TypeQL Undefine query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Undefine query to be executed a| -a| `options` a| Specify query options a| +a| `query` a| The TypeQL Undefine query to be executed a| `string` +a| `options` a| Specify query options a| `TypeDBOptions` |=== [caption=""] @@ -631,8 +631,8 @@ Performs a TypeQL Update query in the transaction. [options="header"] |=== |Name |Description |Type -a| `query` a| The TypeQL Update query to be executed a| -a| `options` a| Specify query options a| +a| `query` a| The TypeQL Update query to be executed a| `string` +a| `options` a| Specify query options a| `TypeDBOptions` |=== [caption=""] diff --git a/csharp/docs/transaction/ITypeDBTransaction.adoc b/csharp/docs/transaction/ITypeDBTransaction.adoc index 88602059b1..ac19eadc1d 100644 --- a/csharp/docs/transaction/ITypeDBTransaction.adoc +++ b/csharp/docs/transaction/ITypeDBTransaction.adoc @@ -143,7 +143,7 @@ Registers a callback function which will be executed when this transaction is cl [options="header"] |=== |Name |Description |Type -a| `function` a| The callback function. a| +a| `function` a| The callback function. a| `Action< Exception >` |=== [caption=""] diff --git a/tool/docs/c/DoxygenParserC.kt b/tool/docs/c/DoxygenParserC.kt index d50b10ece4..d1509511e2 100644 --- a/tool/docs/c/DoxygenParserC.kt +++ b/tool/docs/c/DoxygenParserC.kt @@ -231,7 +231,7 @@ class DoxygenParserC : Callable { .replace("\\s+".toRegex(), " ") .substringAfter("(").substringBefore(")") .split(",\\s".toRegex()).map { arg -> - arg.split("\u00a0").let { it.last() to it.dropLast(1).joinToString(" ") } + arg.split("\\s".toRegex()).let { it.last() to it.dropLast(1).joinToString(" ") } }.filter { it.first.isNotEmpty() || it.second.isNotEmpty() } .toList() } diff --git a/tool/docs/cpp/DoxygenParserCpp.kt b/tool/docs/cpp/DoxygenParserCpp.kt index 0ccda4dcee..78444fb740 100644 --- a/tool/docs/cpp/DoxygenParserCpp.kt +++ b/tool/docs/cpp/DoxygenParserCpp.kt @@ -293,7 +293,7 @@ class DoxygenParserCpp : Callable { .replace("\\s+".toRegex(), " ") .substringAfter("(").substringBefore(")") .split(",\\s".toRegex()).map { arg -> - arg.split("\u00a0").let { it.last() to it.dropLast(1).joinToString(" ") } + arg.split("\\s".toRegex()).let { it.last() to it.dropLast(1).joinToString(" ") } }.filter { it.first.isNotEmpty() || it.second.isNotEmpty() } .toList() } From 45002bfbc1a2a8da88eda57577e212fea68cc8ae Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 26 Mar 2024 11:46:10 +0000 Subject: [PATCH 048/118] Fix multi-templated arguments --- csharp/docs/answer/Promise__T__.adoc | 2 +- csharp/docs/schema/IThingType.adoc | 14 ++++---- csharp/docs/schema/Label.adoc | 4 +-- tool/docs/c/DoxygenParserC.kt | 2 +- tool/docs/cpp/DoxygenParserCpp.kt | 2 +- tool/docs/csharp/DoxygenParserCsharp.kt | 48 +++++++++++++++++++++---- 6 files changed, 54 insertions(+), 18 deletions(-) diff --git a/csharp/docs/answer/Promise__T__.adoc b/csharp/docs/answer/Promise__T__.adoc index 2999ddb477..27d1acb139 100644 --- a/csharp/docs/answer/Promise__T__.adoc +++ b/csharp/docs/answer/Promise__T__.adoc @@ -30,7 +30,7 @@ Helper function to map promises. |=== |Name |Description |Type a| `resolver` a| The function to wrap into the promise a| `Func< TFrom?>` -a| `selector` a| The mapping (like Select from Linq) function a| `TTo >` +a| `selector` a| The mapping (like Select from Linq) function a| `Func< TFrom, TTo >` |=== [caption=""] diff --git a/csharp/docs/schema/IThingType.adoc b/csharp/docs/schema/IThingType.adoc index b315092e65..ad7f344d69 100644 --- a/csharp/docs/schema/IThingType.adoc +++ b/csharp/docs/schema/IThingType.adoc @@ -112,7 +112,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) @@ -136,7 +136,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) @@ -160,7 +160,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) @@ -184,7 +184,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) @@ -208,7 +208,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) @@ -232,7 +232,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) @@ -256,7 +256,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) diff --git a/csharp/docs/schema/Label.adoc b/csharp/docs/schema/Label.adoc index 5bac5fca9f..4489b567a7 100644 --- a/csharp/docs/schema/Label.adoc +++ b/csharp/docs/schema/Label.adoc @@ -18,7 +18,7 @@ It consists of an optional ``scope``, and a ``name``, represented ``scope:name`` |Name |Type |Description a| `readonly string TypeDB.Driver.Common.Label.Name` a| `readonly string TypeDB.Driver.Common.Label.Name` a| Returns the name of this Label. Examples -[source,java] +[source,cs] ---- label.Name; @@ -26,7 +26,7 @@ label.Name; a| `readonly? string TypeDB.Driver.Common.Label.Scope` a| `readonly? string TypeDB.Driver.Common.Label.Scope` a| Returns the scope of this Label. Examples -[source,java] +[source,cs] ---- label.Scope; diff --git a/tool/docs/c/DoxygenParserC.kt b/tool/docs/c/DoxygenParserC.kt index d1509511e2..2af94b3916 100644 --- a/tool/docs/c/DoxygenParserC.kt +++ b/tool/docs/c/DoxygenParserC.kt @@ -241,7 +241,7 @@ class DoxygenParserC : Callable { } private fun replacePreTags(html: String): String { - return html.replace("
", "[source,java]\n----\n").replace("
", "\n----\n") + return html.replace("
", "[source,c]\n----\n").replace("
", "\n----\n") } private fun enhanceSignature(signature: String): String { diff --git a/tool/docs/cpp/DoxygenParserCpp.kt b/tool/docs/cpp/DoxygenParserCpp.kt index 78444fb740..e465fd23e3 100644 --- a/tool/docs/cpp/DoxygenParserCpp.kt +++ b/tool/docs/cpp/DoxygenParserCpp.kt @@ -303,7 +303,7 @@ class DoxygenParserCpp : Callable { } private fun replacePreTags(html: String): String { - return html.replace("
", "[source,java]\n----\n").replace("
", "\n----\n") + return html.replace("
", "[source,cpp]\n----\n").replace("
", "\n----\n") } private fun enhanceSignature(signature: String): String { diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index 3da1788bf6..29b04ac19f 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -240,7 +240,9 @@ class DoxygenParserCsharp : Callable { val methodName = element.previousElementSibling()!!.text().substringBefore("()").substringAfter(" ") val methodSignature = updateSignature(element.selectFirst("table.memname")!!.text()) val argsList = getArgsFromSignature(methodSignature) + println("RETURN ARGS LIST: " + argsList) val argsMap = argsList.toMap() + println("RETURN ARGS: " + argsMap) val methodReturnType = getReturnTypeFromSignature(methodSignature) val methodDescr: List = element.selectFirst("div.memdoc") ?.let { splitToParagraphs(it.html()) } @@ -281,21 +283,55 @@ class DoxygenParserCsharp : Callable { } private fun getArgsFromSignature(methodSignature: String): List> { - return methodSignature + println("METHOD: " + methodSignature) + + var v = methodSignature .replace("\\s+".toRegex(), " ") .substringAfter("(").substringBefore(")") - .split(",\\s".toRegex()).map { arg -> - arg.split("\u00a0").let { it.last() to it.dropLast(1).joinToString(" ") } - }.filter { it.first.isNotEmpty() || it.second.isNotEmpty() } + .split(",\\s".toRegex()).toMutableList() + + var i = 0 + while (true) { + if (i >= v.lastIndex) { + break + } + + if (v[i].contains("<") && !v[i].contains(">")) { + v[i] = v[i] + ", " + v[i + 1] + v.removeAt(i + 1) + } + else { + ++i + } + } + + return v.map { arg -> + arg.split("\\s".toRegex()).let { it.last() to it.dropLast(1).joinToString(" ") } + }.filter { it.first.isNotEmpty() || it.second.isNotEmpty() } .toList() } private fun reformatTextWithCode(html: String, idToAnchor: Map): String { - return removeAllTags(replaceLocalLinks(idToAnchor, replaceEmTags(replacePreTags(replaceCodeTags(html))))) + return removeAllTags( + replaceLocalLinks( + idToAnchor, + replaceEmTags( + replacePreTags( + replaceCodeTags( + replaceAngleBracketCodes(html) + ) + ) + ) + ) + ) } private fun replacePreTags(html: String): String { - return html.replace("
", "[source,java]\n----\n").replace("
", "\n----\n") + return html.replace("
", "[source,cs]\n----\n").replace("
", "\n----\n") + } + + private fun replaceAngleBracketCodes(html: String): String { + return html.replace("<", "<").replace(">", ">") } private fun updateSignature(signature: String): String { From b50de9beb659dc43926506cd2b6372003ff3c620 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 26 Mar 2024 13:14:47 +0000 Subject: [PATCH 049/118] Fix scary See also --- csharp/Api/Concept/Type/IThingType.cs | 26 +++++----- csharp/Api/Concept/Type/IType.cs | 2 +- csharp/Api/ITypeDBDriver.cs | 2 +- csharp/Common/Promise/Promise.cs | 4 +- csharp/docs/answer/Promise__T__.adoc | 20 ++++---- csharp/docs/connection/ITypeDBDriver.adoc | 2 +- csharp/docs/connection/TypeDB.adoc | 6 +-- csharp/docs/data/ValueTypeExtensions.adoc | 6 +-- csharp/docs/schema/Annotation.adoc | 4 +- csharp/docs/schema/IRelationType.adoc | 4 +- csharp/docs/schema/IRoleType.adoc | 6 +-- csharp/docs/schema/IThingType.adoc | 26 +++++----- csharp/docs/schema/IType.adoc | 2 +- csharp/docs/transaction/IQueryManager.adoc | 22 ++++---- tool/docs/csharp/DoxygenParserCsharp.kt | 59 +++++++++++++++------- 15 files changed, 106 insertions(+), 85 deletions(-) diff --git a/csharp/Api/Concept/Type/IThingType.cs b/csharp/Api/Concept/Type/IThingType.cs index 5e061727e5..4617b495f1 100644 --- a/csharp/Api/Concept/Type/IThingType.cs +++ b/csharp/Api/Concept/Type/IThingType.cs @@ -48,7 +48,7 @@ IThingType IConcept.AsThingType() * Retrieves all IThing objects that are instances of this IThingType or its subtypes. * Equivalent to GetInstances(transaction, Transitive) * - * @see ThingType#GetInstances(ITypeDBTransaction, IConcept.Transitivity) + * @see IThingType#GetInstances(ITypeDBTransaction, IConcept.Transitivity) */ IEnumerable GetInstances(ITypeDBTransaction transaction); @@ -95,7 +95,7 @@ IThingType IConcept.AsThingType() /** * Allows the instances of this IThingType to play the given role. * - * @see ThingType#SetPlays(ITypeDBTransaction, IRoleType, IRoleType) + * @see IThingType#SetPlays(ITypeDBTransaction, IRoleType, IRoleType) */ VoidPromise SetPlays(ITypeDBTransaction transaction, IRoleType roleType); @@ -139,7 +139,7 @@ VoidPromise SetOwns( /** * Allows the instances of this IThingType to own the given IAttributeType, * - * @see ThingType#SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + * @see IThingType#SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) */ VoidPromise SetOwns( ITypeDBTransaction transaction, IAttributeType attributeType, IAttributeType overriddenType); @@ -147,14 +147,14 @@ VoidPromise SetOwns( /** * Allows the instances of this IThingType to own the given IAttributeType. * - * @see ThingType#SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + * @see IThingType#SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) */ VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType, ICollection annotations); /** * Allows the instances of this IThingType to own the given IAttributeType. * - * @see ThingType#SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + * @see IThingType#SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) */ VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType); @@ -162,7 +162,7 @@ VoidPromise SetOwns( * Retrieves all direct and inherited roles that are allowed * to be played by the instances of this IThingType. * - * @see ThingType#GetPlays(ITypeDBTransaction, IConcept.Transitivity) + * @see IThingType#GetPlays(ITypeDBTransaction, IConcept.Transitivity) */ IEnumerable GetPlays(ITypeDBTransaction transaction); @@ -200,7 +200,7 @@ VoidPromise SetOwns( * Retrieves IAttributeType that the instances of this * IThingType are allowed to own directly or via inheritance. * - * @see ThingType#GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + * @see IThingType#GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) */ IEnumerable GetOwns(ITypeDBTransaction transaction); @@ -208,7 +208,7 @@ VoidPromise SetOwns( * Retrieves IAttributeType that the instances of this * IThingType are allowed to own directly or via inheritance. * - * @see ThingType#GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + * @see IThingType#GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) */ IEnumerable GetOwns(ITypeDBTransaction transaction, IValue.ValueType valueType); @@ -216,7 +216,7 @@ VoidPromise SetOwns( * Retrieves IAttributeType that the instances of this * IThingType are allowed to own directly or via inheritance. * - * @see ThingType#GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + * @see IThingType#GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) */ IEnumerable GetOwns(ITypeDBTransaction transaction, ICollection annotations); @@ -224,7 +224,7 @@ VoidPromise SetOwns( * Retrieves IAttributeType that the instances of this * IThingType are allowed to own directly or via inheritance. * - * @see ThingType#GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) + * @see IThingType#GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) */ IEnumerable GetOwns( ITypeDBTransaction transaction, IValue.ValueType? valueType, ICollection annotations); @@ -233,7 +233,7 @@ IEnumerable GetOwns( * Retrieves IAttributeType that the instances of this * IThingType are allowed to own directly or via inheritance. * - * @see ThingType#GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + * @see IThingType#GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) */ IEnumerable GetOwns(ITypeDBTransaction transaction, IConcept.Transitivity transitivity); @@ -241,7 +241,7 @@ IEnumerable GetOwns( * Retrieves IAttributeType that the instances of this * IThingType are allowed to own directly or via inheritance. * - * @see ThingType#GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) + * @see IThingType#GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection<Annotation>, IConcept.Transitivity) */ IEnumerable GetOwns( ITypeDBTransaction transaction, IValue.ValueType? valueType, IConcept.Transitivity transitivity); @@ -250,7 +250,7 @@ IEnumerable GetOwns( * Retrieves IAttributeType that the instances of this * IThingType are allowed to own directly or via inheritance. * - * @see ThingType#GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) + * @see IThingType#GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection<Annotation>, IConcept.Transitivity) */ IEnumerable GetOwns( ITypeDBTransaction transaction, ICollection annotations, IConcept.Transitivity transitivity); diff --git a/csharp/Api/Concept/Type/IType.cs b/csharp/Api/Concept/Type/IType.cs index da1db49b3d..d8827b1180 100644 --- a/csharp/Api/Concept/Type/IType.cs +++ b/csharp/Api/Concept/Type/IType.cs @@ -114,7 +114,7 @@ IType IConcept.AsType() * Retrieves all direct and indirect subtypes of the type. * Equivalent to GetSubtypes(transaction, Transitive) * - * @see Type#GetSubtypes(ITypeDBTransaction, IConcept.Transitivity) + * @see IType#GetSubtypes(ITypeDBTransaction, IConcept.Transitivity) */ IEnumerable GetSubtypes(ITypeDBTransaction transaction); diff --git a/csharp/Api/ITypeDBDriver.cs b/csharp/Api/ITypeDBDriver.cs index a229971032..671c6f0cab 100644 --- a/csharp/Api/ITypeDBDriver.cs +++ b/csharp/Api/ITypeDBDriver.cs @@ -69,7 +69,7 @@ public interface ITypeDBDriver : IDisposable /** * Opens a session to the given database with default options. * - * @see TypeDBDriver#Session(string, SessionType, TypeDBOptions); + * @see ITypeDBDriver#Session(string, SessionType, TypeDBOptions); */ ITypeDBSession Session(string database, SessionType type); diff --git a/csharp/Common/Promise/Promise.cs b/csharp/Common/Promise/Promise.cs index c0eb69081a..1b2157222e 100644 --- a/csharp/Common/Promise/Promise.cs +++ b/csharp/Common/Promise/Promise.cs @@ -38,7 +38,7 @@ public class Promise * *

Examples

* 
-         * new Promise(supplier);
+         * new Promise(resolver);
          *
* * @param resolver The function to wrap into the promise @@ -73,7 +73,7 @@ public Promise(Func resolver) * *

Examples

* 
-         * Promise<TFrom>.Map<TTo, T>(supplier, selector);
+         * Promise<TFrom>.Map<TFrom, TTo>(resolver, selector);
          *
* * @param resolver The function to wrap into the promise diff --git a/csharp/docs/answer/Promise__T__.adoc b/csharp/docs/answer/Promise__T__.adoc index 27d1acb139..f7e865d937 100644 --- a/csharp/docs/answer/Promise__T__.adoc +++ b/csharp/docs/answer/Promise__T__.adoc @@ -15,7 +15,7 @@ The request it represents is performed immediately. The response is only retriev [source,cs] ---- -static Promise< TTo > TypeDB.Driver.Common.Promise< T >.Map< TFrom, TTo >(Func< TFrom?> resolver, Func< TFrom, TTo > selector) +static Promise< TTo > TypeDB.Driver.Common.Promise< T >.Map< TFrom, TTo >(Func< TFrom? > resolver, Func< TFrom, TTo > selector) ---- @@ -29,19 +29,19 @@ Helper function to map promises. [options="header"] |=== |Name |Description |Type -a| `resolver` a| The function to wrap into the promise a| `Func< TFrom?>` +a| `resolver` a| The function to wrap into the promise a| `Func< TFrom? >` a| `selector` a| The mapping (like Select from Linq) function a| `Func< TFrom, TTo >` |=== [caption=""] .Returns -`static Promise< TTo >` +`Promise< TTo >` [caption=""] .Code examples [source,cs] ---- -Promise.Map(supplier, selector); +Promise.Map(resolver, selector); ---- [#_TypeDB_Driver_Common_Promise__T___Promise___Func__T__resolver_] @@ -49,7 +49,7 @@ Promise.Map(supplier, selector); [source,cs] ---- -TypeDB.Driver.Common.Promise< T Promise(Func< T?> resolver) +Promise(Func< T? > resolver) ---- @@ -63,18 +63,18 @@ Promise constructor [options="header"] |=== |Name |Description |Type -a| `resolver` a| The function to wrap into the promise a| `Func< T?>` +a| `resolver` a| The function to wrap into the promise a| `Func< T? >` |=== [caption=""] .Returns -`TypeDB.Driver.Common.Promise< T` +`Promise` [caption=""] .Code examples [source,cs] ---- -new Promise(supplier); +new Promise(resolver); ---- [#_T_TypeDB_Driver_Common_Promise__T___Resolve___] @@ -82,7 +82,7 @@ new Promise(supplier); [source,cs] ---- -T? TypeDB.Driver.Common.Promise< T Resolve() +T? Resolve() ---- @@ -92,7 +92,7 @@ Retrieves the result of the Promise. [caption=""] .Returns -`T? TypeDB.Driver.Common.Promise< T` +`T?` [caption=""] .Code examples diff --git a/csharp/docs/connection/ITypeDBDriver.adoc b/csharp/docs/connection/ITypeDBDriver.adoc index bc32bf0938..0474ebe199 100644 --- a/csharp/docs/connection/ITypeDBDriver.adoc +++ b/csharp/docs/connection/ITypeDBDriver.adoc @@ -116,7 +116,7 @@ Opens a session to the given database with default options. See also - TypeDBDriver::Session(string, SessionType, TypeDBOptions); + ITypeDBDriver::Session(string, SessionType, TypeDBOptions); diff --git a/csharp/docs/connection/TypeDB.adoc b/csharp/docs/connection/TypeDB.adoc index fb85bdb206..afeccdd6c8 100644 --- a/csharp/docs/connection/TypeDB.adoc +++ b/csharp/docs/connection/TypeDB.adoc @@ -29,7 +29,7 @@ a| `credential` a| The credential to connect with a| `TypeDBCredential` [caption=""] .Returns -`static ITypeDBDriver` +`ITypeDBDriver` [caption=""] .Code examples @@ -63,7 +63,7 @@ a| `credential` a| The credential to connect with a| `TypeDBCredential` [caption=""] .Returns -`static ITypeDBDriver` +`ITypeDBDriver` [caption=""] .Code examples @@ -96,7 +96,7 @@ a| `address` a| The address of the TypeDB server a| `string` [caption=""] .Returns -`static ITypeDBDriver` +`ITypeDBDriver` [caption=""] .Code examples diff --git a/csharp/docs/data/ValueTypeExtensions.adoc b/csharp/docs/data/ValueTypeExtensions.adoc index 56a050af17..e497d3bdbe 100644 --- a/csharp/docs/data/ValueTypeExtensions.adoc +++ b/csharp/docs/data/ValueTypeExtensions.adoc @@ -23,7 +23,7 @@ Returns a ``System.Type`` equivalent of this value concept for this programming [caption=""] .Returns -`static System.Type` +`System.Type` [caption=""] .Code examples @@ -47,7 +47,7 @@ Returns ``true`` if this value concept can be used as a key via the @key annotat [caption=""] .Returns -`static bool` +`bool` [caption=""] .Code examples @@ -71,7 +71,7 @@ Returns ``true`` if this value concept can be written to a database. Otherwise, [caption=""] .Returns -`static bool` +`bool` [caption=""] .Code examples diff --git a/csharp/docs/schema/Annotation.adoc b/csharp/docs/schema/Annotation.adoc index 38197fe5ba..2ca14547f6 100644 --- a/csharp/docs/schema/Annotation.adoc +++ b/csharp/docs/schema/Annotation.adoc @@ -104,7 +104,7 @@ Produces a ``@key`` annotation. [caption=""] .Returns -`static Annotation` +`Annotation` [caption=""] .Code examples @@ -129,7 +129,7 @@ Produces a ``@unique`` annotation. [caption=""] .Returns -`static Annotation` +`Annotation` [caption=""] .Code examples diff --git a/csharp/docs/schema/IRelationType.adoc b/csharp/docs/schema/IRelationType.adoc index 9db3eec329..440e4043c5 100644 --- a/csharp/docs/schema/IRelationType.adoc +++ b/csharp/docs/schema/IRelationType.adoc @@ -183,7 +183,7 @@ Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label`` See also - <<#_Promise__IRoleType___TypeDB_Driver_Api_IRelationType_GetRelatesOverridden___ITypeDBTransaction_transaction__string_roleLabel_,IRelationType::GetRelatesOverridden(ITypeDBTransaction, string)>> + IRelationType::GetRelatesOverridden(ITypeDBTransaction, string) @@ -387,7 +387,7 @@ Disallows this ``IRelationType`` from relating to the given role. See also - <<#_VoidPromise_TypeDB_Driver_Api_IRelationType_UnsetRelates___ITypeDBTransaction_transaction__string_roleLabel_,IRelationType::UnsetRelates(ITypeDBTransaction, string)>> + IRelationType::UnsetRelates(ITypeDBTransaction, string) diff --git a/csharp/docs/schema/IRoleType.adoc b/csharp/docs/schema/IRoleType.adoc index 93f15c96ba..e1c5a94317 100644 --- a/csharp/docs/schema/IRoleType.adoc +++ b/csharp/docs/schema/IRoleType.adoc @@ -57,7 +57,7 @@ Retrieves the ``Thing`` instances that play this role. See also - <<#_IEnumerable__IThing___TypeDB_Driver_Api_IRoleType_GetPlayerInstances___ITypeDBTransaction_transaction_,IRoleType::GetPlayerInstances>>(ITypeDBTransaction, IConcept.Transitivity) + IRoleType::GetPlayerInstances(ITypeDBTransaction, IConcept.Transitivity) @@ -115,7 +115,7 @@ Retrieves the ``ThingType``s whose instances play this role. Equivalent to ``Get See also - <<#_IEnumerable__IThingType___TypeDB_Driver_Api_IRoleType_GetPlayerTypes___ITypeDBTransaction_transaction_,IRoleType::GetPlayerTypes>>(ITypeDBTransaction, IConcept.Transitivity) + IRoleType::GetPlayerTypes(ITypeDBTransaction, IConcept.Transitivity) @@ -173,7 +173,7 @@ Retrieves the ``Relation`` instances that this role is related to. Equivalent to See also - <<#_IEnumerable__IRelation___TypeDB_Driver_Api_IRoleType_GetRelationInstances___ITypeDBTransaction_transaction_,IRoleType::GetRelationInstances>>(ITypeDBTransaction, IConcept.Transitivity) + IRoleType::GetRelationInstances(ITypeDBTransaction, IConcept.Transitivity) diff --git a/csharp/docs/schema/IThingType.adoc b/csharp/docs/schema/IThingType.adoc index ad7f344d69..f84c9912d0 100644 --- a/csharp/docs/schema/IThingType.adoc +++ b/csharp/docs/schema/IThingType.adoc @@ -53,7 +53,7 @@ Retrieves all ``IThing`` objects that are instances of this ``IThingType`` or it See also - ThingType::GetInstances(ITypeDBTransaction, IConcept.Transitivity) + IThingType::GetInstances(ITypeDBTransaction, IConcept.Transitivity) @@ -112,7 +112,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) + IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) @@ -136,7 +136,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) + IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) @@ -160,7 +160,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) + IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) @@ -184,7 +184,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) + IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) @@ -208,7 +208,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) + IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) @@ -232,7 +232,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) + IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) @@ -256,7 +256,7 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow See also - ThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) + IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) @@ -351,7 +351,7 @@ Retrieves all direct and inherited roles that are allowed to be played by the in See also - ThingType::GetPlays(ITypeDBTransaction, IConcept.Transitivity) + IThingType::GetPlays(ITypeDBTransaction, IConcept.Transitivity) @@ -575,7 +575,7 @@ Allows the instances of this ``IThingType`` to own the given ``IAttributeType``, See also - ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) @@ -599,7 +599,7 @@ Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. See also - ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) @@ -623,7 +623,7 @@ Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. See also - ThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) + IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) @@ -647,7 +647,7 @@ Allows the instances of this ``IThingType`` to play the given role. See also - ThingType::SetPlays(ITypeDBTransaction, IRoleType, IRoleType) + IThingType::SetPlays(ITypeDBTransaction, IRoleType, IRoleType) diff --git a/csharp/docs/schema/IType.adoc b/csharp/docs/schema/IType.adoc index f03fab4381..d3efc6fc6b 100644 --- a/csharp/docs/schema/IType.adoc +++ b/csharp/docs/schema/IType.adoc @@ -85,7 +85,7 @@ Retrieves all direct and indirect subtypes of the type. Equivalent to ``GetSubty See also - Type::GetSubtypes(ITypeDBTransaction, IConcept.Transitivity) + IType::GetSubtypes(ITypeDBTransaction, IConcept.Transitivity) diff --git a/csharp/docs/transaction/IQueryManager.adoc b/csharp/docs/transaction/IQueryManager.adoc index b32c1ee99e..96c284dbf2 100644 --- a/csharp/docs/transaction/IQueryManager.adoc +++ b/csharp/docs/transaction/IQueryManager.adoc @@ -24,7 +24,7 @@ Performs a TypeQL Define query with default options. See also - <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Define___string_query__TypeDBOptions_options_,IQueryManager::Define(string, TypeDBOptions)>> + IQueryManager::Define(string, TypeDBOptions) @@ -82,7 +82,7 @@ Performs a TypeQL Delete query with default options. See also - <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Delete___string_query__TypeDBOptions_options_,IQueryManager::Delete(string, TypeDBOptions)>> + IQueryManager::Delete(string, TypeDBOptions) @@ -140,7 +140,7 @@ Performs a TypeQL Explain query with default options. See also - <<#_IEnumerable__IExplanation___TypeDB_Driver_Api_IQueryManager_Explain___IConceptMap_IExplainable_explainable_,IQueryManager::Explain>>(IConceptMap.IExplainable, TypeDBOptions) + IQueryManager::Explain(IConceptMap.IExplainable, TypeDBOptions) @@ -198,7 +198,7 @@ Performs a TypeQL Fetch (Fetch) with default options. See also - <<#_IEnumerable__JObject___TypeDB_Driver_Api_IQueryManager_Fetch___string_query__TypeDBOptions_options_,IQueryManager::Fetch(string, TypeDBOptions)>> + IQueryManager::Fetch(string, TypeDBOptions) @@ -256,7 +256,7 @@ Performs a TypeQL Get (Get) with default options. See also - <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Get___string_query__TypeDBOptions_options_,IQueryManager::Get(string, TypeDBOptions)>> + IQueryManager::Get(string, TypeDBOptions) @@ -314,7 +314,7 @@ Performs a TypeQL Get Aggregate query with default options. See also - <<#_Promise__IValue___TypeDB_Driver_Api_IQueryManager_GetAggregate___string_query__TypeDBOptions_options_,IQueryManager::GetAggregate(string, TypeDBOptions)>> + IQueryManager::GetAggregate(string, TypeDBOptions) @@ -372,7 +372,7 @@ Performs a TypeQL Get Group query with default options. See also - <<#_IEnumerable__IConceptMapGroup___TypeDB_Driver_Api_IQueryManager_GetGroup___string_query__TypeDBOptions_options_,IQueryManager::GetGroup(string, TypeDBOptions)>> + IQueryManager::GetGroup(string, TypeDBOptions) @@ -430,7 +430,7 @@ Performs a TypeQL Get Group Aggregate query with default options. See also - <<#_IEnumerable__IValueGroup___TypeDB_Driver_Api_IQueryManager_GetGroupAggregate___string_query__TypeDBOptions_options_,IQueryManager::GetGroupAggregate(string, TypeDBOptions)>> + IQueryManager::GetGroupAggregate(string, TypeDBOptions) @@ -488,7 +488,7 @@ Performs a TypeQL Insert query with default options. See also - <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Insert___string_query__TypeDBOptions_options_,IQueryManager::Insert(string, TypeDBOptions)>> + IQueryManager::Insert(string, TypeDBOptions) @@ -546,7 +546,7 @@ Performs a TypeQL Undefine query with default options. See also - <<#_VoidPromise_TypeDB_Driver_Api_IQueryManager_Undefine___string_query__TypeDBOptions_options_,IQueryManager::Undefine(string, TypeDBOptions)>> + IQueryManager::Undefine(string, TypeDBOptions) @@ -604,7 +604,7 @@ Performs a TypeQL Update query with default options. See also - <<#_IEnumerable__IConceptMap___TypeDB_Driver_Api_IQueryManager_Update___string_query__TypeDBOptions_options_,IQueryManager::Update(string, TypeDBOptions)>> + IQueryManager::Update(string, TypeDBOptions) diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index 29b04ac19f..107796efa9 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -240,9 +240,7 @@ class DoxygenParserCsharp : Callable { val methodName = element.previousElementSibling()!!.text().substringBefore("()").substringAfter(" ") val methodSignature = updateSignature(element.selectFirst("table.memname")!!.text()) val argsList = getArgsFromSignature(methodSignature) - println("RETURN ARGS LIST: " + argsList) val argsMap = argsList.toMap() - println("RETURN ARGS: " + argsMap) val methodReturnType = getReturnTypeFromSignature(methodSignature) val methodDescr: List = element.selectFirst("div.memdoc") ?.let { splitToParagraphs(it.html()) } @@ -260,6 +258,7 @@ class DoxygenParserCsharp : Callable { ) } + println("METHOD: " + methodDescr) return Method( name = methodName, signature = methodSignature, @@ -283,42 +282,42 @@ class DoxygenParserCsharp : Callable { } private fun getArgsFromSignature(methodSignature: String): List> { - println("METHOD: " + methodSignature) - - var v = methodSignature + var splittedArgsAndTypes = methodSignature .replace("\\s+".toRegex(), " ") .substringAfter("(").substringBefore(")") .split(",\\s".toRegex()).toMutableList() var i = 0 while (true) { - if (i >= v.lastIndex) { + if (i >= splittedArgsAndTypes.lastIndex) { break } - if (v[i].contains("<") && !v[i].contains(">")) { - v[i] = v[i] + ", " + v[i + 1] - v.removeAt(i + 1) + if (splittedArgsAndTypes[i].contains("<") && !splittedArgsAndTypes[i].contains(">")) { + splittedArgsAndTypes[i] = splittedArgsAndTypes[i] + ", " + splittedArgsAndTypes[i + 1] + splittedArgsAndTypes.removeAt(i + 1) } else { ++i } } - return v.map { arg -> + return splittedArgsAndTypes.map { arg -> arg.split("\\s".toRegex()).let { it.last() to it.dropLast(1).joinToString(" ") } }.filter { it.first.isNotEmpty() || it.second.isNotEmpty() } .toList() } private fun reformatTextWithCode(html: String, idToAnchor: Map): String { - return removeAllTags( - replaceLocalLinks( - idToAnchor, - replaceEmTags( - replacePreTags( - replaceCodeTags( - replaceAngleBracketCodes(html) + return replaceAngleBracketCodes( + removeHyperlinkFormatting( + removeAllTags( + replaceLocalLinks( + idToAnchor, + replaceEmTags( + replacePreTags( + replaceCodeTags(html) + ) ) ) ) @@ -326,6 +325,22 @@ class DoxygenParserCsharp : Callable { ) } + private fun removeHyperlinkFormatting(html: String): String { + var updatedHtml = html + + val regex = Regex("<<#_[a-zA-Z_]+,.*>>") + regex.findAll(html).map{ it.value }.forEach{ + val newValue = it + .substringAfter("<<#_") + .substringBeforeLast(">>") + .split(",") + .let { it.drop(1).joinToString(",") } + updatedHtml = updatedHtml.replace(it, newValue) + } + + return updatedHtml + } + private fun replacePreTags(html: String): String { return html.replace("
", "[source,cs]\n----\n").replace("
", "\n----\n") } @@ -336,7 +351,10 @@ class DoxygenParserCsharp : Callable { private fun updateSignature(signature: String): String { var enhanced = replaceSpaces(signature) - enhanced = enhanced.replace("( ", "(") + enhanced = enhanced + .replace("( ", "(") + .replace("< ", "<") + .replace(" >", ">") enhanced = Regex("\\s([()*&])").replace(enhanced, "$1") var splitted = enhanced.split(" ").toMutableList() val methodNameIndex = splitted.indexOfFirst { it.contains('(') } @@ -344,10 +362,13 @@ class DoxygenParserCsharp : Callable { splitted[methodNameIndex] = splitted[methodNameIndex].substringAfterLast(".") } return splitted.joinToString(separator = " ") + .replace("<", "< ") + .replace(">", " >") } private fun getReturnTypeFromSignature(signature: String): String { - return signature.replace(", ", ",").replace("< ", "<").replace(" >", ">") + return signature.replace("static ", "") + .replace(", ", ",").replace("< ", "<").replace(" >", ">") .substringBefore("(").substringBeforeLast(" ") .replace(",", ", ").replace("<", "< ").replace(">", " >") } From b13fa960456db74ed4fba08b50c40edd0665968d Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 26 Mar 2024 13:57:18 +0000 Subject: [PATCH 050/118] Format See also --- csharp/docs/answer/VoidPromise.adoc | 7 +- csharp/docs/connection/ITypeDBDriver.adoc | 7 +- csharp/docs/schema/IRelationType.adoc | 35 ++++++--- csharp/docs/schema/IRoleType.adoc | 21 +++-- csharp/docs/schema/IThingType.adoc | 91 +++++++++++++++------- csharp/docs/schema/IType.adoc | 7 +- csharp/docs/session/ITypeDBSession.adoc | 7 +- csharp/docs/transaction/IQueryManager.adoc | 77 ++++++++++++------ tool/docs/csharp/DoxygenParserCsharp.kt | 41 ++++++++-- 9 files changed, 213 insertions(+), 80 deletions(-) diff --git a/csharp/docs/answer/VoidPromise.adoc b/csharp/docs/answer/VoidPromise.adoc index 10de5b486a..8e805e2fc9 100644 --- a/csharp/docs/answer/VoidPromise.adoc +++ b/csharp/docs/answer/VoidPromise.adoc @@ -8,11 +8,14 @@ A ``VoidPromise`` represents a ``Promise`` without an operation's result. - See also + +See also +[source,cs] +---- Promise - +---- // tag::methods[] diff --git a/csharp/docs/connection/ITypeDBDriver.adoc b/csharp/docs/connection/ITypeDBDriver.adoc index 0474ebe199..ceca681b85 100644 --- a/csharp/docs/connection/ITypeDBDriver.adoc +++ b/csharp/docs/connection/ITypeDBDriver.adoc @@ -113,11 +113,14 @@ ITypeDBSession Session(string database, SessionType type) Opens a session to the given database with default options. - See also + +See also +[source,cs] +---- ITypeDBDriver::Session(string, SessionType, TypeDBOptions); - +---- [caption=""] diff --git a/csharp/docs/schema/IRelationType.adoc b/csharp/docs/schema/IRelationType.adoc index 440e4043c5..4ce1ff73fc 100644 --- a/csharp/docs/schema/IRelationType.adoc +++ b/csharp/docs/schema/IRelationType.adoc @@ -88,11 +88,14 @@ IEnumerable< IRoleType > GetRelates(ITypeDBTransaction transaction) Retrieves roles that this ``IRelationType`` relates to directly or via inheritance. - See also + +See also +[source,cs] +---- IRelationType::getRelates(ITypeDBTransaction, IConcept.Transitivity) - +---- [caption=""] @@ -180,11 +183,14 @@ Promise< IRoleType > GetRelatesOverridden(ITypeDBTransaction transaction, IRoleT Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label``. - See also + +See also +[source,cs] +---- IRelationType::GetRelatesOverridden(ITypeDBTransaction, string) - +---- [caption=""] @@ -266,11 +272,14 @@ VoidPromise SetRelates(ITypeDBTransaction transaction, string roleLabel) Sets the new role that this ``IRelationType`` relates to. - See also + +See also +[source,cs] +---- IRelationType::SetRelates(ITypeDBTransaction, string, string) - +---- [caption=""] @@ -290,11 +299,14 @@ VoidPromise SetRelates(ITypeDBTransaction transaction, string roleLabel, IRoleTy Sets the new role that this ``IRelationType`` relates to. - See also + +See also +[source,cs] +---- IRelationType::SetRelates(ITypeDBTransaction, string, string) - +---- [caption=""] @@ -384,11 +396,14 @@ VoidPromise UnsetRelates(ITypeDBTransaction transaction, IRoleType roleType) Disallows this ``IRelationType`` from relating to the given role. - See also + +See also +[source,cs] +---- IRelationType::UnsetRelates(ITypeDBTransaction, string) - +---- [caption=""] diff --git a/csharp/docs/schema/IRoleType.adoc b/csharp/docs/schema/IRoleType.adoc index e1c5a94317..a7d5da4673 100644 --- a/csharp/docs/schema/IRoleType.adoc +++ b/csharp/docs/schema/IRoleType.adoc @@ -54,11 +54,14 @@ IEnumerable< IThing > GetPlayerInstances(ITypeDBTransaction transaction) Retrieves the ``Thing`` instances that play this role. - See also + +See also +[source,cs] +---- IRoleType::GetPlayerInstances(ITypeDBTransaction, IConcept.Transitivity) - +---- [caption=""] @@ -112,11 +115,14 @@ IEnumerable< IThingType > GetPlayerTypes(ITypeDBTransaction transaction) Retrieves the ``ThingType``s whose instances play this role. Equivalent to ``GetPlayerTypes(transaction, Transitive)``. - See also + +See also +[source,cs] +---- IRoleType::GetPlayerTypes(ITypeDBTransaction, IConcept.Transitivity) - +---- [caption=""] @@ -170,11 +176,14 @@ IEnumerable< IRelation > GetRelationInstances(ITypeDBTransaction transaction) Retrieves the ``Relation`` instances that this role is related to. Equivalent to ``GetRelationInstances(transaction, Transitive)`` - See also + +See also +[source,cs] +---- IRoleType::GetRelationInstances(ITypeDBTransaction, IConcept.Transitivity) - +---- [caption=""] diff --git a/csharp/docs/schema/IThingType.adoc b/csharp/docs/schema/IThingType.adoc index f84c9912d0..8629c80224 100644 --- a/csharp/docs/schema/IThingType.adoc +++ b/csharp/docs/schema/IThingType.adoc @@ -50,11 +50,14 @@ IEnumerable< IThing > GetInstances(ITypeDBTransaction transaction) Retrieves all ``IThing`` objects that are instances of this ``IThingType`` or its subtypes. Equivalent to ``GetInstances(transaction, Transitive)`` - See also + +See also +[source,cs] +---- IThingType::GetInstances(ITypeDBTransaction, IConcept.Transitivity) - +---- [caption=""] @@ -109,11 +112,14 @@ IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction) Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - See also + +See also +[source,cs] +---- IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) - +---- [caption=""] @@ -133,11 +139,14 @@ IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IValue.Val Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - See also + +See also +[source,cs] +---- IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) - +---- [caption=""] @@ -157,11 +166,14 @@ IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, ICollectio Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - See also + +See also +[source,cs] +---- IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) - +---- [caption=""] @@ -181,11 +193,14 @@ IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IValue.Val Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - See also + +See also +[source,cs] +---- IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) - +---- [caption=""] @@ -205,11 +220,14 @@ IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IConcept.T Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - See also + +See also +[source,cs] +---- IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) - +---- [caption=""] @@ -229,11 +247,14 @@ IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, IValue.Val Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - See also + +See also +[source,cs] +---- IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) - +---- [caption=""] @@ -253,11 +274,14 @@ IEnumerable< IAttributeType > GetOwns(ITypeDBTransaction transaction, ICollectio Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allowed to own directly or via inheritance. - See also + +See also +[source,cs] +---- IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) - +---- [caption=""] @@ -348,11 +372,14 @@ IEnumerable< IRoleType > GetPlays(ITypeDBTransaction transaction) Retrieves all direct and inherited roles that are allowed to be played by the instances of this ``IThingType``. - See also + +See also +[source,cs] +---- IThingType::GetPlays(ITypeDBTransaction, IConcept.Transitivity) - +---- [caption=""] @@ -572,11 +599,14 @@ VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType Allows the instances of this ``IThingType`` to own the given ``IAttributeType``, - See also + +See also +[source,cs] +---- IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) - +---- [caption=""] @@ -596,11 +626,14 @@ VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. - See also + +See also +[source,cs] +---- IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) - +---- [caption=""] @@ -620,11 +653,14 @@ VoidPromise SetOwns(ITypeDBTransaction transaction, IAttributeType attributeType Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. - See also + +See also +[source,cs] +---- IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) - +---- [caption=""] @@ -644,11 +680,14 @@ VoidPromise SetPlays(ITypeDBTransaction transaction, IRoleType roleType) Allows the instances of this ``IThingType`` to play the given role. - See also + +See also +[source,cs] +---- IThingType::SetPlays(ITypeDBTransaction, IRoleType, IRoleType) - +---- [caption=""] diff --git a/csharp/docs/schema/IType.adoc b/csharp/docs/schema/IType.adoc index d3efc6fc6b..8cc587883d 100644 --- a/csharp/docs/schema/IType.adoc +++ b/csharp/docs/schema/IType.adoc @@ -82,11 +82,14 @@ IEnumerable< IType > GetSubtypes(ITypeDBTransaction transaction) Retrieves all direct and indirect subtypes of the type. Equivalent to ``GetSubtypes(transaction, Transitive)`` - See also + +See also +[source,cs] +---- IType::GetSubtypes(ITypeDBTransaction, IConcept.Transitivity) - +---- [caption=""] diff --git a/csharp/docs/session/ITypeDBSession.adoc b/csharp/docs/session/ITypeDBSession.adoc index 3789595469..28882a3054 100644 --- a/csharp/docs/session/ITypeDBSession.adoc +++ b/csharp/docs/session/ITypeDBSession.adoc @@ -179,11 +179,14 @@ ITypeDBTransaction Transaction(TransactionType type) Opens a transaction on the database connected to the session with default options. - See also + +See also +[source,cs] +---- ITypeDBSession::Transaction(TransactionType, TypeDBOptions) - +---- [caption=""] diff --git a/csharp/docs/transaction/IQueryManager.adoc b/csharp/docs/transaction/IQueryManager.adoc index 96c284dbf2..69c4dd4868 100644 --- a/csharp/docs/transaction/IQueryManager.adoc +++ b/csharp/docs/transaction/IQueryManager.adoc @@ -21,11 +21,14 @@ VoidPromise Define(string query) Performs a TypeQL Define query with default options. - See also + +See also +[source,cs] +---- IQueryManager::Define(string, TypeDBOptions) - +---- [caption=""] @@ -79,11 +82,14 @@ VoidPromise Delete(string query) Performs a TypeQL Delete query with default options. - See also + +See also +[source,cs] +---- IQueryManager::Delete(string, TypeDBOptions) - +---- [caption=""] @@ -137,11 +143,14 @@ IEnumerable< IExplanation > IExplainable explainable) Performs a TypeQL Explain query with default options. - See also + +See also +[source,cs] +---- IQueryManager::Explain(IConceptMap.IExplainable, TypeDBOptions) - +---- [caption=""] @@ -195,11 +204,14 @@ IEnumerable< JObject > Fetch(string query) Performs a TypeQL Fetch (Fetch) with default options. - See also + +See also +[source,cs] +---- IQueryManager::Fetch(string, TypeDBOptions) - +---- [caption=""] @@ -253,11 +265,14 @@ IEnumerable< IConceptMap > Get(string query) Performs a TypeQL Get (Get) with default options. - See also + +See also +[source,cs] +---- IQueryManager::Get(string, TypeDBOptions) - +---- [caption=""] @@ -311,11 +326,14 @@ Promise< IValue > GetAggregate(string query) Performs a TypeQL Get Aggregate query with default options. - See also + +See also +[source,cs] +---- IQueryManager::GetAggregate(string, TypeDBOptions) - +---- [caption=""] @@ -369,11 +387,14 @@ IEnumerable< IConceptMapGroup > GetGroup(string query) Performs a TypeQL Get Group query with default options. - See also + +See also +[source,cs] +---- IQueryManager::GetGroup(string, TypeDBOptions) - +---- [caption=""] @@ -427,11 +448,14 @@ IEnumerable< IValueGroup > GetGroupAggregate(string query) Performs a TypeQL Get Group Aggregate query with default options. - See also + +See also +[source,cs] +---- IQueryManager::GetGroupAggregate(string, TypeDBOptions) - +---- [caption=""] @@ -485,11 +509,14 @@ IEnumerable< IConceptMap > Insert(string query) Performs a TypeQL Insert query with default options. - See also + +See also +[source,cs] +---- IQueryManager::Insert(string, TypeDBOptions) - +---- [caption=""] @@ -543,11 +570,14 @@ VoidPromise Undefine(string query) Performs a TypeQL Undefine query with default options. - See also + +See also +[source,cs] +---- IQueryManager::Undefine(string, TypeDBOptions) - +---- [caption=""] @@ -601,11 +631,14 @@ IEnumerable< IConceptMap > Update(string query) Performs a TypeQL Update query with default options. - See also + +See also +[source,cs] +---- IQueryManager::Update(string, TypeDBOptions) - +---- [caption=""] diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index 107796efa9..aa04c11e71 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -309,14 +309,16 @@ class DoxygenParserCsharp : Callable { } private fun reformatTextWithCode(html: String, idToAnchor: Map): String { - return replaceAngleBracketCodes( - removeHyperlinkFormatting( - removeAllTags( - replaceLocalLinks( - idToAnchor, - replaceEmTags( - replacePreTags( - replaceCodeTags(html) + return formatSeeAlso( + replaceAngleBracketCodes( + removeHyperlinkFormatting( + removeAllTags( + replaceLocalLinks( + idToAnchor, + replaceEmTags( + replacePreTags( + replaceCodeTags(html) + ) ) ) ) @@ -325,6 +327,29 @@ class DoxygenParserCsharp : Callable { ) } + private fun formatSeeAlso(html: String): String { + val oldSeeAlso = " See also" + + var updatedHtml = html + var seeAlsoIndex = -1 + + while (true) { + seeAlsoIndex = updatedHtml.indexOf(oldSeeAlso, seeAlsoIndex + 1) + if (seeAlsoIndex == -1) { + break + } + + val seeTargetEnd = Regex("([^\\s])+\n").find(updatedHtml, seeAlsoIndex + oldSeeAlso.length) + val seeTargetEndIndex = seeTargetEnd?.range?.endInclusive + if (seeTargetEndIndex != null ) { + updatedHtml = StringBuilder(updatedHtml).apply { insert(seeTargetEndIndex + 1, "----") }.toString() + seeAlsoIndex = seeTargetEndIndex + "----".length + } + } + + return updatedHtml.replace(oldSeeAlso, "\nSee also\n[source,cs]\n----") + } + private fun removeHyperlinkFormatting(html: String): String { var updatedHtml = html From 5fa052a365220040db84c05ea4e69fbd57d66b11 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 26 Mar 2024 14:43:07 +0000 Subject: [PATCH 051/118] Fix indentation for See also targets --- csharp/Api/TypeDBCredential.cs | 2 +- csharp/docs/answer/VoidPromise.adoc | 2 +- csharp/docs/connection/ITypeDBDriver.adoc | 2 +- csharp/docs/connection/TypeDBCredential.adoc | 2 +- csharp/docs/schema/IRelationType.adoc | 10 ++++---- csharp/docs/schema/IRoleType.adoc | 6 ++--- csharp/docs/schema/IThingType.adoc | 26 ++++++++++---------- csharp/docs/schema/IType.adoc | 2 +- csharp/docs/session/ITypeDBSession.adoc | 2 +- csharp/docs/transaction/IQueryManager.adoc | 22 ++++++++--------- tool/docs/csharp/DoxygenParserCsharp.kt | 11 ++++++--- 11 files changed, 46 insertions(+), 41 deletions(-) diff --git a/csharp/Api/TypeDBCredential.cs b/csharp/Api/TypeDBCredential.cs index b77531e920..8185dec629 100644 --- a/csharp/Api/TypeDBCredential.cs +++ b/csharp/Api/TypeDBCredential.cs @@ -34,7 +34,7 @@ namespace TypeDB.Driver.Api * TypeDBCredential credential = new TypeDBCredential(username, password, true); * * // Creates a credential as above, but TLS will use the specified CA to authenticate server certificates. - * TypeDBCredential credential = new TypeDBCredential(username, password, Path.of("path/to/ca-certificate.pem")); + * TypeDBCredential credential = new TypeDBCredential(username, password, Environment.GetEnvironmentVariable("ROOT_CA")!); * */ public class TypeDBCredential : NativeObjectWrapper diff --git a/csharp/docs/answer/VoidPromise.adoc b/csharp/docs/answer/VoidPromise.adoc index 8e805e2fc9..578363e196 100644 --- a/csharp/docs/answer/VoidPromise.adoc +++ b/csharp/docs/answer/VoidPromise.adoc @@ -14,7 +14,7 @@ See also ---- - Promise +Promise ---- diff --git a/csharp/docs/connection/ITypeDBDriver.adoc b/csharp/docs/connection/ITypeDBDriver.adoc index ceca681b85..73b64a2f3f 100644 --- a/csharp/docs/connection/ITypeDBDriver.adoc +++ b/csharp/docs/connection/ITypeDBDriver.adoc @@ -119,7 +119,7 @@ See also ---- - ITypeDBDriver::Session(string, SessionType, TypeDBOptions); +ITypeDBDriver::Session(string, SessionType, TypeDBOptions); ---- diff --git a/csharp/docs/connection/TypeDBCredential.adoc b/csharp/docs/connection/TypeDBCredential.adoc index 2be95cb55e..df0cb91235 100644 --- a/csharp/docs/connection/TypeDBCredential.adoc +++ b/csharp/docs/connection/TypeDBCredential.adoc @@ -16,7 +16,7 @@ User credentials and TLS encryption settings for connecting to TypeDB Cloud. TypeDBCredential credential = new TypeDBCredential(username, password, true); // Creates a credential as above, but TLS will use the specified CA to authenticate server certificates. -TypeDBCredential credential = new TypeDBCredential(username, password, Path.of("path/to/ca-certificate.pem")); +TypeDBCredential credential = new TypeDBCredential(username, password, Environment.GetEnvironmentVariable("ROOT_CA")!); ---- // tag::methods[] diff --git a/csharp/docs/schema/IRelationType.adoc b/csharp/docs/schema/IRelationType.adoc index 4ce1ff73fc..0519beec18 100644 --- a/csharp/docs/schema/IRelationType.adoc +++ b/csharp/docs/schema/IRelationType.adoc @@ -94,7 +94,7 @@ See also ---- - IRelationType::getRelates(ITypeDBTransaction, IConcept.Transitivity) +IRelationType::getRelates(ITypeDBTransaction, IConcept.Transitivity) ---- @@ -189,7 +189,7 @@ See also ---- - IRelationType::GetRelatesOverridden(ITypeDBTransaction, string) +IRelationType::GetRelatesOverridden(ITypeDBTransaction, string) ---- @@ -278,7 +278,7 @@ See also ---- - IRelationType::SetRelates(ITypeDBTransaction, string, string) +IRelationType::SetRelates(ITypeDBTransaction, string, string) ---- @@ -305,7 +305,7 @@ See also ---- - IRelationType::SetRelates(ITypeDBTransaction, string, string) +IRelationType::SetRelates(ITypeDBTransaction, string, string) ---- @@ -402,7 +402,7 @@ See also ---- - IRelationType::UnsetRelates(ITypeDBTransaction, string) +IRelationType::UnsetRelates(ITypeDBTransaction, string) ---- diff --git a/csharp/docs/schema/IRoleType.adoc b/csharp/docs/schema/IRoleType.adoc index a7d5da4673..cfaaac4f48 100644 --- a/csharp/docs/schema/IRoleType.adoc +++ b/csharp/docs/schema/IRoleType.adoc @@ -60,7 +60,7 @@ See also ---- - IRoleType::GetPlayerInstances(ITypeDBTransaction, IConcept.Transitivity) +IRoleType::GetPlayerInstances(ITypeDBTransaction, IConcept.Transitivity) ---- @@ -121,7 +121,7 @@ See also ---- - IRoleType::GetPlayerTypes(ITypeDBTransaction, IConcept.Transitivity) +IRoleType::GetPlayerTypes(ITypeDBTransaction, IConcept.Transitivity) ---- @@ -182,7 +182,7 @@ See also ---- - IRoleType::GetRelationInstances(ITypeDBTransaction, IConcept.Transitivity) +IRoleType::GetRelationInstances(ITypeDBTransaction, IConcept.Transitivity) ---- diff --git a/csharp/docs/schema/IThingType.adoc b/csharp/docs/schema/IThingType.adoc index 8629c80224..0e72329e5d 100644 --- a/csharp/docs/schema/IThingType.adoc +++ b/csharp/docs/schema/IThingType.adoc @@ -56,7 +56,7 @@ See also ---- - IThingType::GetInstances(ITypeDBTransaction, IConcept.Transitivity) +IThingType::GetInstances(ITypeDBTransaction, IConcept.Transitivity) ---- @@ -118,7 +118,7 @@ See also ---- - IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) +IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) ---- @@ -145,7 +145,7 @@ See also ---- - IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) +IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) ---- @@ -172,7 +172,7 @@ See also ---- - IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) +IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) ---- @@ -199,7 +199,7 @@ See also ---- - IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) +IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) ---- @@ -226,7 +226,7 @@ See also ---- - IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) +IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) ---- @@ -253,7 +253,7 @@ See also ---- - IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) +IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType?, ICollection, IConcept.Transitivity) ---- @@ -280,7 +280,7 @@ See also ---- - IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) +IThingType::GetOwns(ITypeDBTransaction, IValue.ValueType, ICollection, IConcept.Transitivity) ---- @@ -378,7 +378,7 @@ See also ---- - IThingType::GetPlays(ITypeDBTransaction, IConcept.Transitivity) +IThingType::GetPlays(ITypeDBTransaction, IConcept.Transitivity) ---- @@ -605,7 +605,7 @@ See also ---- - IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) +IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) ---- @@ -632,7 +632,7 @@ See also ---- - IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) +IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) ---- @@ -659,7 +659,7 @@ See also ---- - IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) +IThingType::SetOwns(ITypeDBTransaction, IAttributeType, IAttributeType, Set) ---- @@ -686,7 +686,7 @@ See also ---- - IThingType::SetPlays(ITypeDBTransaction, IRoleType, IRoleType) +IThingType::SetPlays(ITypeDBTransaction, IRoleType, IRoleType) ---- diff --git a/csharp/docs/schema/IType.adoc b/csharp/docs/schema/IType.adoc index 8cc587883d..93a74e0660 100644 --- a/csharp/docs/schema/IType.adoc +++ b/csharp/docs/schema/IType.adoc @@ -88,7 +88,7 @@ See also ---- - IType::GetSubtypes(ITypeDBTransaction, IConcept.Transitivity) +IType::GetSubtypes(ITypeDBTransaction, IConcept.Transitivity) ---- diff --git a/csharp/docs/session/ITypeDBSession.adoc b/csharp/docs/session/ITypeDBSession.adoc index 28882a3054..9483e569df 100644 --- a/csharp/docs/session/ITypeDBSession.adoc +++ b/csharp/docs/session/ITypeDBSession.adoc @@ -185,7 +185,7 @@ See also ---- - ITypeDBSession::Transaction(TransactionType, TypeDBOptions) +ITypeDBSession::Transaction(TransactionType, TypeDBOptions) ---- diff --git a/csharp/docs/transaction/IQueryManager.adoc b/csharp/docs/transaction/IQueryManager.adoc index 69c4dd4868..8e2b18d165 100644 --- a/csharp/docs/transaction/IQueryManager.adoc +++ b/csharp/docs/transaction/IQueryManager.adoc @@ -27,7 +27,7 @@ See also ---- - IQueryManager::Define(string, TypeDBOptions) +IQueryManager::Define(string, TypeDBOptions) ---- @@ -88,7 +88,7 @@ See also ---- - IQueryManager::Delete(string, TypeDBOptions) +IQueryManager::Delete(string, TypeDBOptions) ---- @@ -149,7 +149,7 @@ See also ---- - IQueryManager::Explain(IConceptMap.IExplainable, TypeDBOptions) +IQueryManager::Explain(IConceptMap.IExplainable, TypeDBOptions) ---- @@ -210,7 +210,7 @@ See also ---- - IQueryManager::Fetch(string, TypeDBOptions) +IQueryManager::Fetch(string, TypeDBOptions) ---- @@ -271,7 +271,7 @@ See also ---- - IQueryManager::Get(string, TypeDBOptions) +IQueryManager::Get(string, TypeDBOptions) ---- @@ -332,7 +332,7 @@ See also ---- - IQueryManager::GetAggregate(string, TypeDBOptions) +IQueryManager::GetAggregate(string, TypeDBOptions) ---- @@ -393,7 +393,7 @@ See also ---- - IQueryManager::GetGroup(string, TypeDBOptions) +IQueryManager::GetGroup(string, TypeDBOptions) ---- @@ -454,7 +454,7 @@ See also ---- - IQueryManager::GetGroupAggregate(string, TypeDBOptions) +IQueryManager::GetGroupAggregate(string, TypeDBOptions) ---- @@ -515,7 +515,7 @@ See also ---- - IQueryManager::Insert(string, TypeDBOptions) +IQueryManager::Insert(string, TypeDBOptions) ---- @@ -576,7 +576,7 @@ See also ---- - IQueryManager::Undefine(string, TypeDBOptions) +IQueryManager::Undefine(string, TypeDBOptions) ---- @@ -637,7 +637,7 @@ See also ---- - IQueryManager::Update(string, TypeDBOptions) +IQueryManager::Update(string, TypeDBOptions) ---- diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index aa04c11e71..03d969638c 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -155,7 +155,7 @@ class DoxygenParserCsharp : Callable { map[heading] = members } - if (missingDeclarations.isNotEmpty()) { + if (missingDeclarations.isNotEmpty()) { // Ignore the methods that are @private. println("Missing some member declarations:\n\t-" + missingDeclarations.joinToString("\n\t-")) } @@ -258,7 +258,6 @@ class DoxygenParserCsharp : Callable { ) } - println("METHOD: " + methodDescr) return Method( name = methodName, signature = methodSignature, @@ -339,11 +338,17 @@ class DoxygenParserCsharp : Callable { break } - val seeTargetEnd = Regex("([^\\s])+\n").find(updatedHtml, seeAlsoIndex + oldSeeAlso.length) + val seeAlsoEndIndex = seeAlsoIndex + oldSeeAlso.length + val seeTargetEnd = Regex("([^\\s])+\n").find(updatedHtml, seeAlsoEndIndex) val seeTargetEndIndex = seeTargetEnd?.range?.endInclusive if (seeTargetEndIndex != null ) { updatedHtml = StringBuilder(updatedHtml).apply { insert(seeTargetEndIndex + 1, "----") }.toString() seeAlsoIndex = seeTargetEndIndex + "----".length + + val seeTargetStart = Regex("\n [^\\s\\n]+").find(updatedHtml, seeAlsoEndIndex) + if (seeTargetStart != null) { + updatedHtml = updatedHtml.replace(seeTargetStart.value, seeTargetStart.value.replace(" ", "")) + } } } From 9087951ab6ccfaa2eea5aac25cbce7867cc62f89 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 26 Mar 2024 15:39:02 +0000 Subject: [PATCH 052/118] Fix tables width, add zero-width whitespaces for C, CPP, C# --- cpp/docs/answer/ConceptMap.adoc | 2 +- cpp/docs/answer/Explainables.adoc | 6 +- cpp/docs/answer/Explanation.adoc | 2 +- cpp/docs/answer/JSONType.adoc | 2 +- cpp/docs/answer/OwnerAttributePair.adoc | 2 +- cpp/docs/concept/ConceptManager.adoc | 18 +- cpp/docs/concept/ConceptType.adoc | 2 +- cpp/docs/concept/Transitivity.adoc | 2 +- cpp/docs/connection/Credential.adoc | 2 +- cpp/docs/connection/DatabaseManager.adoc | 6 +- cpp/docs/connection/Driver.adoc | 8 +- cpp/docs/connection/User.adoc | 2 +- cpp/docs/connection/UserManager.adoc | 10 +- cpp/docs/data/Attribute.adoc | 4 +- cpp/docs/data/Relation.adoc | 10 +- cpp/docs/data/Thing.adoc | 16 +- cpp/docs/logic/LogicManager.adoc | 4 +- cpp/docs/logic/Rule.adoc | 6 +- cpp/docs/schema/AttributeType.adoc | 42 +- cpp/docs/schema/EntityType.adoc | 8 +- cpp/docs/schema/RelationType.adoc | 20 +- cpp/docs/schema/RoleType.adoc | 22 +- cpp/docs/schema/ThingType.adoc | 34 +- cpp/docs/schema/Type.adoc | 12 +- cpp/docs/schema/ValueType.adoc | 2 +- cpp/docs/session/Options.adoc | 20 +- cpp/docs/session/Session.adoc | 6 +- cpp/docs/session/SessionType.adoc | 2 +- cpp/docs/transaction/QueryManager.adoc | 22 +- cpp/docs/transaction/Transaction.adoc | 4 +- cpp/docs/transaction/TransactionType.adoc | 2 +- csharp/docs/answer/IConceptMap.adoc | 2 +- csharp/docs/answer/IExplainables.adoc | 6 +- csharp/docs/answer/IExplanation.adoc | 2 +- csharp/docs/answer/Promise__T__.adoc | 4 +- csharp/docs/answer/VoidPromise.adoc | 2 +- csharp/docs/concept/IConceptManager.adoc | 20 +- csharp/docs/concept/Transitivity.adoc | 2 +- csharp/docs/connection/IDatabaseManager.adoc | 6 +- csharp/docs/connection/ITypeDBDriver.adoc | 2 +- csharp/docs/connection/IUser.adoc | 2 +- csharp/docs/connection/IUserManager.adoc | 12 +- csharp/docs/connection/TypeDB.adoc | 6 +- csharp/docs/connection/TypeDBCredential.adoc | 4 +- csharp/docs/data/IAttribute.adoc | 4 +- csharp/docs/data/IRelation.adoc | 10 +- csharp/docs/data/IThing.adoc | 16 +- csharp/docs/data/ValueType.adoc | 2 +- csharp/docs/logic/ILogicManager.adoc | 4 +- csharp/docs/logic/IRule.adoc | 6 +- csharp/docs/schema/Annotation.adoc | 2 +- csharp/docs/schema/IAttributeType.adoc | 58 +- csharp/docs/schema/IEntityType.adoc | 4 +- csharp/docs/schema/IRelationType.adoc | 16 +- csharp/docs/schema/IRoleType.adoc | 14 +- csharp/docs/schema/IThingType.adoc | 32 +- csharp/docs/schema/IType.adoc | 14 +- csharp/docs/schema/Label.adoc | 12 +- csharp/docs/schema/Label.html | 710 ++++++++++++++++++ csharp/docs/schema/Label.pdf | Bin 0 -> 73752 bytes csharp/docs/session/ITypeDBSession.adoc | 6 +- csharp/docs/session/SessionType.adoc | 2 +- csharp/docs/session/TypeDBOptions.adoc | 20 +- csharp/docs/transaction/IQueryManager.adoc | 22 +- .../docs/transaction/ITypeDBTransaction.adoc | 2 +- csharp/docs/transaction/TransactionType.adoc | 2 +- java/docs/answer/ConceptMap.Explainables.adoc | 6 +- java/docs/answer/ConceptMap.adoc | 2 +- java/docs/answer/Explanation.adoc | 2 +- java/docs/answer/Promise_T_.adoc | 4 +- java/docs/concept/ConceptManager.adoc | 18 +- java/docs/connection/DatabaseManager.adoc | 6 +- java/docs/connection/TypeDB.adoc | 8 +- java/docs/connection/TypeDBCredential.adoc | 4 +- java/docs/connection/TypeDBDriver.adoc | 2 +- java/docs/connection/User.adoc | 2 +- java/docs/connection/UserManager.adoc | 10 +- java/docs/data/Attribute.adoc | 4 +- java/docs/data/Relation.adoc | 10 +- java/docs/data/Thing.adoc | 16 +- java/docs/data/Value.adoc | 2 +- java/docs/logic/LogicManager.adoc | 4 +- java/docs/logic/Rule.adoc | 6 +- java/docs/schema/AttributeType.adoc | 52 +- java/docs/schema/Concept.Transitivity.adoc | 4 +- java/docs/schema/EntityType.adoc | 8 +- java/docs/schema/Label.adoc | 6 +- java/docs/schema/RelationType.adoc | 18 +- java/docs/schema/RoleType.adoc | 16 +- java/docs/schema/ThingType.Annotation.adoc | 2 +- java/docs/schema/ThingType.adoc | 30 +- java/docs/schema/Type.adoc | 12 +- java/docs/schema/Value.Type.adoc | 4 +- java/docs/session/TypeDBOptions.adoc | 20 +- java/docs/session/TypeDBSession.Type.adoc | 4 +- java/docs/session/TypeDBSession.adoc | 6 +- java/docs/transaction/QueryManager.adoc | 22 +- .../transaction/TypeDBTransaction.Type.adoc | 4 +- java/docs/transaction/TypeDBTransaction.adoc | 2 +- nodejs/docs/answer/ConceptMap.adoc | 4 +- nodejs/docs/answer/ConceptMapGroup.adoc | 2 +- nodejs/docs/answer/Explainable.adoc | 2 +- nodejs/docs/answer/Explainables.adoc | 8 +- nodejs/docs/answer/Explanation.adoc | 2 +- nodejs/docs/answer/Stream_T_.adoc | 12 +- nodejs/docs/answer/ValueGroup.adoc | 2 +- nodejs/docs/concept/Concept.adoc | 2 +- nodejs/docs/concept/ConceptManager.adoc | 18 +- nodejs/docs/connection/Database.adoc | 2 +- nodejs/docs/connection/DatabaseManager.adoc | 6 +- nodejs/docs/connection/Replica.adoc | 2 +- nodejs/docs/connection/TypeDB.adoc | 6 +- nodejs/docs/connection/TypeDBCredential.adoc | 2 +- nodejs/docs/connection/TypeDBDriver.adoc | 4 +- nodejs/docs/connection/User.adoc | 4 +- nodejs/docs/connection/UserManager.adoc | 10 +- nodejs/docs/data/Attribute.adoc | 30 +- nodejs/docs/data/Entity.adoc | 28 +- nodejs/docs/data/Relation.adoc | 40 +- nodejs/docs/data/Thing.adoc | 28 +- nodejs/docs/data/Value.adoc | 4 +- nodejs/docs/errors/ErrorMessage.adoc | 4 +- nodejs/docs/errors/TypeDBDriverError.adoc | 6 +- nodejs/docs/logic/LogicManager.adoc | 4 +- nodejs/docs/logic/Rule.adoc | 8 +- nodejs/docs/schema/Annotation.adoc | 4 +- nodejs/docs/schema/AttributeType.adoc | 112 +-- nodejs/docs/schema/EntityType.adoc | 72 +- nodejs/docs/schema/Label.adoc | 2 +- nodejs/docs/schema/RelationType.adoc | 84 +-- nodejs/docs/schema/RoleType.adoc | 32 +- nodejs/docs/schema/ThingType.adoc | 68 +- nodejs/docs/schema/Transitivity.adoc | 4 +- nodejs/docs/schema/Type.adoc | 18 +- nodejs/docs/schema/ValueType.adoc | 4 +- nodejs/docs/session/Opts.adoc | 2 +- nodejs/docs/session/SessionType.adoc | 2 +- nodejs/docs/session/TypeDBOptions.adoc | 2 +- nodejs/docs/session/TypeDBSession.adoc | 8 +- nodejs/docs/transaction/QueryManager.adoc | 22 +- nodejs/docs/transaction/TransactionType.adoc | 2 +- .../docs/transaction/TypeDBTransaction.adoc | 4 +- python/docs/answer/ConceptMap.adoc | 2 +- python/docs/answer/Explainables.adoc | 6 +- python/docs/answer/Explanation.adoc | 2 +- python/docs/concept/ConceptManager.adoc | 18 +- python/docs/connection/Database.adoc | 2 +- python/docs/connection/DatabaseManager.adoc | 6 +- python/docs/connection/TypeDB.adoc | 4 +- python/docs/connection/TypeDBDriver.adoc | 4 +- python/docs/connection/User.adoc | 2 +- python/docs/connection/UserManager.adoc | 10 +- python/docs/data/Attribute.adoc | 2 +- python/docs/data/Relation.adoc | 10 +- python/docs/data/Thing.adoc | 14 +- python/docs/logic/LogicManager.adoc | 4 +- python/docs/logic/Rule.adoc | 8 +- python/docs/schema/AttributeType.adoc | 18 +- python/docs/schema/EntityType.adoc | 8 +- python/docs/schema/Label.adoc | 4 +- python/docs/schema/RelationType.adoc | 16 +- python/docs/schema/RoleType.adoc | 16 +- python/docs/schema/ThingType.adoc | 30 +- python/docs/schema/Transitivity.adoc | 2 +- python/docs/schema/Type.adoc | 10 +- python/docs/schema/ValueType.adoc | 2 +- python/docs/session/SessionType.adoc | 2 +- python/docs/session/TypeDBOptions.adoc | 2 +- python/docs/session/TypeDBSession.adoc | 8 +- python/docs/transaction/QueryManager.adoc | 22 +- python/docs/transaction/TransactionType.adoc | 2 +- .../docs/transaction/TypeDBTransaction.adoc | 4 +- rust/docs/answer/ConceptMap.adoc | 4 +- rust/docs/answer/ConceptMapGroup.adoc | 2 +- rust/docs/answer/Explainable.adoc | 2 +- rust/docs/answer/Explainables.adoc | 2 +- rust/docs/answer/Explanation.adoc | 2 +- rust/docs/answer/JSON.adoc | 2 +- rust/docs/answer/ValueGroup.adoc | 2 +- rust/docs/concept/Concept.adoc | 2 +- rust/docs/concept/ConceptManager.adoc | 18 +- rust/docs/connection/Connection.adoc | 4 +- rust/docs/connection/Credential.adoc | 4 +- rust/docs/connection/DatabaseManager.adoc | 6 +- rust/docs/connection/ReplicaInfo.adoc | 2 +- rust/docs/connection/User.adoc | 4 +- rust/docs/connection/UserManager.adoc | 10 +- rust/docs/data/Attribute.adoc | 2 +- rust/docs/data/Entity.adoc | 2 +- rust/docs/data/Relation.adoc | 2 +- rust/docs/data/Thing.adoc | 2 +- rust/docs/data/Trait_AttributeAPI.adoc | 2 +- rust/docs/data/Trait_RelationAPI.adoc | 10 +- rust/docs/data/Trait_ThingAPI.adoc | 14 +- rust/docs/data/Value.adoc | 2 +- rust/docs/errors/ConnectionError.adoc | 2 +- rust/docs/errors/Error.adoc | 2 +- rust/docs/errors/InternalError.adoc | 2 +- rust/docs/errors/SchemaException.adoc | 2 +- rust/docs/logic/LogicManager.adoc | 4 +- rust/docs/logic/Rule.adoc | 2 +- rust/docs/logic/Trait_RuleAPI.adoc | 6 +- rust/docs/schema/Annotation.adoc | 2 +- rust/docs/schema/AttributeType.adoc | 2 +- rust/docs/schema/EntityType.adoc | 2 +- rust/docs/schema/RelationType.adoc | 2 +- rust/docs/schema/RoleType.adoc | 2 +- rust/docs/schema/ScopedLabel.adoc | 2 +- rust/docs/schema/ThingType.adoc | 2 +- rust/docs/schema/Trait_AttributeTypeAPI.adoc | 24 +- rust/docs/schema/Trait_EntityTypeAPI.adoc | 12 +- rust/docs/schema/Trait_RelationTypeAPI.adoc | 22 +- rust/docs/schema/Trait_RoleTypeAPI.adoc | 22 +- rust/docs/schema/Trait_ThingTypeAPI.adoc | 28 +- rust/docs/schema/Transitivity.adoc | 2 +- rust/docs/schema/ValueType.adoc | 2 +- rust/docs/session/Options.adoc | 2 +- rust/docs/session/Session.adoc | 8 +- rust/docs/session/SessionType.adoc | 2 +- rust/docs/transaction/QueryManager.adoc | 22 +- rust/docs/transaction/Transaction.adoc | 2 +- rust/docs/transaction/TransactionType.adoc | 2 +- tool/docs/adoc/AsciiDocTableBuilder.kt | 2 +- tool/docs/c/DoxygenParserC.kt | 11 +- tool/docs/cpp/DoxygenParserCpp.kt | 15 +- tool/docs/csharp/DoxygenParserCsharp.kt | 35 +- tool/docs/util/Util.kt | 4 + 227 files changed, 1821 insertions(+), 1098 deletions(-) create mode 100644 csharp/docs/schema/Label.html create mode 100644 csharp/docs/schema/Label.pdf diff --git a/cpp/docs/answer/ConceptMap.adoc b/cpp/docs/answer/ConceptMap.adoc index daebadf316..56c7b1a1e0 100644 --- a/cpp/docs/answer/ConceptMap.adoc +++ b/cpp/docs/answer/ConceptMap.adoc @@ -71,7 +71,7 @@ Retrieves a concept for a given variable name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/answer/Explainables.adoc b/cpp/docs/answer/Explainables.adoc index c10fbf4c0f..eeac15a813 100644 --- a/cpp/docs/answer/Explainables.adoc +++ b/cpp/docs/answer/Explainables.adoc @@ -23,7 +23,7 @@ Retrieves the explainable attribute with the given variable name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -80,7 +80,7 @@ Retrieves the explainable attribute ownership with the pair of (owner, attribute [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -138,7 +138,7 @@ Retrieves the explainable relation with the given variable name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/answer/Explanation.adoc b/cpp/docs/answer/Explanation.adoc index 8f88f9e9f8..035a3aeef8 100644 --- a/cpp/docs/answer/Explanation.adoc +++ b/cpp/docs/answer/Explanation.adoc @@ -73,7 +73,7 @@ Retrieves the rule variables corresponding to the query variable var for this `` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/answer/JSONType.adoc b/cpp/docs/answer/JSONType.adoc index a6ef0a6aa1..3f94de6b2a 100644 --- a/cpp/docs/answer/JSONType.adoc +++ b/cpp/docs/answer/JSONType.adoc @@ -10,7 +10,7 @@ Specifies the exact type of this JSON object [caption=""] .Enum constants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name diff --git a/cpp/docs/answer/OwnerAttributePair.adoc b/cpp/docs/answer/OwnerAttributePair.adoc index dd2e102040..d764a794ff 100644 --- a/cpp/docs/answer/OwnerAttributePair.adoc +++ b/cpp/docs/answer/OwnerAttributePair.adoc @@ -10,7 +10,7 @@ Simple class holding the owner concept & owned attribute identifying an expl [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/cpp/docs/concept/ConceptManager.adoc b/cpp/docs/concept/ConceptManager.adoc index 6cf2f6caa9..76899cfa92 100644 --- a/cpp/docs/concept/ConceptManager.adoc +++ b/cpp/docs/concept/ConceptManager.adoc @@ -23,7 +23,7 @@ Retrieves an ``Attribute`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -56,7 +56,7 @@ Retrieves an ``AttributeType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -89,7 +89,7 @@ Retrieves an ``Entity`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -122,7 +122,7 @@ Retrieves an ``EntityType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -155,7 +155,7 @@ Retrieves a ``Relation`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -188,7 +188,7 @@ Retrieves a ``RelationType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -317,7 +317,7 @@ Creates a new ``AttributeType`` if none exists with the given label, or retrieve [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -351,7 +351,7 @@ Creates a new ``EntityType`` if none exists with the given label, otherwise retr [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -384,7 +384,7 @@ Creates a new ``RelationType`` if none exists with the given label, otherwise re [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/concept/ConceptType.adoc b/cpp/docs/concept/ConceptType.adoc index aa0f28ece2..3d3b66263b 100644 --- a/cpp/docs/concept/ConceptType.adoc +++ b/cpp/docs/concept/ConceptType.adoc @@ -10,7 +10,7 @@ The exact type of a Concept object. Use for downcasting to the appropriate type. [caption=""] .Enum constants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name diff --git a/cpp/docs/concept/Transitivity.adoc b/cpp/docs/concept/Transitivity.adoc index 75e26f1e54..410bb94eb1 100644 --- a/cpp/docs/concept/Transitivity.adoc +++ b/cpp/docs/concept/Transitivity.adoc @@ -10,7 +10,7 @@ Used in ConceptAPI to specify whether to query only explicit schema constraints [caption=""] .Enum constants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name diff --git a/cpp/docs/connection/Credential.adoc b/cpp/docs/connection/Credential.adoc index d7940da2b7..e2fd649422 100644 --- a/cpp/docs/connection/Credential.adoc +++ b/cpp/docs/connection/Credential.adoc @@ -35,7 +35,7 @@ TypeDB::Credential::Credential(const std::string& username, const std::string& p [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/connection/DatabaseManager.adoc b/cpp/docs/connection/DatabaseManager.adoc index 3c62c72245..6bc7e16c96 100644 --- a/cpp/docs/connection/DatabaseManager.adoc +++ b/cpp/docs/connection/DatabaseManager.adoc @@ -47,7 +47,7 @@ Checks if a database with the given name exists [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -80,7 +80,7 @@ Create a database with the given name [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -113,7 +113,7 @@ Retrieve the database with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/connection/Driver.adoc b/cpp/docs/connection/Driver.adoc index 17beaf8661..18324459e7 100644 --- a/cpp/docs/connection/Driver.adoc +++ b/cpp/docs/connection/Driver.adoc @@ -10,7 +10,7 @@ A connection to a TypeDB server which serves as the starting point for all inter [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -59,7 +59,7 @@ Open a TypeDB Driver to TypeDB Cloud server(s) available at the provided address [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -93,7 +93,7 @@ Open a TypeDB Driver to a TypeDB Core server available at the provided address. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -174,7 +174,7 @@ Opens a communication tunnel (session) to the given database on the running Type [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/connection/User.adoc b/cpp/docs/connection/User.adoc index 417f795a76..d4ce37e4bf 100644 --- a/cpp/docs/connection/User.adoc +++ b/cpp/docs/connection/User.adoc @@ -39,7 +39,7 @@ Updates the password for this user. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/connection/UserManager.adoc b/cpp/docs/connection/UserManager.adoc index 6668deb28b..2152ae91e3 100644 --- a/cpp/docs/connection/UserManager.adoc +++ b/cpp/docs/connection/UserManager.adoc @@ -47,7 +47,7 @@ Checks if a user with the given name exists. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -80,7 +80,7 @@ Creates a user with the given name & password. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -114,7 +114,7 @@ Deletes a user with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -147,7 +147,7 @@ Retrieves a user with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -180,7 +180,7 @@ Sets a new password for a user. This operation can only be performed by administ [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/data/Attribute.adoc b/cpp/docs/data/Attribute.adoc index f030c6325d..f4e59008da 100644 --- a/cpp/docs/data/Attribute.adoc +++ b/cpp/docs/data/Attribute.adoc @@ -30,7 +30,7 @@ Retrieves the instances that own this ``Attribute``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -63,7 +63,7 @@ Retrieves the instances that own this ``Attribute``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/data/Relation.adoc b/cpp/docs/data/Relation.adoc index 54d57e5997..17c5ce4232 100644 --- a/cpp/docs/data/Relation.adoc +++ b/cpp/docs/data/Relation.adoc @@ -30,7 +30,7 @@ Adds a new role player to play the given role in this ``Relation``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -65,7 +65,7 @@ Retrieves a mapping of all instances involved in the ``Relation`` and the role e [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -98,7 +98,7 @@ Retrieves all role players of this ``Relation``, optionally filtered by given ro [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -148,7 +148,7 @@ Retrieves all role types currently played in this ``Relation``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -205,7 +205,7 @@ Removes the association of the given instance that plays the given role in this [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/data/Thing.adoc b/cpp/docs/data/Thing.adoc index e616895e11..73958f85c1 100644 --- a/cpp/docs/data/Thing.adoc +++ b/cpp/docs/data/Thing.adoc @@ -27,7 +27,7 @@ Deletes this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -60,7 +60,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns, filtered by ``Annotation` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -111,7 +111,7 @@ Retrieves the ``Attribute``s of the specified ``AttributeType``s that this ``Thi [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -201,7 +201,7 @@ Retrieves the roles that this ``Thing`` is currently playing. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -234,7 +234,7 @@ Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -309,7 +309,7 @@ Checks if this ``Thing`` is deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -366,7 +366,7 @@ Assigns an ``Attribute`` to be owned by this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -400,7 +400,7 @@ Unassigns an ``Attribute`` from this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/logic/LogicManager.adoc b/cpp/docs/logic/LogicManager.adoc index f1f7729838..9843845f8f 100644 --- a/cpp/docs/logic/LogicManager.adoc +++ b/cpp/docs/logic/LogicManager.adoc @@ -23,7 +23,7 @@ Retrieves the Rule that has the given label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -80,7 +80,7 @@ Creates a new Rule if none exists with the given label, or replaces the existing [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/logic/Rule.adoc b/cpp/docs/logic/Rule.adoc index aefcdf7cb6..fae4a2ef9b 100644 --- a/cpp/docs/logic/Rule.adoc +++ b/cpp/docs/logic/Rule.adoc @@ -25,7 +25,7 @@ Deletes this rule. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -58,7 +58,7 @@ Check if this rule has been deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -107,7 +107,7 @@ Renames the label of the rule. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/schema/AttributeType.adoc b/cpp/docs/schema/AttributeType.adoc index 7f50021d43..7d369bd848 100644 --- a/cpp/docs/schema/AttributeType.adoc +++ b/cpp/docs/schema/AttributeType.adoc @@ -35,7 +35,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -69,7 +69,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -103,7 +103,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -137,7 +137,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -171,7 +171,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -205,7 +205,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -239,7 +239,7 @@ Retrieves all direct and indirect ``Attributes`` that are instances of this ``At [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -278,7 +278,7 @@ Retrieve all ``Things`` that own an attribute of this ``AttributeType`` directly [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -312,7 +312,7 @@ Variant of <<#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Trans [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -369,7 +369,7 @@ Retrieves the regular expression that is defined for this ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -402,7 +402,7 @@ Retrieves all direct and indirect subtypes of this ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -437,7 +437,7 @@ Retrieves all direct and indirect (or direct only) subtypes of this ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -496,7 +496,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given value [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -530,7 +530,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given ``Str [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -564,7 +564,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given ``lon [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -598,7 +598,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given ``dou [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -632,7 +632,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given ``boo [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -666,7 +666,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given ``Dat [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -702,7 +702,7 @@ Can only be applied for ``AttributeType``s with a ``string`` value type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -736,7 +736,7 @@ Sets the supplied ``AttributeType`` as the supertype of the current ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -770,7 +770,7 @@ Removes the regular expression that is defined for this ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/schema/EntityType.adoc b/cpp/docs/schema/EntityType.adoc index b19d4b2faa..138a3fbfd3 100644 --- a/cpp/docs/schema/EntityType.adoc +++ b/cpp/docs/schema/EntityType.adoc @@ -29,7 +29,7 @@ Creates and returns a new instance of this ``EntityType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -62,7 +62,7 @@ Retrieves ``Entity`` objects that are instances of this exact ``EntityType`` OR [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -96,7 +96,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``EntityType` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -130,7 +130,7 @@ Sets the supplied ``EntityType`` as the supertype of the current ``EntityType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/schema/RelationType.adoc b/cpp/docs/schema/RelationType.adoc index 94ed3b5d6a..63f3b3fa9f 100644 --- a/cpp/docs/schema/RelationType.adoc +++ b/cpp/docs/schema/RelationType.adoc @@ -31,7 +31,7 @@ Creates and returns an instance of this ``RelationType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -64,7 +64,7 @@ Retrieves ``Relation``s that are instances of this exact ``RelationType``, OR th [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -98,7 +98,7 @@ Retrieves roles that this ``RelationType`` relates to directly or via inheritanc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -132,7 +132,7 @@ Retrieves the role with the specified label that this ``RelationType`` relates t [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -166,7 +166,7 @@ Retrieves a ``RoleType`` that is overridden by the role with the ``role_label``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -200,7 +200,7 @@ Retrieves a ``RoleType`` that is overridden by the role with the ``role_label``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -234,7 +234,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``RelationTyp [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -300,7 +300,7 @@ Sets the new role that this ``RelationType`` relates to. If we are setting an ov [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -336,7 +336,7 @@ Sets the supplied ``RelationType`` as the supertype of the current ``RelationTyp [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -386,7 +386,7 @@ Disallows this ``RelationType`` from relating to the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/schema/RoleType.adoc b/cpp/docs/schema/RoleType.adoc index 42099e28bb..b7ae22d737 100644 --- a/cpp/docs/schema/RoleType.adoc +++ b/cpp/docs/schema/RoleType.adoc @@ -34,7 +34,7 @@ Implements TypeDB::Type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -119,7 +119,7 @@ Retrieves the ``Thing`` instances that play this role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -153,7 +153,7 @@ Retrieves the ``ThingType``s whose instances play this role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -187,7 +187,7 @@ Retrieves the ``Relation`` instances that this role is related to. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -221,7 +221,7 @@ Retrieves the ``RelationType`` that this role is directly related to. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -254,7 +254,7 @@ Retrieves ``RelationType``s that this role is related to (directly or indirectly [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -311,7 +311,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``RoleType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -345,7 +345,7 @@ Retrieves the most immediate supertype of the ``RoleType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -378,7 +378,7 @@ Retrieves all supertypes of the ``RoleType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -443,7 +443,7 @@ Implements TypeDB::Type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -504,7 +504,7 @@ Implements TypeDB::Type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/schema/ThingType.adoc b/cpp/docs/schema/ThingType.adoc index 710a4bfce0..471a8b3715 100644 --- a/cpp/docs/schema/ThingType.adoc +++ b/cpp/docs/schema/ThingType.adoc @@ -32,7 +32,7 @@ Implements TypeDB::Type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -175,7 +175,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -212,7 +212,7 @@ Retrieves an ``AttributeType``, ownership of which is overridden for this ``Thin [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -246,7 +246,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -281,7 +281,7 @@ Retrieves a ``RoleType`` that is overridden by the given ``role_type`` for this [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -317,7 +317,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -354,7 +354,7 @@ Retrieves the most immediate supertype of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -389,7 +389,7 @@ Retrieves all supertypes of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -422,7 +422,7 @@ Produces a pattern for creating this ``ThingType`` in a ``define`` query. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -487,7 +487,7 @@ Implements TypeDB::Type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -544,7 +544,7 @@ Set a ``ThingType`` to be abstract, meaning it cannot have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -581,7 +581,7 @@ Implements TypeDB::Type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -665,7 +665,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. O [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -718,7 +718,7 @@ Allows the instances of this ``ThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -754,7 +754,7 @@ Set a ``ThingType`` to be non-abstract, meaning it can have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -787,7 +787,7 @@ Disallows the instances of this ``ThingType`` from owning the given ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -821,7 +821,7 @@ Disallows the instances of this ``ThingType`` from playing the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/schema/Type.adoc b/cpp/docs/schema/Type.adoc index 5320eb3f9e..67853a9f82 100644 --- a/cpp/docs/schema/Type.adoc +++ b/cpp/docs/schema/Type.adoc @@ -29,7 +29,7 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -88,7 +88,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -123,7 +123,7 @@ Retrieves the most immediate supertype of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -156,7 +156,7 @@ Retrieves all supertypes of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -217,7 +217,7 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -252,7 +252,7 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/schema/ValueType.adoc b/cpp/docs/schema/ValueType.adoc index f58485afc5..f9c0265194 100644 --- a/cpp/docs/schema/ValueType.adoc +++ b/cpp/docs/schema/ValueType.adoc @@ -10,7 +10,7 @@ Represents the type of primitive value is held by a Value or Attribute. [caption=""] .Enum constants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name diff --git a/cpp/docs/session/Options.adoc b/cpp/docs/session/Options.adoc index 8c889a6280..2718199cfb 100644 --- a/cpp/docs/session/Options.adoc +++ b/cpp/docs/session/Options.adoc @@ -73,7 +73,7 @@ Explicitly enables or disables explanations. If set to ``true``, enables explana [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -130,7 +130,7 @@ Explicitly enables or disables inference. Only settable at transaction level and [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -187,7 +187,7 @@ Explicitly enables or disables parallel execution. If set to ``true``, the serve [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -244,7 +244,7 @@ Explicitly enables or disables prefetching. If set to ``true``, the first batch [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -301,7 +301,7 @@ Explicitly sets a prefetch size. If set, specifies a guideline number of answers [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -358,7 +358,7 @@ Explicitly enables or disables reading data from any replica. If set to ``True`` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -415,7 +415,7 @@ Explicitly sets schema lock acquire timeout. If set, specifies how long the driv [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -472,7 +472,7 @@ Explicitly sets a session idle timeout. If set, specifies a timeout that allows [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -529,7 +529,7 @@ Explicitly enables or disables reasoning tracing. If set to ``true``, reasoning [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -586,7 +586,7 @@ Explicitly set a transaction timeout. If set, specifies a timeout for killing tr [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/session/Session.adoc b/cpp/docs/session/Session.adoc index 982cd0bd63..4ac3f2908c 100644 --- a/cpp/docs/session/Session.adoc +++ b/cpp/docs/session/Session.adoc @@ -95,7 +95,7 @@ Registers a callback function which will be executed when this session is closed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -128,7 +128,7 @@ Registers a callback function which will be executed when this session is reopen [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -161,7 +161,7 @@ Opens a transaction to perform read or write queries on the database connected t [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/session/SessionType.adoc b/cpp/docs/session/SessionType.adoc index 84f23cbbee..209d0fa66f 100644 --- a/cpp/docs/session/SessionType.adoc +++ b/cpp/docs/session/SessionType.adoc @@ -18,7 +18,7 @@ driver.session(database, TypeDBSession.Type.SCHEMA); [caption=""] .Enum constants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name diff --git a/cpp/docs/transaction/QueryManager.adoc b/cpp/docs/transaction/QueryManager.adoc index 5366cd75cc..084e176643 100644 --- a/cpp/docs/transaction/QueryManager.adoc +++ b/cpp/docs/transaction/QueryManager.adoc @@ -23,7 +23,7 @@ Performs a TypeQL Define query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -57,7 +57,7 @@ Performs a TypeQL Explain query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -91,7 +91,7 @@ Performs a TypeQL Fetch query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -125,7 +125,7 @@ Performs a TypeQL Get query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -159,7 +159,7 @@ Performs a TypeQL Get Aggregate query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -193,7 +193,7 @@ Performs a TypeQL Get Group query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -227,7 +227,7 @@ Performs a TypeQL Get Group Aggregate query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -261,7 +261,7 @@ Performs a TypeQL Insert query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -295,7 +295,7 @@ Performs a TypeQL Delete query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -329,7 +329,7 @@ Performs a TypeQL Undefine query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -363,7 +363,7 @@ Performs a TypeQL Update query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/transaction/Transaction.adoc b/cpp/docs/transaction/Transaction.adoc index 6ad3f7a15e..312e99b298 100644 --- a/cpp/docs/transaction/Transaction.adoc +++ b/cpp/docs/transaction/Transaction.adoc @@ -10,7 +10,7 @@ A transaction with a TypeDB database. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -132,7 +132,7 @@ Registers a callback function which will be executed when this transaction is cl [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/cpp/docs/transaction/TransactionType.adoc b/cpp/docs/transaction/TransactionType.adoc index fbc532b5a1..647b62854d 100644 --- a/cpp/docs/transaction/TransactionType.adoc +++ b/cpp/docs/transaction/TransactionType.adoc @@ -18,7 +18,7 @@ session.transaction(TransactionType.READ); [caption=""] .Enum constants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name diff --git a/csharp/docs/answer/IConceptMap.adoc b/csharp/docs/answer/IConceptMap.adoc index fef5ae67f1..0633d06442 100644 --- a/csharp/docs/answer/IConceptMap.adoc +++ b/csharp/docs/answer/IConceptMap.adoc @@ -47,7 +47,7 @@ Retrieves a concept for a given variable name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/answer/IExplainables.adoc b/csharp/docs/answer/IExplainables.adoc index fb13f98c9c..30556dd4db 100644 --- a/csharp/docs/answer/IExplainables.adoc +++ b/csharp/docs/answer/IExplainables.adoc @@ -23,7 +23,7 @@ Retrieves the explainable attribute with the given variable name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -128,7 +128,7 @@ Retrieves the explainable attribute ownership with the pair of (owner, attribute [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -162,7 +162,7 @@ Retrieves the explainable relation with the given variable name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/answer/IExplanation.adoc b/csharp/docs/answer/IExplanation.adoc index 38d86798ef..0c2d5c000c 100644 --- a/csharp/docs/answer/IExplanation.adoc +++ b/csharp/docs/answer/IExplanation.adoc @@ -95,7 +95,7 @@ Retrieves the rule variables corresponding to the query variable var for this `` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/answer/Promise__T__.adoc b/csharp/docs/answer/Promise__T__.adoc index f7e865d937..0df8273221 100644 --- a/csharp/docs/answer/Promise__T__.adoc +++ b/csharp/docs/answer/Promise__T__.adoc @@ -25,7 +25,7 @@ Helper function to map promises. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -59,7 +59,7 @@ Promise constructor [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/answer/VoidPromise.adoc b/csharp/docs/answer/VoidPromise.adoc index 578363e196..f28f1fd460 100644 --- a/csharp/docs/answer/VoidPromise.adoc +++ b/csharp/docs/answer/VoidPromise.adoc @@ -58,7 +58,7 @@ Promise constructor [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/concept/IConceptManager.adoc b/csharp/docs/concept/IConceptManager.adoc index 27b0f2b20d..b72de3083d 100644 --- a/csharp/docs/concept/IConceptManager.adoc +++ b/csharp/docs/concept/IConceptManager.adoc @@ -23,7 +23,7 @@ Retrieves an ``IAttribute`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -56,7 +56,7 @@ Retrieves an ``IAttributeType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -89,7 +89,7 @@ Retrieves an ``IEntity`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -122,7 +122,7 @@ Retrieves an ``IEntityType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -155,7 +155,7 @@ Retrieves a ``IRelation`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -188,7 +188,7 @@ Retrieves a ``IRelationType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -245,12 +245,12 @@ Creates a new ``IAttributeType`` if none exists with the given label, or retriev [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `label` a| The label of the ``IAttributeType`` to create or retrieve. a| `string` -a| `valueType` a| The value type of the ``IAttributeType`` to create. a| `IValue.ValueType` +a| `valueType` a| The value type of the ``IAttributeType`` to create. a| `IValue​.ValueType` |=== [caption=""] @@ -279,7 +279,7 @@ Creates a new ``IEntityType`` if none exists with the given label, otherwise ret [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -312,7 +312,7 @@ Creates a new ``IRelationType`` if none exists with the given label, otherwise r [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/concept/Transitivity.adoc b/csharp/docs/concept/Transitivity.adoc index b2028f7278..111bb88087 100644 --- a/csharp/docs/concept/Transitivity.adoc +++ b/csharp/docs/concept/Transitivity.adoc @@ -18,7 +18,7 @@ attributeType.GetOwners(transaction, annotation, Explicit); [caption=""] .Enum constants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name diff --git a/csharp/docs/connection/IDatabaseManager.adoc b/csharp/docs/connection/IDatabaseManager.adoc index 9cbf48dffa..a013e607f0 100644 --- a/csharp/docs/connection/IDatabaseManager.adoc +++ b/csharp/docs/connection/IDatabaseManager.adoc @@ -23,7 +23,7 @@ Checks if a database with the given name exists. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -56,7 +56,7 @@ Create a database with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -89,7 +89,7 @@ Retrieve the database with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/connection/ITypeDBDriver.adoc b/csharp/docs/connection/ITypeDBDriver.adoc index 73b64a2f3f..9f79f1b097 100644 --- a/csharp/docs/connection/ITypeDBDriver.adoc +++ b/csharp/docs/connection/ITypeDBDriver.adoc @@ -142,7 +142,7 @@ Opens a communication tunnel (session) to the given database on the running Type [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/connection/IUser.adoc b/csharp/docs/connection/IUser.adoc index 3252252eec..fa5945dfb5 100644 --- a/csharp/docs/connection/IUser.adoc +++ b/csharp/docs/connection/IUser.adoc @@ -57,7 +57,7 @@ Updates the password for this user. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/connection/IUserManager.adoc b/csharp/docs/connection/IUserManager.adoc index e9b5ad23dc..36d1064249 100644 --- a/csharp/docs/connection/IUserManager.adoc +++ b/csharp/docs/connection/IUserManager.adoc @@ -23,7 +23,7 @@ Checks if a user with the given name exists. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -51,12 +51,12 @@ void Create(string username, string password) -Creates a user with the given name & password. +Creates a user with the given name & password. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -90,7 +90,7 @@ Deletes a user with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -123,7 +123,7 @@ Retrieves a user with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -180,7 +180,7 @@ Sets a new password for a user. This operation can only be performed by administ [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/connection/TypeDB.adoc b/csharp/docs/connection/TypeDB.adoc index afeccdd6c8..306863a43a 100644 --- a/csharp/docs/connection/TypeDB.adoc +++ b/csharp/docs/connection/TypeDB.adoc @@ -19,7 +19,7 @@ Open a TypeDB Driver to a TypeDB Cloud server available at the provided address, [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -53,7 +53,7 @@ Open a TypeDB Driver to TypeDB Cloud server(s) available at the provided address [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -87,7 +87,7 @@ Open a TypeDB Driver to a TypeDB Core server available at the provided address. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/connection/TypeDBCredential.adoc b/csharp/docs/connection/TypeDBCredential.adoc index df0cb91235..9f3f88d1ef 100644 --- a/csharp/docs/connection/TypeDBCredential.adoc +++ b/csharp/docs/connection/TypeDBCredential.adoc @@ -54,7 +54,7 @@ TypeDBCredential(string username, string password, bool tlsEnabled) [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -101,7 +101,7 @@ TypeDBCredential(string username, string password, string? tlsRootCAPath) [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/data/IAttribute.adoc b/csharp/docs/data/IAttribute.adoc index 1f0aa4013d..98d6885301 100644 --- a/csharp/docs/data/IAttribute.adoc +++ b/csharp/docs/data/IAttribute.adoc @@ -56,7 +56,7 @@ Retrieves the instances that own this ``IAttribute``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -89,7 +89,7 @@ Retrieves the instances that own this ``IAttribute``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/data/IRelation.adoc b/csharp/docs/data/IRelation.adoc index e53857b4e6..00820b9654 100644 --- a/csharp/docs/data/IRelation.adoc +++ b/csharp/docs/data/IRelation.adoc @@ -28,7 +28,7 @@ Adds a new role player to play the given role in this ``IRelation``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -89,7 +89,7 @@ Retrieves a mapping of all instances involved in the ``IRelation`` and the role [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -122,7 +122,7 @@ Retrieves all role players of this ``IRelation``, optionally filtered by given r [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -156,7 +156,7 @@ Retrieves all role types currently played in this ``IRelation``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -215,7 +215,7 @@ Removes the association of the given instance that plays the given role in this [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/data/IThing.adoc b/csharp/docs/data/IThing.adoc index 5ad36b5b9a..5ec7eb4ce6 100644 --- a/csharp/docs/data/IThing.adoc +++ b/csharp/docs/data/IThing.adoc @@ -49,7 +49,7 @@ Deletes this ``IThing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -82,7 +82,7 @@ Retrieves the ``IAttribute``s that this ``IThing`` owns, optionally filtered by [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -117,7 +117,7 @@ Retrieves the ``IAttribute``s that this ``IThing`` owns, filtered by ``Annotatio [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -152,7 +152,7 @@ Retrieves the roles that this ``IThing`` is currently playing. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -185,7 +185,7 @@ Retrieves all the ``Relations`` which this ``IThing`` plays a role in, optionall [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -243,7 +243,7 @@ Checks if this ``IThing`` is deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -326,7 +326,7 @@ Assigns an ``IAttribute`` to be owned by this ``IThing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -384,7 +384,7 @@ Unassigns an ``IAttribute`` from this ``IThing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/data/ValueType.adoc b/csharp/docs/data/ValueType.adoc index b7bc335e9c..720afd2bff 100644 --- a/csharp/docs/data/ValueType.adoc +++ b/csharp/docs/data/ValueType.adoc @@ -18,7 +18,7 @@ thingType.GetOwns(transaction, IValue.ValueType.String); [caption=""] .Enum constants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name diff --git a/csharp/docs/logic/ILogicManager.adoc b/csharp/docs/logic/ILogicManager.adoc index 139ceba0d6..3900092ff5 100644 --- a/csharp/docs/logic/ILogicManager.adoc +++ b/csharp/docs/logic/ILogicManager.adoc @@ -23,7 +23,7 @@ Retrieves the Rule that has the given label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -80,7 +80,7 @@ Creates a new Rule if none exists with the given label, or replaces the existing [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/logic/IRule.adoc b/csharp/docs/logic/IRule.adoc index 6e1c812b9e..1690f82a4d 100644 --- a/csharp/docs/logic/IRule.adoc +++ b/csharp/docs/logic/IRule.adoc @@ -23,7 +23,7 @@ Deletes this rule. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -56,7 +56,7 @@ Check if this rule has been deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -105,7 +105,7 @@ Renames the label of the rule. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/schema/Annotation.adoc b/csharp/docs/schema/Annotation.adoc index 2ca14547f6..46ebb1d721 100644 --- a/csharp/docs/schema/Annotation.adoc +++ b/csharp/docs/schema/Annotation.adoc @@ -23,7 +23,7 @@ Checks if this ``Annotation`` is equal to another object. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/schema/IAttributeType.adoc b/csharp/docs/schema/IAttributeType.adoc index acc405ff65..9bde8a04a5 100644 --- a/csharp/docs/schema/IAttributeType.adoc +++ b/csharp/docs/schema/IAttributeType.adoc @@ -63,7 +63,7 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -97,7 +97,7 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -131,7 +131,7 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -165,7 +165,7 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -199,7 +199,7 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -233,12 +233,12 @@ Retrieves an ``IAttribute`` of this ``IAttributeType`` with the given value if s [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `value` a| ``IAttribute``’s value a| `System.DateTime` +a| `value` a| ``IAttribute``’s value a| `System​.DateTime` |=== [caption=""] @@ -267,7 +267,7 @@ Retrieve all ``Things`` that own an attribute of this ``IAttributeType`` directl [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -300,7 +300,7 @@ Retrieve all ``Things`` that own an attribute of this ``IAttributeType``, filter [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -334,12 +334,12 @@ Retrieve all ``Things`` that own an attribute of this ``IAttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| `IConcept.Transitivity` +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| `IConcept​.Transitivity` |=== [caption=""] @@ -368,13 +368,13 @@ Retrieve all ``Things`` that own an attribute of this ``IAttributeType``, filter [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` a| `annotations` a| Only retrieve ``ThingTypes`` that have an attribute of this ``IAttributeType`` with all given ``Annotation``s a| `ICollection< Annotation >` -a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| `IConcept.Transitivity` +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| `IConcept​.Transitivity` |=== [caption=""] @@ -403,7 +403,7 @@ Retrieves the regular expression that is defined for this ``IAttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -436,12 +436,12 @@ Retrieves all direct and indirect subtypes of this ``IAttributeType`` with given [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| `IValue.ValueType` +a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| `IValue​.ValueType` |=== [caption=""] @@ -470,13 +470,13 @@ Retrieves all direct and indirect (or direct only) subtypes of this ``IAttribute [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| `IValue.ValueType` -a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| `IConcept.Transitivity` +a| `valueType` a| ``IValue.ValueType`` for retrieving subtypes a| `IValue​.ValueType` +a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| `IConcept​.Transitivity` |=== [caption=""] @@ -653,7 +653,7 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given val [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -687,7 +687,7 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``s [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -721,7 +721,7 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``l [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -755,7 +755,7 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``d [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -789,7 +789,7 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``b [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -823,12 +823,12 @@ Adds and returns an ``IAttribute`` of this ``IAttributeType`` with the given ``D [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `value` a| New ``IAttribute``’s value a| `System.DateTime` +a| `value` a| New ``IAttribute``’s value a| `System​.DateTime` |=== [caption=""] @@ -859,7 +859,7 @@ Can only be applied for ``IAttributeType``s with a ``string`` value type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -893,7 +893,7 @@ Sets the supplied ``IAttributeType`` as the supertype of the current ``IAttribut [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -927,7 +927,7 @@ Removes the regular expression that is defined for this ``IAttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/schema/IEntityType.adoc b/csharp/docs/schema/IEntityType.adoc index 2bac874ef3..2fcaed7b59 100644 --- a/csharp/docs/schema/IEntityType.adoc +++ b/csharp/docs/schema/IEntityType.adoc @@ -57,7 +57,7 @@ Creates and returns a new instance of this ``IEntityType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -118,7 +118,7 @@ Sets the supplied ``IEntityType`` as the supertype of the current ``IEntityType` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/schema/IRelationType.adoc b/csharp/docs/schema/IRelationType.adoc index 0519beec18..f48cbbf80b 100644 --- a/csharp/docs/schema/IRelationType.adoc +++ b/csharp/docs/schema/IRelationType.adoc @@ -57,7 +57,7 @@ Creates and returns an instance of this ``IRelationType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -117,12 +117,12 @@ Retrieves roles that this ``IRelationType`` relates to directly or via inheritan [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `transitivity` a| ``Transitive`` for direct and inherited relates, ``Explicit`` for direct relates only a| `IConcept.Transitivity` +a| `transitivity` a| ``Transitive`` for direct and inherited relates, ``Explicit`` for direct relates only a| `IConcept​.Transitivity` |=== [caption=""] @@ -151,7 +151,7 @@ Retrieves roles that this ``IRelationType`` relates to directly or via inheritan [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -212,7 +212,7 @@ Retrieves a ``IRoleType`` that is overridden by the role with the ``role_label`` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -328,7 +328,7 @@ Sets the new role that this ``IRelationType`` relates to. If we are setting an o [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -364,7 +364,7 @@ Sets the supplied ``IRelationType`` as the supertype of the current ``IRelationT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -425,7 +425,7 @@ Disallows this ``IRelationType`` from relating to the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/schema/IRoleType.adoc b/csharp/docs/schema/IRoleType.adoc index cfaaac4f48..f93ec51db5 100644 --- a/csharp/docs/schema/IRoleType.adoc +++ b/csharp/docs/schema/IRoleType.adoc @@ -83,12 +83,12 @@ Retrieves the ``Thing`` instances that play this role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| `IConcept.Transitivity` +a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| `IConcept​.Transitivity` |=== [caption=""] @@ -144,12 +144,12 @@ Retrieves the ``ThingType``s whose instances play this role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| `IConcept.Transitivity` +a| `transitivity` a| ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| `IConcept​.Transitivity` |=== [caption=""] @@ -205,12 +205,12 @@ Retrieves the ``Relation`` instances that this role is related to. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `transitivity` a| ``Transitive`` for direct and indirect relation, ``Explicit`` for direct relation only a| `IConcept.Transitivity` +a| `transitivity` a| ``Transitive`` for direct and indirect relation, ``Explicit`` for direct relation only a| `IConcept​.Transitivity` |=== [caption=""] @@ -239,7 +239,7 @@ Retrieves ``RelationType``s that this role is related to (directly or indirectly [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/schema/IThingType.adoc b/csharp/docs/schema/IThingType.adoc index 0e72329e5d..965bcbf212 100644 --- a/csharp/docs/schema/IThingType.adoc +++ b/csharp/docs/schema/IThingType.adoc @@ -79,12 +79,12 @@ Retrieves ``IThing`` objects that are instances of this exact ``IThingType``, OR [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `transitivity` a| ``Explicit`` for direct instances only, ``Transitive`` to include instances of subtypes a| `IConcept.Transitivity` +a| `transitivity` a| ``Explicit`` for direct instances only, ``Transitive`` to include instances of subtypes a| `IConcept​.Transitivity` |=== [caption=""] @@ -303,13 +303,13 @@ Retrieves ``IAttributeType`` that the instances of this ``IThingType`` are allow [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `valueType` a| If specified, only attribute types of this ``ValueType`` will be retrieved. a| `IValue.ValueType?` -a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| `IConcept.Transitivity` +a| `valueType` a| If specified, only attribute types of this ``ValueType`` will be retrieved. a| `IValue​.ValueType?` +a| `transitivity` a| ``Transitive`` for direct and inherited ownership, ``Explicit`` for direct ownership only a| `IConcept​.Transitivity` a| `annotations` a| Only retrieve attribute types owned with annotations. a| `ICollection< Annotation >` |=== @@ -340,7 +340,7 @@ Retrieves an ``IAttributeType``, ownership of which is overridden for this ``ITh [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -401,12 +401,12 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `transitivity` a| transitivity: ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| `IConcept.Transitivity` +a| `transitivity` a| transitivity: ``Transitive`` for direct and indirect playing, ``Explicit`` for direct playing only a| `IConcept​.Transitivity` |=== [caption=""] @@ -436,7 +436,7 @@ Retrieves a ``IRoleType`` that is overridden by the given ``role_type`` for this [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -470,7 +470,7 @@ Produces a pattern for creating this ``IThingType`` in a ``define`` query. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -531,7 +531,7 @@ Set a ``IThingType`` to be abstract, meaning it cannot have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -564,7 +564,7 @@ Allows the instances of this ``IThingType`` to own the given ``IAttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -709,7 +709,7 @@ Allows the instances of this ``IThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -745,7 +745,7 @@ Set a ``IThingType`` to be non-abstract, meaning it can have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -778,7 +778,7 @@ Disallows the instances of this ``IThingType`` from owning the given ``IAttribut [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -812,7 +812,7 @@ Disallows the instances of this ``IThingType`` from playing the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/schema/IType.adoc b/csharp/docs/schema/IType.adoc index 93a74e0660..1650ec69ab 100644 --- a/csharp/docs/schema/IType.adoc +++ b/csharp/docs/schema/IType.adoc @@ -51,7 +51,7 @@ Deletes this type from the database. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -111,12 +111,12 @@ Retrieves all direct and indirect (or direct only) subtypes of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type a| `transaction` a| The current transaction a| `ITypeDBTransaction` -a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| `IConcept.Transitivity` +a| `transitivity` a| ``Transitive`` for direct and indirect subtypes, ``Explicit`` for direct subtypes only a| `IConcept​.Transitivity` |=== [caption=""] @@ -146,7 +146,7 @@ Retrieves the most immediate supertype of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -179,7 +179,7 @@ Retrieves all supertypes of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -236,7 +236,7 @@ Check if the concept has been deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -345,7 +345,7 @@ Renames the label of the type. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/schema/Label.adoc b/csharp/docs/schema/Label.adoc index 4489b567a7..0cdb412625 100644 --- a/csharp/docs/schema/Label.adoc +++ b/csharp/docs/schema/Label.adoc @@ -12,11 +12,11 @@ It consists of an optional ``scope``, and a ``name``, represented ``scope:name`` [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description -a| `readonly string TypeDB.Driver.Common.Label.Name` a| `readonly string TypeDB.Driver.Common.Label.Name` a| Returns the name of this Label. +a| `readonly string TypeDB​.Driver​.Common​.Label​.Name` a| `readonly string TypeDB​.Driver​.Common​.Label​.Name` a| Returns the name of this Label. Examples [source,cs] ---- @@ -24,7 +24,7 @@ label.Name; ---- -a| `readonly? string TypeDB.Driver.Common.Label.Scope` a| `readonly? string TypeDB.Driver.Common.Label.Scope` a| Returns the scope of this Label. +a| `readonly? string TypeDB​.Driver​.Common​.Label​.Scope` a| `readonly? string TypeDB​.Driver​.Common​.Label​.Scope` a| Returns the scope of this Label. Examples [source,cs] ---- @@ -51,7 +51,7 @@ Checks if this Label is equal to another object. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -84,7 +84,7 @@ Creates a Label from a specified scope and name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -118,7 +118,7 @@ Creates a Label from a specified name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/csharp/docs/schema/Label.html b/csharp/docs/schema/Label.html new file mode 100644 index 0000000000..43088d117e --- /dev/null +++ b/csharp/docs/schema/Label.html @@ -0,0 +1,710 @@ + + + + + + + +Label + + + + + +
+
+

Label

+
+

Package: TypeDB.Driver.Common

+
+
+

A Label holds the uniquely identifying name of a type.

+
+
+

It consists of an optional scope, and a name, represented scope:name. The scope is used only used to distinguish between role-types of the same name declared in different relation types.

+
+ + +++++ + + + + + + + + + + + + + + + + + + + +
Fields
NameTypeDescription
+

readonly string TypeDB.Driver.Common.Label.Name

+
+

readonly string TypeDB.Driver​.Common​.Label​.Name

+
+

Returns the name of this Label. +Examples

+
+
+
+
label.Name;
+
+
+

readonly? string TypeDB.Driver.Common.Label.Scope

+
+

readonly? string TypeDB.Driver.Common.Label.Scope

+
+

Returns the scope of this Label. +Examples

+
+
+
+
label.Scope;
+
+
+
+

Equals

+
+
+
override bool Equals(object? obj)
+
+
+
+

Checks if this Label is equal to another object.

+
+ + +++++ + + + + + + + + + + + + + + +
Input parameters
NameDescriptionType
+

obj

+
+

Object to compare with

+
+

object?

+
+
+
Returns
+

override bool

+
+
+
Code examples
+
+
label.Equals(obj);
+
+
+
+
+

Label

+
+
+
Label(string? scope, string name)
+
+
+
+

Creates a Label from a specified scope and name.

+
+ + +++++ + + + + + + + + + + + + + + + + + + + +
Input parameters
NameDescriptionType
+

scope

+
+

Label scope

+
+

string?

+
+

name

+
+

Label name

+
+

string

+
+
+
Returns
+

Label

+
+
+
Code examples
+
+
new Label("relation", "role");
+
+
+
+
+

Label

+
+
+
Label(string name)
+
+
+
+

Creates a Label from a specified name.

+
+ + +++++ + + + + + + + + + + + + + + +
Input parameters
NameDescriptionType
+

name

+
+

Label name

+
+

string

+
+
+
Returns
+

Label

+
+
+
Code examples
+
+
new Label("entity");
+
+
+
+
+

ScopedName

+
+
+
string TypeDB.Driver.Common.Label.ScopedName
+
+
+
+

Returns the string representation of the scoped name.

+
+
+
Returns
+

string

+
+
+
Code examples
+
+
label.ScopedName;
+
+
+
+
+

ToString

+
+
+
override string ToString()
+
+
+
+

Returns the string representation of the scoped name.

+
+
+
Returns
+

override string

+
+
+
Code examples
+
+
label.ToString();
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/csharp/docs/schema/Label.pdf b/csharp/docs/schema/Label.pdf new file mode 100644 index 0000000000000000000000000000000000000000..6489baf675df0aecf1680b3409d978e2a1e5e8cd GIT binary patch literal 73752 zcmeEv2|QKX_joB3Nr{S-+ki6P*_Fsx%2a3|WVq&eo;9IJWvYZUBbh2xW(}kw5lIO} zqKuW9|33HLbMIANq4(bR|NZ>F-|rK9pL5n(d#%0JUTf{O*WuSxR2D^wVOaRb!T(s0 z2nmF}u@#H7G(ue4(#3{|Sg&K}0{vmSfkj-wiD=|v?}S({=WJqWX=-l*H2?qvN(?PV z5J4ClITKA0_I3zOCnI+|(2Eh10FP-p*_*nW5U2f|n!Tx_kqbaUQ3@r2!bqS|I3xy( zL`w=wNC<-eV2mv7?IyVog&|PylaXN|+L=NFL(vb=(}9Q(S1@uhvavS@Xd0Oloe^ko z!%h})bt7BQAdnjxt}Zr~cA$;IkUOATRgH{^HlPbn>jDS^fI7}Z_yHDi4F{r~oQVrS z5ur!A6Cti_>9Q3ei9w1<67*TbcUcnMiB6hML^Glj(ar?C1fsp7rL%*Lk*A`)37HEn zPOd~2Fbdj0AUvs@A`OIuKVXu*tDOr1%_6?t($pD#DN+)`5`lt-zf+$M3^X7Zj4IL2 z+{FTcf-XC|0AAa&II=*5qckWa#L_*YO?@*&KQI9BX6O|x;%Y=wOCx!E4}_is=)e-N zVkk-4s1=;-9scs7ybY0P`j=O=oh)tt@}iuR%U@nou(xvo2s$GuOx#Iyws&=cDGny7 zi5AfXp(hSaXmM?#hYLbn#TGDHp7L9P@>_*OKN=@+bo8K*5Q&#WN=_i7xFXTb(uBBk zi#)=_nMFbjFoN>qY+}bkcU3`a!c{E=bru$RZ5E8A7?^x`Nt_rCheK$avWP3A#3T@a zui9oT(ijsQ5{JTJaV9bdZ7UWfZ599o(4F!F0fGO9enYQ>Ul0BMvHinKv65mq4E;+b z#IU5-VkN+9(Kuu9FCK^eTVG8;ieV+efa%|jga!=18*PM=n8q7%1Pl_QIT8i_fM|~g znuId&$*;jgAmGK&5;*KcRM7OOU@>?C9^8V#U{EL`27^c82zVS0i-%fhoEgp({ND^m zoCdlRrw2W+V6-R`0xcmX2~UU#^Z~>DcjyB+gvOx|czR4GkmnzooRSzZ9AN2$_fDVy zN&+Vd$Zmqe;L#`vJO;F|;5QaW1nfbA-#}dO1aKDt%x=&N?jYcBcmnvBh{J<^BAC~v z&@%uE4*Ux!il?v|^*1sTa8MGUhR}AWmvjk0LrIFzO&Au2fX4u2pm{~aqrp(n04Xp) z7)cxv`Wp`om;l`a24O-s6-bHzyoz2QOs*d$7YnkknEV=PZvHSFBpxq@LZTt%ML(no zGXx9+3If1YwU)MUu~L^+`SuweE<|Dq{kg@q_N0|fsbDx%S7F6m>|`;ox0U*WxrA42OfP2n-4u zH`&mdGQsGc6juhm5rQB_z>`fW3=R+rEJ)B|MdjJ=bTozovzZwQ)V?!1Kuq<)FY5n0h zw8~Rv8WyYHPN9&1M`VTg zSImOlzdv9W6;Ud$08lXrFhyp>Dk?ZCr(ke1VH6eGROtG9Ho>S+p}`$9XA)WxO<8dM ziboh=F+esRum*su4%-5M$+0Pj15K$wYwh2ovfzb=4jSA=C#%0FF^n5h42{816(9r( zi6hKZ0it1ORKcAD;N%K$hIYIphyfvKjxj}P0)Zr;31p=?(Tjv^J|wUKX{Ipb8Uv04 z(-=?X^*`>!(e%3nMvMSf9Fl&YfGU{sQ;HaY_z^X-2mU6l3e^-(v#O7%bRj0)cN3js>Ba zX+$F&0iFb$1PC?!_#5(A&>&g_1qHyaju;XPSxi_ASUND&4ja&c0&WojN$Z0q73mhR z!HkoHF2Efi1_OYYfM>{e0OJ6P6hJ`89T)-#`Vl|`oenCnsiB+T7gL%hG~6gXHlPP9 z20~1v$H@;-2}cD??V-FIfeOwNgJI|sFA$C3R__~EZUeVpuaPL zes2(vEp}+`LKF1wvH#(C4;?hPYg$U0h8u`cQoRYFCO}+hnyUxZkb*`^hDPn01mNUK zdWKdlo)QhEXm7GNfdvK~Zc5$++6?IF|ExcOMS_j^ztNw-lJ*m(F^gwNd73{V0anUM z{fP;Ce}67c)Ja8?D0;(!yi!mDl)o2GDm++#XbuJ3GcA##!kd~L{2oF2(UIi}?)jI+ zie}#acSsfu-~V3WqK)C-k}r62(Zq|+(w??-!O&n)qWTnY$FyV%hDH-DxMvbk_`PJ& z4U8;Ul#WS&O}dTMROTrsY@sM!5jXi)_7PP{50wu+@krCyruCnQ$OQ>~C}Q z!M+aI+XU%{Vv@kHhGr57ebYLinFMlyNp3!T6Rc8^AP|8e3nXdx3nL*(0s;vnsRPpF z5@5p_0z&Qp*<~OmL-NyMsAyp6LpM=g3^xG~5@v84zyQF|P?8L$UhCsRxLL16rG$V%{K{hgF802BiDESE_PKpt*=outG z(Leb^@{^u4SjdQATNWgT0n7o`c$5qR1@REP3n2|fBf;39EnE~(Q~C()ZBt5dClT|f z^e7ZKih#vP{#km|p8$c)(TOl-kRAnyA%+LZp?{R<^(R26Bbk86FGuowgPWps!G07P zoEV`CUZE*nbl$)e_7=(DU|Q3GgS+U!O$Rv;C8x&1z?lLlHFkPCDbyGMG%hkUYS$zH zr{Y}DQj5?MP`sI<0Z9i%ps|sTiu{eKMKDKb(Ga+Yj;K@M5#6}SvPlCtBQ8sv1QBKMguFI7#q{&YGv1#-xLJ zWMdQZ1i+~TaIgv|`FAp$I$Da!NeyhmvOO*KP@z%emIiGmf=q=r72f=w)l}UIi!$6X zRYuQTkYT0#J5h$cxhZp)cIE>GLIoHJaC#cdt?8ZlpnviQw?}$nddQT~`jfmqiuy)_ zFeW$;HJQ@;D-U_f=+RM40!p0#XEdizHM%E%q#Ef&E!lbhXEIgD(FY_*kO7G>v;Y>| zK_9?^`zVtg34(+K0+tj}CWWVf|4ITv4Pb$T(jdfzqXn=)zA6ZD0Y4vvtKa|@I8#l! zi4wqqn{WUNZqo&@;4U(IX)xh7`K53G3&si#V9}us2e7CEBL%SF))WF*@U7IiAKdYO zoNQB#8IuE8ND#s#;6Ts{+D9Q}4o{MYLXGx-=ny4fg(CbT(PMCYmvqLPgbvA@q(qOY zX)#mQ4!=$kqlg~xMSvQj6Fo}DggHd%gGCP{;eoSsbfO2gq97nt(E}M>5-2*!1BRa@ za-!gYgmdT?iri6Ju-H+WbW%s@AqyE59HmKq8&%{e*ic1|hAvg)-~o|Ej?$Wn$Wd;k zi5#Wl|0ubpCu&gW22_OjQPSuVF(v8Ke#mJ+@NsqMq&WRm5MhN6ss0n8VvuqL&d`!^ z{UK5eLfRmBO^T61wE)1Wb-EEqfMa~nQCm~;6@W3=X98mY5oOY;Qz+_6f3_Gt`wov~ z>c?au@unSrBcD{GwIRQWWacBbu}C1S-~)oiUG%4 zfg*zUn!z~*;I^TWQ`SX0Kz88Ia!z{d z4M|m-HXxwa?nJCNgcz(SZ>Z>G=|*%iRIspHnDdg{sf1_C4hmUk)4T!y_2Ymy~73s2zZmB+XHl*EKP}q#`g9$zrs?<(bdSt z+0f7sj1*8D`UPPL)o6moM}W@t>tR$Lb_iY)V_l7 z1``lG3AkE!I9U||IHu!yS~Q5q;LmPLHGrKyVrsOm+j`J`>H zV`pgsmFYs0r!K9G6I34PhY9v0rWjLG6A2^@(I31GY;$n12LRiC- z8X^iPC-wt5B``qsql9f8Y+Rj@wsxXUL~~agBd4k0iXqF;R0s;{ACPEI!xbv4G*JNQ zYl}^es}We3i1e&i0kzmHO{Rn^g`-oTEAY2|#FZo;kS2na1zgl@q8DXuKP6uYJ#<8!0*~m% zP1Z7W0I7+bGfDcN8fkyecIrf@vWnXCGwY|yDeCseFPQaD?IOc`qV7b%9n)hRjS4W| zC_$YW2^SUGRH*!WropICp}`$9XBoU<@z)#!@A#W`kzo@4O)87B*w90xbkVW=_e7yAL_(=?nUx z+CRfu>bNLN7EQNOI;JIPRA^Mb!s=@#Y^6e*3KxFQR2UU1G`M4`ES7wDh-A$<0q%i+O+ zY&X2*WQmJ38)YU`!h$T68D%=*=$`zMO8-*M4k(@rGU@TO!~wX2ekUC6qfBiaNV@@U zD=l#V2Tgtegqk=2u7MOCJS}Gj?5>L8P~aiDoE;qaFadNEC3gUB!pQ@0n=X3*?jommkCSbBi3B)sGz$2EbhZX1 zXNL&RErHJo(8LlXDuN^5U2GCz5a%Sp;b?;WqiDut>sK!6HeAHY}3VfssTKZcRZX;ajO933vP-C)@Ny z5-R-#lH-07NqSMFw<>7n<3DoJ6AP*qN`eE8)QlDC$85lk;2-Ai!2ZmPPIZEk{Ge>Z zOcHhJpZsCb|95v5F_4UcbiY5^#rhKV7;uLTfof9>M04N0O!NK6a<`{U#-?SeGlkjg+Sripb4~^0_EgsR-sU!hOQ-A;z`1;gL z6(9gghDH#>a!BRXeA)`X0aurrxGhr$f z+EjS(dzQkeP@%ycQ)TGPMV6|5|59k_eY6?GG{KjH!56#8GiZ9JH|d}J!M*vaLO%!z6k+L~N7v!Z?8N^|J`Hiv3QX8gnbQ1;4 zatx@!K%G!<2mOSC`zS(%!a-%N>EsYBwIm=^IYfaEr9r7(R5?U}r2-2CgI*3%z)XN{ zqR1iKgyj%!)5#&+MV31nOt?*cDJ+LDRp$*F+bzmepgj-XPL-^MJkqv`@X#tUK zdUA+@T)+w09%MPBHy@y{sm|ovOMfIe^yV%3OeD?xg_F-HlTHGvIxvZ;JF!*-sfY>r zbJlbv=|L~_!I6pI-lgp@LDm1@3W89<6Y7ai(g#$hf7X+>wT=XbpRojTU}}1%1O1af znhq0(JY|dK&&y+gZ;nBk0(ANuvY*M>oV28{DI-KjCp1_n0DBkIAs|%M4ytTG$DOE}9aPYefXW#FH4c}< z05vqATPS*+(t_1GrAepNDLrI)qJpC|$!~*II*bjh(&^BJRXTM*B$W=grl8W{TmMHc zh}+XuJHI2-{FR2_vtQ;(8QII2!M`b|3bNuvBtggE)II#~HgsXr4Aev(c?PjWLF#3CSX zapKMNhomW|L{XsF?Sw<3f7ek^;0{RO$bv=l4D_V27*KK-GCsg3H$ll=Gc289G4+zW zQ}Ge-V7D1;t5FprrA@z#P`W6q2p-f=$AM)8vh7K3IQWhj1cADU0J9%BV6;U9lo1xg z;GoLhv{eKTzBUH#p{yd57QBj3nsloOrH8z1(BQ#s()-|Lgn|ydiqN48uOjexNQ(%i zF@-gRa_9djHQnU{j|Io5CFw(Cl;z{60^mRT1`{Vf$kh5L>bT&MI5ALyg)D?5eFPhr z6K&rA&&+(BBw@ng^r^cw^iTe1zD^wSl-I;RH}gSF9MWNQnvDT-0hCO~k&2B&-wq~~ znxmg4Q$~?y_yZsyUNNKGW4b4Qq};z`_=C?Nf{&g+)vhVZ6Yikb*l-_3LqngoMn>sL(?uJ`aP~PyZ|05gtj6G!vP2Uj!wf{jNlinAf#1R0W z{H8ZoAg%rHI0AoH%_{Vib;{(f0H{p*U+xN^C^e@3fvQ!1W&M-YDaB&|mj2JK01{Zl zu%j@+6(E&IB3bt&%2Qo|$?8@C2k=MUXt=uASlSVtf%|3e3OqGXwTM*41_4TglPc9f zHH;9T5+TJ&p%kehU4`B%EsYS@wsf%}BBafTW@Zu+SS+yVi4x#L!r(W7^4kRb4fSKd z&?qh;2^UZ?iTqj#7IAf=2lYjyLRyH4MQtVwh*mC#gxaK-V4$}m!4Hb^c9UPcUDJu^ zMjbO$#%qdir!T6b?rQ4{xwa5ZG!g5O8-UY@<%*Q;ooqpEtG{%8;SxYN>@R&g;DA!f=t1FPI?qo*YeIoND0ocD zpqW@u&+(^6BtfM=FhcOfR{G!MT^>?Bdh+@R!gUg)b)LN23ALaUhsl)=$xWtC0#Yri z|KkMt*^Nhnx^!T}4^$;1+L^mpAi(wn8WMIJ7ornFPh8o?$c3m#gbI?8W+kY$Ml`Zz z@rcdyWYyNIjcOzG8~DyTJhyGm(TXTB`2(ls&RaJ&@6;^rnD~Kt^^WV-9yDEhB+Q}N z$4W5z)%>g_f@2uh_DAARzI`B?@vn*acqa`l{8)82y2}-HqP`YqYuN7g+H&{1ZS7h1 z=c2Y8_ZZ%%Z-X!usKQ!zz9g7;`F^i6A20vNP(1IVhznZ z&GFW`CF8vE+H;;e39vt`OFHkXu{v^a`vt7pGqo+}#=h71D;;e(c|zFccCARynnY2IV8phIJ`HVqGTUF=d=pS5Vwhm=caHoI+Tyn1o#$XH2Q zu<-10@4}B}mm&g;;V9cPfZm<73$*(Q`D$I+XW9s)|mL`aP zwKwv6zU<4n81{0d@>PTJ^RDtSuIyiJEPVP)Qey6SW8TfvvX>TYSW{8ItX+oxi^c;c zK6#aZ4_uCn-P;xi>|{S4ab9=!CjJ6M;s-8+7efiB5;!mIKE>t9TIM2h;=T@3)BQ~dO){=N9=dFl6YVx_1`HMj-_Xm?z ziVIxlIIh7qZ)IJ&>*ym*#y;!Dq|H2Gi~}NxhsLm0SM|ac54A@xV@$h}o6fem$1Fv5 z*v74H7rPRx+ri75uPENjM~iMU(G&P^eZk{f&Q4t0qNK$6oaR{OA7~tpENME|ed2^i zU=S1Ykb7raeP`#FPi}-9sg1l}Y*R#^sfDt+>G`TbA`; zS0q=uOJ>B{%86bRs(F}k%sr0Ro2`qdm%*p(v0D1ElO7&|>}aBN`23^0Sl8~^ZBY7H zApN8(|2_7ArTQ|0rFvysyPEGE`gBd`cI5fl`*Zk}49@$;ur5k6)7cWj<@h0cat7jQ+L-LizGhbdFmfTe?DrQ@sCHawo{j!|+ z@q1ZA?=&np-Ud69wVXDJgFy|SBir+jJR5{^91VBSObwN!N7v(gQ2$XUO+pnU0&D`Ol3UlD#D zS6FpNyMBa#!1~fp?Jq3^Zzq*#E6L%7RTr$ivTjzMwf^l@ZfqBJAOZy!7kpftcGEzt zRLx;Eu4(yKj{2kC14rkTH@;u{z}0k4R{7pWfhz%>*dvnYO55ri?sk`gO1duO#oT*q z{r2;v$c{b{j;2_|qJynau zPMUn3D?VX#iXPS8eb6Krc$#-$euY>U{)59QS!At^59*Z14C`rkqtdric-rytC~8*9cfT+`?BHQ z+2{PHxc3C8>9C8G>A&IYQ*|(NYs=tZGiKybT9~**bA2ppB=3b>7Ob*H1drC{`#s~}dXz0yHfxxhlObS<1=u@o=v6 zspP<2E$jJ4=cb(AWB1lOq}TU|Y^K=BhTDD;Lt4U{+Vy1a`FIgBMjCo6PWxwz+|3%Q z>3H%f`fZo1>3%1?Z$w)1#qV+#9WI)1Rb5W=JFt?kaa=9!v}8kfp5xchD*JT}18-L} zuib5!=hY`9I&Qyb>|WQms0e2(9V-njeXu{o}G-*~@B2BpQ{|4fi}Xl+1i4@W0dj1wm?!&}}Pa zon0*!xYMC!DK~fAF%E5BwPik!ubi8fa^{oNCw7n9)=M2SP|993C)z`T<`}oCIJe&#})-;C=FhmX%7dI?#*nZad$ozZ9M@}{> zGstskWN?RSe(&Y%eYEU&MgZfgLqhEN^EtO38*17v7rIn&w^El~ZYHXJ$80a2i#ok( zS*hwmJG=d>*N)GP5zjk#<+%6R;%jq zCoi@ZnRsWNJ5ZyQofxmR`%^-VV*f!0ejZ^Z5f&UO#Y;(}dktb)8jM^xMzQxoH}>$4%qdeH<^Cpm?`*^NcV@b0tDfrYNU~7>dUKD+ z!eiq*i?_C~3tIP%zx8sqT#!qt^tllo#O|1sOa;#vw|9PP6;~P%#O~e8-Sl82*qzI2 zZiwNW28Juld7G^Rt7`PD>l24QOQDGmzP;8}j#?W&=d4=krP}YgVI!l4DWAEu&Ty5r zC=stC+k2l#_Qgaz7M9J;Sj1{5wg0k=--f}Mf|JTGSURq^#cNk{UU{Y}!Y}K|*x}fd z@b>)~|2a8po<8wm=qtYAC0c4*vdgRL!QI%R;{;9pq^r6;0pUWp-Ru0fegD*W_Bx=L zxQNzCB=c2`gzb8-Bm7VJM~Qgs(XUJF<3G9O${@Dot44A=OO;u8$*AvPm9Ge0y!m|j znoz9`1pTE~pVrj8KDsJ&Lw)Jo>UW_V*aGSXni`6DZB~Un+w^ey+mD^UGUHw2KMk~Wq=D;99Tg^CH$vErk(#(gPt@EYJeHtZ4lZD?B z9=4PP?dI%gzSmvtt|7Vmdrjx7cRH6W^J}rC65a-WF6OEH2GeA|QGe&R*(@RNJau*_@g9 z@Ocwb$1dK^wyr)Ynb+6!b78c8;L4KJXS}&S7gDc`Hn_RQCEPX6i4*@SD&-{o~V(Cu&2P^TEd*-d%eZAvjEMIJVWWBxqDdVHZm4UhKt8O_4 z)$3cn!H({K_o0^EwfCOzX7f#5Tdurolf86#f%9D-yBEr;*?s4AEnD*3>fV@@5^pX= zpRNC-QFeBpLd;+hoOZL_Z_#c*V$>IayDO zt>Q3)XOUZKn|W=W#E#dF^`#kvFWuu9TAS=Xq$hUN(za^eH-6hbO;GV zx4bW7vfcGTTglqf?(WB?O4)*Si}`M!$o#a~aN*ay+2%2eu?bGc+l(96#h^s=R-Zn~ zUxQP1DUml#$;=wMhiVP<9eNd>w~WdzIX7JTfl=3Jfnm2%8qA81t_n4&K z^GrzN?|wPQZFr0|LaqNRcEhdZOjVegv$`%$Bb8+(DGFE?rDvMSFKu_8c$bCYOxPl( z4SK& zRE8pJ+4GLCqQ$R`&-F(KyGPrLtS=sRT97h$GT-^>C!eqO3%3}0CptgWSg|kS#E`z7 z_lZ2IZsJhulQYA7Jm`1jZybjnWmL)f)w~^hp2=KXW$tU%e5<+h`oYsXCCe8_XiG3h ze>}zfMIq?Og7)QRdyvS=!k5nft?u#y6 z_>O2cZry)6D+8sav;GOrbp3X0@42M3Ri)2AZMzc9Lp00liAcKT=iC(?Q!(0fIpM^z z*FvnAm-;Q&;@rMJ(s;ujb4$3Lmnly_-g~%*nLW?X^HpCx$CkWKmFV(a21X|6Teq`< zonmkyP1VY{-H)%MZeD3OOUSYLXd<)X5$5!I)>phMt$Fu3yz{nuJ@)i*UBK}LHPzbJ zt*>V%wuBzmvP~(^>-6(IufN4!zL%Kzy698A=sCvBmwU9ei8?J!@yob7 zv^|AcFZBg7iEWIrmWaegwtk4jiKLzSa{OFMV&&Gg*@oM`IHWi1_Y33c&6{5?E2DZ_ z@ovjt#Osv~D?S?%d1C{lkUsmDzBd!ux$M~{{Kh?gu6xdIw2za*DBa(EPu((mr)oun z!pZ%2ZL^fa4chHW_)~V*e7O~>m=Rq+p71;c8);%2t+GoKv*}BnufSdZMA@r?11bj_ zPusnFA^a@fwb<+N6Im`*roCJrWS68HNbh(4{`%hAp=upH73J$YpWR!zX+>G=M7KDPmbv$_+)f;Vcff0Pvc(3g6(`GIf8G6tukHj-1RKI-dx|L%cT>R8$Cj-(CUhR zq`U9=Xf?aWmei+MT)F$k+S>3xCSSxlF1*(SxAKw*a`A{Pdw+Xq} zW~G36*Ou5z_W{S|SeO^;KL$%G`?9N!dGwly}_?>(QNjjRLm&bV>u zwyzB_+DBC{WV5**PHWeyWxc8P`g1(t=x6Kf7m=Om!>lE1djwjlI&@WeoEi&Pr`WXT zBv|$q`{j%l?w%v+a5~vpxLYYH_2tg3C)SPzJ9_!}=t`an51#jiAXJgSwc>c$If2xN zXWzN@j@~l&bGRh@?#13{sTZ=op}Z=KD_?wD(dGAUsh^(^@!+YTZNYD zDlZb-cKpJoZ=+F*k+s@M>Md_-g zNnHKhf@g6&S(b@ee&%Wheh~$=&ZcjwSNS`>7=N(muD@OXk*t?j9^1!rJ3f+bZ5R<)zZq-Pyj~e|7E44(^c?H*P=Ft}@x#8dV?sa3JvJ?JUXR=%Iyn_1S6f zyUy~wvJH#6TR!T`_2}XralaSZ31NzMhPb_~>qf>x_Uq@*liIAB&N0GG=%>&YL~%lS&0kcu3wKo^Cy(9l;mqK(~!wa*|R(K znwQ?bz0JIb4bE)PGTpYpN^jRv-`KFDpT<_1d9Mqx#;A{`b@|&{^^Vx2AwT9zy~|iV z)U!taM4Q8v2a&d6+=q+ut_Hd#??}3>`*r7t>b+~}h-bxN&$zgneBH+g)^gV4i4WJW zOy^Wx&6MA^QzFzQQRe{ntNu=|{fl1*nlbJ<9@#c~_UT#URSY7GL*cU$in5<&GfJ+E zt~|*oIVWoWr?_#EWhRGbnK#RP=4cer-WC3u23Oo_=^Ar)wP29 zLWK*2t|>5x$a{W80*Dp0bC=u2ewCf?z$0XyHQzz%_5JGk4op@iH7>6LbtoaWZa)>d`rEnK_=O7EEqKC>x#x?rQ~J>$;~5=&!cITxHA zzTC6EV}5y1g4AX7!MMsgi;-^L?kyu#O?8$v4;qO3=a&e$h)D9WZZWUpan4N1dL-3i zkKtH&zQ`p=me*v|#;1XAp7KZ^^Q*RMuS^;AN2W{Y<*XVNH`mJfKlpTVxK7gpx6q39 z>;408-OuLT=iQ1dIatRVT=Map$m!wEoC@h@8fNE@D~nVW-2tA@Y1g-ljU+1;g^15B zt_)k0_-18X=&kc@+9NXKKBrzuEIGfR{L%jMfV#~N=R<=I-6+XByz(q-`L(m|SC(IY zm1CELyrsv=dc>q>usfeIJ&;j-TqL=pJKgT&i7%hK?`+cfe8>BW`+k=rE4!Aj>TKh4 z%#r?FC{d4n-sN)g4)f6L4zrCzg0E!U3vLCo1 zNWEVf;ORDdo!p-H@km$Eg&B_ryZ1?(od__0S~+O>WOM(*>VQiY3s)-ltv`Nk$GnG& zS+kE@Nq(`K-F~oP{d058MH2WM-&OWxi+pxRci*%aC{J8|lJO$jp&JUC%m;4qDVJPK zcTiyKbyh866JRl!1L97%e8!EQBlu+xjUdDqe6=i8)65DlYzXT~>p#(Rd%5OgRgqVw zOiye&lmk5TMm3uYKLsJ>41zpeW?AeocwHkikexa1qb}Gb*i5+ea^8Nw^=x$mgcLoD~#@ae2^{t{UK8{-$lu8OwpK~Tz^j*_nl5%Gba7Zh1RpB=jASy zbK<;^vSkbIncr^t1s1FqSbK)&*|YUH;Vbw)nkY%HVBYYcs%WF**@JEz-Fsz1j>fUh zVjft}VJ$D6#w?vP=k;vAnmV>{cbik1jFBl$7Xtg+3%1;v_3qK&f_i4%hm4~;QKLR7 zhjp5o-gnMEYih)tmK;=T!h2zHHLLDP`R&~c_lV!u?4Q%AEavxlmgb&45py=X_O5*+ z9oyc~y4yhZ+<`21uX*fYE9a){Y>57tF;sIJ*q(q&?1kj-szEVSymhIGNW9z}&kMD_=6oHw0$Ju6o=J>plYZWp>V zE{oTkOZfS#QlxLyOx!G+_%$2y*KMHB=pg>;i#X5&VC#qoGE^zM?0k zNQu-EMG?S`w1SbtR-&c31-OdAf%YD_B|(scHZLjLqNMNWzypJ~H$ic{sqAtQYoFNF zD=!ah%1f1h;<9+Fv%u{8o5SpK+h)6Z&vtg1TOE!NW_{;7n78DLrFG#W@nf-``G)sb z`wo2lT2(dZ@{Z3hN59>{@-+XPAJ;zGAv{)7>+^PHRz&=} zcb%i(K1quW2L-)t>i=>-d-#j*cvFenhEdS2)$7Qv8YGT4RcKVycYGAD?Jyk8jPDwL z-`V5%Zs--$5W&#@ahk7xto8)>vR^DiB=vivi^Ye2+d_m3#)C!_VVN^8yv1J zweIHeWHVTs_REV8ty?lZQgWB3Mb$QE_Uh*DG6<?IZEcZ^x{% z2k#}1*q=GJ?$|aC6^^KN;p>D{)~RTRZw*ge7q)JP${LkR;fmpk{6F2G7=C5lv2`jc z94g`A;3-#`CbeFHT$P3+_{TBb0-j46*4Y=wd{Fa<$enK=j-PmOS*}hXqkWW7ksh|^ zP_|VTqrKJzM*AgBMfI5aL)p%=8d7CMJaUS~JvQEI`qF;?P&OLbQ2xMU+Z`%&x(c($F|u7D+F;v|-ulZ68&eH94kL?;b1p6O)Q`GY zYJJz2Gk33=s0S-??Wt45ROYfeLr>w3ixzK!@zz;V!^z?onp;|RTd>KdI-{93xvpMV zyQ>9yAM@*p@&o+>T9!VGJ#*H7<#!Zd33oS%A z&#%uCR=s-ft;p3wm@P@z2I;F`Lj#IU6k}NRo+KpoToiHvf3aCvd%J@9vEyGZ0U_3wAnqihe@obyPRIw!DdpRd}j(7QPs zMi#y3Rz)4Ty^mjE>l0;s>&t{=C1pACCsZHL3kcuPYSnt+QO-7`6#o+TYg^x?No~^V zNE)xd${WusLM%x2N= z2UaKAA4JK%kNYm#Ij$ltKjg2xUckDBZ=TcAFs{{0D*0mL`kwiXy2LDAUDsdqNJjBd z@RFdN@7bj@1T%)TI9cx>=qUMECL_@GF1SxxnC}P|$C*2`f_FZ+P|En_ir^XX`^z;_ ze9~_kHeWi2GhmF=I$)rz(#98d^z@5Lb&G8xMi-uD6clT0X5)xkviCsRiQGDWWs?CD zCS=B%z$K0g?%P%#KbLdwTo_xA#cJcjU)Q~Fz3jR#rcI}L{)I(6CY)DzEOgMFnTW|1yH+P%DR(?W2RtU>;w@&G(-C?-TI;Q6FatcrD*R#Jq z`@mmuf&1*ocTBc!+r-_okM~q_%G$i)*KKBj0m$G7;afKx;tiHVajvLbrqR5dpJCPt zF;A!9HCWM2YqgTf%63_M*q%6*tT2>2Qt-BaJpM`Ra+i(6!(QI^a-`f{Zf9p^fg|ys zL)pG%-Ftnm{d(D#dZDruezS;5&Di*a+7=dqu3Dh{`N*@2_=H2kwmn#Lf+!*6HcxGp z%$5Ell6lWx7$b;9tP8rB0tFw;Nw&PDdbD2?>38c2+q#mht*_UFXJJ)hAMCztrGV^O zH1HgoQz+gPx5@5;#_Iq%nXiklx@(@Rs*;!Hysc|dv=Jrn*=L@&$CkuTg%2*>H(~bO zZA=W6zpP=lUU|1^#^y&1TxHA5(i%r}Rp$%5+u<1?_rl|a?a`Nn+{+g`S7qN%ePPAS z_Auq*+#>a4&9yq*9QeR>+WfLAs#^pHgdf_A$Yezx3EZUQc)2*yy>z8<-gCDwR}ryQ z?2kj_84qpJcIam3mT)pm+>^dhUP;l~yGvL0ONV~*sjX+$b%(^SS$?9s^4T+9`^dF5 z{Jz2S>gIOp@3Y|;xTaKb$=$N0G`&!8e#q|T=B4H<8;z>J1n$}{oEEPcaBkI#1^k`@ z4n&u9wY)DEBhTx1F1l>pESOt(us}*KN9}49duo}BzYZ482I3w##=n9mP`+*J$&EW( zE7RM#Own9yfy>#GJWVnMUaDA~xKVQh+duDsnRmQ5^1&zFEsV?q14r;Krpucx#ShAF zW#RX^_JSqkv6Ekp<*BmX{W=|O>-ac66^TB#GMRIf^Mxt$*isIekX)Iaa?D_2 zSjCeH4jz~MnFUarXWOq|n8~Shq02qU#tmW9uwMCuu-TH^-CnaUscZ}oH{~!>V7X|- zreS>AZzq)c+xBdIzazBx2Jic~Lbj#2c|uH#+4iUA@_XEB+$5p4 zJ%tq+I@-kOHhwb}c&RR9cYJJGSro$dl?yNFKnr9movh48OD;(LC*0nDP z*5IriQ@hGm&VXMns-3p3V268@8%fH-os{wZjTqu%7Gn@X}*WtFJFQ*pjkZ zvG{G4TIwZX#$(GbK4vvyKq{;?>j{3Qd?{cqbHV!CC&XBMJFSG+lAj&Ee)vk7Y4wTv z;S~!WrgvlaE$&{sX}8TlSbkh*?fzTu`98T96z{)QSta4YzpVXDT2FeKrkKK=BPuM? z8y2bMX`b5Y`O+G9&M1+tfSh}&`BR)GN?`3(6vO|^^t^pA)O_{>*i zQokSAd^kj9VN=zDIiI7yvBU=7%U~dcv7KLihdY)b*0j-w{rvK{H5yNIZyt)>zI=;8 z>FJkw%?nZ*?+Z&>G6vwC0t!5Juk|(WIgHP$Mxq1DP{FL)Oqjmx!;@G=f1RNP|PfD{IGuI zK3}w!^9Sa$1TRM5I{9 zBqLk`lk)wTyvrN)%y*SbWTBUD8{y9V__besJfW&q!#P1+)_dsDC%uH->LFXBKY1;$ zaKC18$l>Fl@W?a2UB}R|(Hn$$=4W48e3<*)ijwWZ_ODj0hImbimZC6c60PO2*tg5~+q~PBHqRPe zYq{shneHXKhlYcLU!PegoX)=eo_j#|+SU4ep0B;!0w0__a?1ImSU=ZsK0ax;-gQ=` zcI;8#?<$=CT=f0<`b9W--q~w53~%GHTE1W|L(v+qro!`^D_5;wcCk=MP?K}>VwTD+ z2ub$dqQSwpvvW75uQ;+;T4HO_+BNfe)_66ZbohQi+E!Cr@k7W~_u0L(&34S{TvN=# zNkn8YTrIY2)RD}58e+huUmttb$#&~O_0_lK)zK@?8z~KpTjE6Y`TdUj9opAc5$Sdj zi8;CI(pQw%GMV8fh18C={xggK;sWPzT}Y(BZ1>`#58Y+Pyg zW5=1ce~mwUuGE#QCY|?r%?Y!E-qF2gm9yF#E`8n7M)-<&9W=DVHBw95>sxvDj`lLq zuPk1RMV0R6wOK@Zt#tzXe6K40rIgj^5Gqft1SrW&~(%Vj6(%2luAQP3ysCMC2 zoBOLk_GUacch!Tr(c7OEq(^-g8P*az)90}L&BsetmEO%edtxQmg>5??{&8LQ)xj4f zSF=sZj8}yWZsA_L;`Hd5J=hyQCJrbW=E~A=`z0byDf<$ltV>?qBrZYU8WF8bHoVQ| z%y(aE&yxILjbf>o6Q|U}3b)?Ke5Gsl;Rdng^iJ$yjn?nHt9rkvKdJn9<;$ybd*O1I zmwd5pT6YI7S_KH{gy~#Jx~_&_bVK51V}JBg$=aLquI|Z9S}MR*;NQs`z`fF7a5-Oq z-_AwX*C!K?_G-6jlp;|#n&DfZ888_R3^SgLr6fp5QP8*|Eynqcd_4$Nnx z3$GkXs!9B0Q`#o;W=Z}Lf7=^13EQrS)x~MOdfAbkj26{zQJZu1u~f`nVo%)4p7SxU z%b#USJGH;rKahAcT|R|1UN%JIGr{|_gVxJcL8-U>uL-D|JWlS-Q}s`Jc&qJtT6P6{q}iU~>*wC= z$az$l+Ba;y{S7;&Lw|JR^&`zIO^OcdNNihxmvzJwh?DY$4-=my^UtVvqzNUbD(GZfWBc`JAWSh*v@%iI} zXSfACqw89ND^f(88U|43#h*sr-FLtD%~#oG>zwnphk0|K@XDxX#4?MBE1OumK1fC| zs8*w}C!`qWcskoxk`9>l=2Sdq5M)(oe!2z^FfYc+`Zz&B58OqN+!gX2hA|hw|Dh`7d65Ud!X(`*Hp9=c}{hm6xvy zQRe#gc=^+020Q$=&8~AJFfTONo_gW}#7+)nzH|h;_Y8I7Z9{vuWJxlu@QTgMHyc%$ z(7vhEe8QbaZ{}JT@G&aeIJO z@tD2v`f*I&&HGwkyv^*D?p*hdSG#)sU9HJGt%xX{_r%`((c}`IsMf#{*07ZHP~+u( zim!Amvd&7~s0$VJJD6FM6f)+!%sksZ-q*-#XfVmC&}F<#?K{H&cRH8tYnKNdPnJs- zNZ&h({GM?pztw?v$laj630eO<^-Aueo7Xpee`BAY{?T#ujvdn7Y)Ws}c1e5oyba1G zo_5_EBm6AYOTVW&`Q%vZvbU~|gL~zxa0i=NN1b*j6|~n}wp@AtDA%W@zULR$HYWCU zKU%pn?9s!;A4~6xUs0(_UUPnf_({ohDbW)|?h`fd103Y~^SvBuwKXm$2y_$aT#nGwz8BhUSu~FWfH$QA}k>L4sTQ9@ZHpXOs zz1r1NsV%cy@^>v?T_==Ku|B`jGu>z*XP8PDM|4+u$YFzWo-~nC4nZNUsDS_1-d6y{ zv2E=_Ah?8(;1=A1&oB@)xCeI&?l8CqcXtl~0)Y_Rg9UdD?(XjThI3EuIVb1dcW?c# z>eZ`y>8hUHz4qGDyL)=}?Deg0AvNpF*e^AJD%5BcSMsCfz>@jAsDztC-+A43TN&?M zb&n${02#^?$-#slCCk6Di9*#$lV!D`K!)e)BmmSK9Nw zN%T_|D96*TwaaAqsC3l^_tT-xq0sSOcvf8@PMJ!4=2)&#{wk^7z#ZKAGTG|7jM9Gj zYDa4xa!&=o$FIwto2X|&uf?E*2KP|Rd5X>1VJ-pJzu)5P7hUC=Pr{<2^gBA-=!6R6 zF8J8@drtb=KJ>xYg^8)iz=ay;DC+t0hAw3o-bdygM@3a%&`UF`;KR|ASdr*-EnF#E zw(=`xm9r=x$+{^k`%Qhu%i+AXk2(L;WvyRiaA&(L7}C#XoyR>R<>1}f0Ly{OiVie< z|F-iGsE(s~Cts=WVo{(Tjx#Vg>wbAE(G|&S@XS?Un) zcg&)soMG%7@1g;3j4PK=W-DJ?d|(+`#hZN|L^T1xMQ_`pi!A+eR?vFVo2_xTDBP$0 z6%*QfV=6qd^|9G(6ZczI?pnvfhJC_}a|D%vqawxE2D+T6G8#qECOfZE*M`$xnaZss z$EWk#u8(W98}EEncPTK3S>41B4y&s)Fh?+0WAfV@J{x;9VW0eR#a)>z;bdUce;dfu z9YAEPf^5wxy$1}noo;05_cQ<BD_zXoKjOgD1c0cvrAZ6{d zIK)^)-3~!jQbe00Qw<%2TLRR}Wcv>`r93y@+}>Z&IWzQ(hFv@COiV`>TE4de#9%jI z+$DVM@VtaIXTlAS+2>+DKXS7_z3H*FWqeFa2g4Y3r%?QbkU3j1kx|K))&Zoq3JR_*kJ zEptXwq9d21Z@g+LWCD@rY}Nwg1)4qR?1I8`SBBE^!na$^*h{`Rf!cG2@25X^vy$h= zahTCvRTYd>p;y`WId0Ik6A>Gy?GEl6JM7W=z~Vn@o5M68D4cN>&dlGSVa!`t?r~(t z&J!nie1&97!#L{bgrD+J?bI|xps~=#jUlU=lijLrGBR#tki&f2<2@DePM>-WqR|i~ z80$O#STbH4z8nSh_a!6=+P<)1oUkwP5sdUS0~@Ip80kZ(YY0MObv7Con7Qh-b2Q;0 z7$(zbwMhvs-@QFbxBG9v>nltf?9E?q$i{__iwjk^+X0T4Z#5nZk>3cYoK9T_h`ToI zu?R99<;I_UpQ^Vvjms2%$9)W^dBmt#`HUPdAS1bzSS~Q$tP@F>2sGi(m{c&<-;VNn zY2N4Mif`-(!xs$JLP(b$GK~&A@j709w&aunEZt89RB}apCxf4zT~&Y-{a=%Zca4XN z>ERP1UMS|&s=T4{=WVews-oYWQr6Zbuy#{zZ$hEMf{B zk-`ycCqN!FXUvK}X-%fRf`g06ab|IqPX&j6c%=*#%!UeQJh{RdgVPxGnSnXZ^bQ}0 z<8qR}s$MFvq;KDzmHYOYSgCjbC^hQCv=Wk$3nc*%6h6zp1(t%|M71 z_qo*j0DjT^I|V}mH&9c)m+_V@d;lZb*BmEp>O)7`gx)Nik+QRzhADL831KGCJK)(^ znjRBT=ce`OH6m$ojK?c`Mp$4|8zE*v2&_H$!l1l72q6xb#kGNj8&YqwN97VC1Y_d??XHIcj(dOE$as-27d092@ot=DX8d`l%yd1qZ zJl8g{@tH5AadY%!UpkVAcVwFGUCVN&bM(xH4X@!Y_n{~_ON3oo(vpN2-`YOZfpeBWCtpIk&uFOVkAyI4!`=10;*tAZ$-?a%2QhBT=t`g!C6s&rK}f`ipGipOmQhU_jQu_xhWIIHTM{ueu8~h z9fy8wgo8T{53q}aX>@h|!1}eR`X#fcKDn3beCNu<3Ib%%a5K)sTc{1)ZAW6DS)Mdm z89r<0<;FdMGjX2rY+`2@SWr6{7&ttBkEnw>2N+c(ctmC!Q`Y?ljM{N36hdG9>pGeIs|A;XCwaW7MUHQs~VNObW+W4N#;jaA+I3~%%ZmvObn#$E7M z#2cJY1G14jzGM8=&Z8oiF~*_dVOh?``;Yt4^3pQpkaa||6HM}O;U{sOjyj>v>rZAv z);}mf8Gncikj2rZU&Ys_`jn$p?L)Hpn9jYtk)s^l$z$+PG3#zR-lHNr&BgyBSmir9 z1!H+d3#+I_(tA#C*&>U0DlQ^aABH=kWD#}~G+_Wf4JCi%Ctt-G-@RO7GSR|_UWCdk z{xMhs;?Cp`$+vv7b*CrsbK?NmckJkuPa4lhhMq98%U+TQ1v&u{)BgXZKHf|A@@7DAj%X(*wb{UJrh^c2uh0UHY`ReNeQ1q0Y{ljrRq82IM?6}LIQOp6y&v)tW2B9~ew?xX& zeF2>^d8>gpMC7R8ERAfDOC|@*&lySz&`unD%B-#Ybg4Ph{M%@JCCK(!M0^eC2M(`W z(MZ^*f*dkmBwL7Kl$Cl<+@q58MZx|H6vzYX%MU!A!f&h^{~jpFrmwHZ#7rk`WoIRC z05&oF2Z-=@jNtEFGXD}I$N~w%#>~XV{(lK0_-DeFUl_q(7{Ol{!Cx4`Ul_sv2}bY- z=ksqEK?u7S$$z^)K*L#?nILpqe<}mP83KOn|E8|rxY++q9t8XJTl+v})__?gZm;xbKKSdPp`Vd-& z1H#}2Ifq0fdAN2CNO+J3Y~Vw9_Xqvo%Ca+)umPBV!w^1{d1w<74j!Td!5%(@_4zl~ z{!9L+=ji{xG5P}|_-9(U9~eOZkOkrZ@%v1Nm7SgWzk&#=xGJcNxMb8keTsvE@Z|u8 zesA@NMbvs|1f6J!A{|Z@feaeDCpuE!$Jg(G&ZBh>WCr=H!w(-%N#~ZDHNWks4PLfP zn+;>%2110fGNMuKrr#;+?76WXUwa(8&%3cY zG9Zxof`>3gy&TZczT>}a1l{ty2BFlyx?ydY+~%#jDMDag9#meKPgqDC4t?RPki?YE z3cye9s?)kB^L*ZJCoVm>^`7VDw=P4s($m`ro177SY{ zh&*S*Rc097$50;~fWU+|H!(-5iT7eS8EIkgM)Dcoy)D~$U)P~wXxs3dx5YAYC5>Oe z#}+z4ac`XQ#{`cy$|~*(?hL!QX-5g{h@eD!@X45nHwFtcABMD@(~NXy&`!zw31b*M zl0wNra7S&uu)RU)ewRspY-^kmWx8P6Bx#5hlNQy+Bz|!X$2z6dW78Q9vU|ha5X+Y( zj#+6NA$-WT6r}iO?LC3lQ?F8}RRe1F%v7&oq#X2MsrZ0Q*!Q57x9VOdansps-ELvv zM(K8ZD`r8%=H&fNGr05l6F-!4IesY?2INe|NsfY?bd6Y% ze78PvZ|~Pi>b_&|E4Bx(mZDK><-!>;yXoGn-gBSd56B>G%I6g`DlVU7yPP}AiyEt@ z$bEN7{#w2tnBYp~hrB(8C#NznE44a`Cl}f(>`KgCb*Kn!1se+#M|e@lRCw zUz>=JzG~lmtirKQZ(H&_#zJCE(K8UeR*hTM3#E9i@a^@W2i5ks-W2a@XV`i6lcM(RFt5a+OKf zSm1IOXmdkySR#IXcuRf|*~SZg(uw_Gxa%2D$dz1@^gsws#&N?2 zNkLS1fS{fx3D@E*lq~+alRSOudkOSK{cim|(sT}lE&7|WrcY%sQkfu^r<$*;WbqOf zExEk1E@*BrZ{R#SW0@QbgE=~GVryF5TC<-6kOD~GgL10#t8*?SyJ&?B0$AR2!KNe! z)N8hAcsu&wy@>H2S4d)e6j4U>^^Vil#3tB?OW&4h1*N59@gxUiE{A|b?IiHd;wz$1 zRE)>F@sFFCVM9?lupVm7k@C&SR;;T_Hy;4sqSSBoJnmII0rJl77cnQw87T7Ru*KID z^xewHeW1qDZr}4B9YdW%hW8~%gE%kg3ES$8y;8rM!4~vo*RJQ$fZo_F)lm(+`I4|$ z^1OYK+o&|LoH0X1<$dM6uLqqx>7*6{84@)+IsxcihMI~f@uO!x{ZLheOt`I2gVNs5 zePl%;B(Ys+VbP{LsQ-2YaVNAxP()ZWG&eJ(H_Vi@C`k?#QUhWa*y4T&M^58XuKi*x z_15W#c|Ot8UF;Ap&64HHY+A44br)QZe-LFt^Q`uFEv*j)M53PdORxkbc~+Y*JP0qo ziwcZ&DCx7P^;S&0Wl?*%CY}ga_F6R#Zf&@fwn8buvr{?!US6WGEVrVh5?1-Xe{y`? zt*oooK;88$hj=38RbklVX5qQY+Wy40)Sd>VYgM^4FmauwS76TH`*EP+lv~WuM@2+~ zI4st|qUHq6#|3aAMJiHj@h~FcRBAxhqcl$(lk?if2KVJ66+HBX%jXCBm=OCQ zt5&5v1-{w|eNWYy1wqn+>WtG)Y*ziO&6Tlh<>k&0wzOgHe&ey;+ZkjXO#R1qFZ5l3 zpJT_epR-ZEELyBk=DFI?y`rj4sJU=;y_yBCS>o#~?s*qI!aB-~T(X4nuc^cFw^_;% zAfnRnhRZ{e!t2~y$Emu;TDD_ZS|a3|_o|I54WMZZc&bv9qG^a}5bmr~DN_Z-)4pK}j>LruV7qUm_V*55}4oXl$^ZutW9 z5h+UwMxjYTXxW_E1c6X#EJ4|PY8tGYQ1oT)JAnB)%labqy;85^`i{-nNSpX9b9wLS z(+P!l3x;MRx|0N9s#9@WNSGzZCI&_ldfHagMKE5>j4^k8b-`Uyl@X54O|+@5XBUfQ zrj?f>^}al{5L70c6rwW#8mtR#%A|T zL`N$n#+xfIfSNWNTz3)L@k_F&I2Ejqn78#CV*Bw>f@oCCSBf|6GQ@q8dfONecMU;l zgQckT?=&Be)9S-yi?tl-AaQ6CrPn6hncGp}Gc+rwjBsdAy7!tXgndTm`XXAR#9xU) zy)?XH71L;8X_#&n&lIV9!F_=Kbs50c(iFd%3=&)Z*qmEV!S#xdsJ{;;1!!J=mVCgf z*p_V913nEZwoEfncTrl3JJW=&flH>wi0o{|)|`#lwdasJ^JlrywU1zQ#|Wqz!|**sRR{9!iBnv|#wlFuW_fkDoo`lfl68`FXjTT6e{5rY|N9Vir4D1WEb^#pQGmP7d*oK?M4(bm-g$ zv1f_BcCz;83qORxR#=(Z^9p4RaK#KBFL{UKO!DZbB!mc;@bA#vT?Q z@S$1hXQ*D@&eEr=OlJBVFmX)Y^hRW?BcweAFZS2;Ifz%O6AtlW3t|uOig$Cn;Z!LT z=X+S1-G+!#xN#zUzXh4z3-?n4&DR#p#+gA2L`$h(n&J zLQjMQZs&}e{wC%_f+Gc2=CvWg{mT2WMwGrAFdC#3Bf}PA*jVCV=-}dk28U`BM4u|! zYx$`tch;XqC%qt~@9_uwI-}XeP681ZkX(lkza;}OZel+Ke!F^c!%m+v8Ue0)Qpb&w zMPwaXg?cX}dQLDjB?EbjgV*Wfy4w&Gc3>~XQk3R#5DB)}M$K)MU}8v{31NziHERi< zKJC&u#XHe~$C>On@ViM#Iy1zFQZmHk3&!-dr3K-(j^`*td^X%{3a?x^IbT(mj=eBW zup#5#+iTWkXCK}ISD;nb+smowcgVg9&Q!H~!f=N1?6q#}JMxpPumfjZK~ht`6#glH z)5T3bA7iMRp(mZvE8a?sTd?j`TyyUX7cOl0<@^V^l7)E|?4Vqqfy4*{?nqV(VGPkM zoLlKl#JPp_U&HD9mvY^U_oC?pW^oh)gaLTe3D51^M$cd`N*`BBbH6ug_IGZ=TPPDM zeTz28>;(5-F~9-l8>$)v-%X@jEwT&h71~MjiK4-ol;KA5ri52+r!E%JiAM;9^@@T4 zzMV$-en0g(=p`%}PdB43CR4ZUwznvHw6@k`QcQwo*gQ+`FTD&+lz9Ms9`7lc941ln zQtc|eXI)-|%-u|n+t5=HCrLlx$CmKti>;-5X%8Q@1fp}Lz^TV4Whv}OWQwxQ-ep+5~@pdgU9|C-WS+Q$8SYXf&5a^4_(UgD&XO5h-9c*ae$=U|aq1eXRJVw4V|5|rdP544<$kSUO9 zR(HIfM4qO6)^yD_fq``m-G~bMO0u}CYh%jDd*M-vA?)AAth4!qsx6Jh`*N8lbM>B; z!5ta*e%upJap+tCF14QHU~Tw4s&y`{z)GW7zib%4Y#6_682x`rv|+G4go^z!UHf6f0I>letWUqsbO6jOkcriQ zL302?w!<8cJMRl6pT?n=ID%I===8A&^u*Ca@mvUlq z%+kr(G9wX}{n`1t`E$cLlqXP$@UHLRWdgFmm;F01GSHDwa@;;ybAjYjQ_$6J*|>03 zZLKeP=S#6kj`gw&af4AJgy-Y*p&C&5a&gau$=OyvDAtr?FTS@P)img;>; z^iCOg>>SIgU+o&PR}99b9=s?*Xy>M_z9g0^Ct1s8L1Z22|I&H!Yq`&ev50aqD6U#L z0gk8BD=8sp6R1mc%Jc}&f0dtD+MVzPk&PFx*d9NcF`8L^R0B1~(SFmDnoekTkrqU} z7ipLa`2{&yS&!F4ipe$wruh3`=5u9A9dq@;zP9>Cmx@?{Tr89*p1Q<9E^WezxsMp( zl>)pYt*&9(X?JM+^6bi&y_h@jtH@LAOYF=DPon&q5bGzK%db6`xUm4b!Yml0TD#w| z8IQh`5=cGP2!F$x5(2a9m zo0}RoFM|Zi867XI)7?EaQ!2{WRF$vzT>9awxtN&E(A!Uga*o7_j;2YWni2cCkzVX% zNlisvi*kxw)?W{S6}qP=RXY@d`L{TCu&H{q!if`yTi)fejZj^FO_^cYZ>zDH!;09C zDU(>uiB{Bd>DfPG1~+O@s#<_)zE91$PfA}uj}aVuwn@Q!ho}P@t|=>{(Te-}^ESTK0?l8#g+>0?!T)x$E9)S9i`?CC5v{t%fmwD8Z zzqyUQ0b|VbA-Xz7>h9#XlF0qZ9MH;0X-~&l_2+U{touXZg3C~sOcB4o;RbfC$=**t zy3FIFXN*yoh{@Tv={Z$`-KsYYGmq(^wecVKp+Hhoy<8EeAx+6{?>Wu3ob*OxPx&An zBPGScQ$DH+&gm0>8B$r@k!!UzqA?%xcrR||POEm1NkC%YJqL0bwXGEQoEaO!-_7yK_wf~SQ`N_ z)>1T%(mfWeX&8~x%i7dcRf=f_e;La+!UB@1CQ=rYyz(2=@9xW4OX`YK$ML|ms1LS~ zDQR;`9^DI+UyaUxGH6?eVuv_h)D0|~l{qgP-D#5weU-esexdKqJ=+6aYq1Of1?1=45nn5`I zIy-OxNqChy?kNqaoUiGYFnL&4ip&_yj;@9m1`ZEM=-tq;9NQxwd5!3gGDDzjL@_n) ztRdurSmGvv<=bh>D`R)dUDQ_Ydb=D5@`Tug*{9>v*)m6m)^MoEUR1}KF)KbXD~pLCdT8O4*51#r*Nbgh1E0aj zrMIUyc}!vMIXz01_a%qVW89YnWk^J(A(n#pPY}QHdsC;4^!J-Y1EluSDP2E`&9Zr! z+?Ip-*kfagGUZrl3p>&y&7X~v#rtu;Pz~%8P-c-eM3Xa-5rt6QOHvX#=q-~FMzEgX zY?40;=UP7O=-Nua$9mxahYxQ*!Q1^F*_UYk8|@u5kVsHiqU&qeF4y9=)iWMH!DjgH zxoP)GeXnFN=Pu27WQ*5Z{V+AghHA5Bq5?$61RkT?oO4;PKwD1UW-n_+pIWdq45>V6 zQF{6XwaWMMG5I{ld?NKAV$h?P(w>Hik`!8B*ij97Ef@}zuWAe$T;?%|tw`Z|7rd`5 z5X(kXEUZljQ{NeuUCiD%6Qy-^S!u21JKEP?a2f?1Tdc$PA4^La4fqjBJ4B98iJD0W z^Q$3uk#Y3TY!Mg%yTDroWvNblHqlttJjtj0Sjq{f4r7<}4QK}|2m?*dgF5NwD^F3A zNY5qDK;jb9xps(dgPWXI(Orb#D4(-aP506>G~85o_8Kb0ngYlDW}m_8Voj|*>z;JK z`rT4=FBha8e!fO)7HmA%tRdsiv6|#+cz)FUuW1Aoktir$5PXP5l%?e>GN#AEC*Bu< z#Xl?0nriQm$V$nQCCEcrja{>9KP><(Zn~4DrylEQ9DiNwo6P0PL>)MEgdy*zJk#EU zeip-W;^~|$DFI#7RB*uH)~bVT?hO^%VzI;Jj_1j~9HCXzf@{uz_HG-IE%CNKqS${V<^>?vnqECx+rIQZxz=KFP1 zMUCeUn0X;*Hz@6xGZKR>^Ff2UE96DWhpCEzQ&Y_0EgR7Fq}F71S~({|PACq|V@YFd z1D+nlE97@b9g8%HSFZ*4qX#Zf;OZY0l?{c-J}Rs_Qk4^|&Rzsz=6=UADJU;8onLhT ztJ{rlPq8tYdUO*m6B%*zy$EZiOvSoOD_9h-){9K5=CILXHo42YjHT&n%Xn_-N3}o( zCJc(C>MT0AwZJ?lIUo4ilyJy%2X)Wt)$j_ufrx-xJ?wO)WL~bXZdy|RZJL)CV}bJH zxk>u{=a(cmUOCv6w-LYblmp!h3+o1;S(C8CJW#`7LPX{zx8Ym~o%_x4# z-!RHf@s>%!+!d-C-$ve;DLqSg3eIG_=b zZK$%F4ib^R(O(*bwk#^$tfeoXoq8{PQGMjYlk>8A>J&Yo(~*n!s+myR=-iIJz&mFU#2Bc05h6bp{uJXh8Z>+J#KG<*a` zqWX;cc|cLLrP=gM{)4kkyWsD$k7({UqTHU~4M@f7onMuQswO{Ef_q(d)&#`%mU{QvYKQJ`&LdZsE>*A3m9#b z5-82RIiW(zzcnHGejhv>UL{nqc(1z=Er69|z(5h9AMSb3L5C6-a@BDsfKqQqAERVx zRJa*bHIFSR({Sn`+vgp>tsY`IKg6m)8fS@?PE*xem`8$N>uF;);(K&;J3@S1Q9w~7 zAse_^b$nc61_ImE8NCNv(2vf0E_D_>$L!WdCsfP%3Y9hU@${Njxv^D*Fp0OP z@B^MLoy$pK;)wR^Ssrar3k+L>t$a7g_Hcb(s&JQ6L&kRF9N-;-knmLfP5Y`p9=B$P z%bp)`Ll%KDL#kVVoxR)r>3F)E#K!%1^={{!)n1vPpwx?Np`+c1uGbWHVwW&=RvHSD zuUWS=M6;S-!6o5J55Eoq;y%j=sS^w{EaIP(I)TF*9Lo>A_NX(Kv52pftE(M_WgV&ut9l@E;zi`VS;OR0JK%6T(lJx-fP{5a^mWqc@r z>tq2LS%)ywWEHuVJtKea9mh?FIoYIK@`$^Bk8HylGlhrJWYNdH1gZw-16{QY(;3IQ z5}q~%;yo)n9(KlxTWh^UrYB#I;}o7$N=3HZ&bcmsEEG^@yxm+4ke*Q9MakG}yo|he zzx3KaURzX$XIJ5l%XB1i(jAW%p5F6eoVuk;Ze%?u%q5$xn{)vMx-PLwv7R6cj)GedNzrCi514g0Qa0W={JOMd%lO2lDTeGB=n!gyN-4NGNwBE+)My=4u> z{UT}bS}0A0D%0XB6Wek^h&BSlfb(Q`kMDA--tf8oUR^ae^o=Ka2Ccrsq;kuF{Fi3Nt>BS11A+VcxblaSf_recm;7-(OhTsxYhv z?;);ADccjPifjSLt7D;$0?ni{z)F{MAJwogOTaK{8lrFvo&<%yqXBY{a04lH(aMX} z{G8nyzJDr)nqAQNf8>(Nzd z>w=_;pd3#x#jd^&(tyw78K0AaipX#kUPlc-#6+ihB-_X?MkQS$wMzq9dcGHp0)BwV z0b(UxLY2$dbhhg7#_VsK#ez>1K`=nXLRv2PF~o=hYs$~hc@!3FW^R*(Xt~gpHqy)}26g-?1@GUI1=W zwo2EI8#XwU4&vYseTR_)yp-*aJce|&865;~GP4h^viXvnD3}$WFIB`{dJj#gSnCjE zVaN{SKSjnT_%JI=4FrOA!dVW5U1iJy%0#}FWY*Q`>P5`1J$Y5z_Axw6$u**0kL+#V z+m?2%lG%nKHOecWjsC=qc?{fRk*v2)k|^QA!rp9(XpQ$h?#~0hb%}n!xYx0!22qDQ z3A8NF>4uUn5#yr@n~y6kveu7SCD$ZSIZ&{fsbMgS-VY%HiS zJq=M3^dWn`ShCn1zIHn3yRVAjMuz7@((viAwRT7`K|KHSGtzPr_RtduN10*3lQ|gL zC#HPe2;s8{Mnbr29YYbdmAd-^U16YC{!*~;S@4J4gW=B@`_VppLG46lPC`5(HPL%k z)6$8m%eYh{_w^%|O?-M$yfw4SGhI{J)(cvu?kQYWA9^^(N*r;QAy3|81C;q2!C0KD zVK+DXXW9%V1{_(c*;=P0Yi%`3J9@ndP$L-f#~kYE!-6<`no9t-YeSRpPswyD6>q7_ z;Px-$iqmds-)xENKi@FJF`&aZ&oa-+=Lj9FFpAJJxDEEF9&R7PPCh5XLhS>y#zd63 z4E46ZLGCNR2NOms9%m^igxM145*Lt$Q8wulCQhD$9GD6+Rg=dDhTr(dniYD{#(%#L zGU5TYPtfA?6}`>(6id?@!(KwODXx9>1S>OY@mZF~OyC>z@(<(E1T=H+TyycS!vd$9 z+t(aOgj#PWy%gwDbd9W|$9o+Xg*Vzt2ssq|x6ZPZyLLjE&EX9VLkoSWk8MKRn1dCP z7f16y)V1F?b{7P4APwY;#rEOqyGDu+tGP__;261*s)isOTgR@lC`RQa^Jb{s%VHtV zA}U|lrCI9P3M4p=!w$D6p)cplbj{*jTPd7w-98bDFfkz8Nmpui!*7mi2Zg#NU!Lxy z!Ujc@pf*=DwkAzne!_`=TMkf3!TNmek~)j1siF+8H0NjU*dn#{i4Juh?P=3J6+XpR z%zt4F{=sYf5Tg4(d9>+5;!_)N{Nd5|@*jlte>MjHwpuCo56KVmdjQ+-K0F z+t?xI-G9k`|B@N9y!n65e-Cjd_<8LVLJ|9m|Na;M{V)FeU;OvK`0xLF{(Fc^^6z%x z|EKuxANc1XcIt;60Q!S7{=v8Hhy35B5Igg~&HKI1f0zGfe)@-FHjaOA?Elbbec-hJ zy^e=t5C_Ds?ZMZL9b(&l@Na|Uu|fLC24scU)giuY4}AK+>jNJ6@&7~nzw-Z|;iLb* zeXss$7j^<07$QL)BX%SR%02K+ydp zgP4{7E`vO3?vwy50mIrLkPcl~KpU0UM0uA_i zOj$ty(BIpDJS%^z5BM+I<$yTh{?sl93&dIXuQE0O2g}cWW&<)m%)tNBXUOnDUUomp zKx`0)-@nQrUYbll>p@(8S$^&d9~1!}ia6#LmP9{P}v>nISjx4?R1uE+j}880q2fmb{6J!Nd2LQO?TB tjs$XZNg#im#4HW1NFbep97E!G+1lxX?SA{Fv$L?XvO(mapper): Stream [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -211,7 +211,7 @@ Checks whether a condition is satisfied by ANY answer in this stream. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/answer/ValueGroup.adoc b/nodejs/docs/answer/ValueGroup.adoc index ea199cb3aa..2647944cf1 100644 --- a/nodejs/docs/answer/ValueGroup.adoc +++ b/nodejs/docs/answer/ValueGroup.adoc @@ -6,7 +6,7 @@ Contains an element of the group aggregate query result. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/nodejs/docs/concept/Concept.adoc b/nodejs/docs/concept/Concept.adoc index 5ed1ce7b75..ae43e43d1b 100644 --- a/nodejs/docs/concept/Concept.adoc +++ b/nodejs/docs/concept/Concept.adoc @@ -245,7 +245,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/concept/ConceptManager.adoc b/nodejs/docs/concept/ConceptManager.adoc index 8f25689884..118f515121 100644 --- a/nodejs/docs/concept/ConceptManager.adoc +++ b/nodejs/docs/concept/ConceptManager.adoc @@ -16,7 +16,7 @@ Retrieves an ``Attribute`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -46,7 +46,7 @@ Retrieves an ``AttributeType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -76,7 +76,7 @@ Retrieves an ``Entity`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -106,7 +106,7 @@ Retrieves an ``EntityType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -136,7 +136,7 @@ Retrieves a ``Relation`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -166,7 +166,7 @@ Retrieves a ``RelationType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -301,7 +301,7 @@ Creates a new ``AttributeType`` if none exists with the given label, or retrieve [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -332,7 +332,7 @@ Creates a new ``EntityType`` if none exists with the given label, otherwise retr [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -362,7 +362,7 @@ Creates a new ``RelationType`` if none exists with the given label, otherwise re [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/connection/Database.adoc b/nodejs/docs/connection/Database.adoc index a1ae41ba3a..2ed9cf874e 100644 --- a/nodejs/docs/connection/Database.adoc +++ b/nodejs/docs/connection/Database.adoc @@ -4,7 +4,7 @@ [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/nodejs/docs/connection/DatabaseManager.adoc b/nodejs/docs/connection/DatabaseManager.adoc index ea9865885a..f8cd23c2a0 100644 --- a/nodejs/docs/connection/DatabaseManager.adoc +++ b/nodejs/docs/connection/DatabaseManager.adoc @@ -37,7 +37,7 @@ Checks if a database with the given name exists [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -67,7 +67,7 @@ Create a database with the given name [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -97,7 +97,7 @@ Retrieve the database with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/connection/Replica.adoc b/nodejs/docs/connection/Replica.adoc index 4f13552f1a..3464de5cd9 100644 --- a/nodejs/docs/connection/Replica.adoc +++ b/nodejs/docs/connection/Replica.adoc @@ -6,7 +6,7 @@ The metadata and state of an individual raft replica of a database. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/nodejs/docs/connection/TypeDB.adoc b/nodejs/docs/connection/TypeDB.adoc index 9292105cb3..705cc9ad41 100644 --- a/nodejs/docs/connection/TypeDB.adoc +++ b/nodejs/docs/connection/TypeDB.adoc @@ -4,7 +4,7 @@ [caption=""] .Namespace variables // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name @@ -25,7 +25,7 @@ Creates a connection to TypeDB Cloud, authenticating with the provided credentia [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -52,7 +52,7 @@ Creates a connection to TypeDB. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/connection/TypeDBCredential.adoc b/nodejs/docs/connection/TypeDBCredential.adoc index a7c538a451..8ffc1d38c4 100644 --- a/nodejs/docs/connection/TypeDBCredential.adoc +++ b/nodejs/docs/connection/TypeDBCredential.adoc @@ -58,7 +58,7 @@ new TypeDBCredential(username, password, tlsRootCAPath?): TypeDBCredential [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/connection/TypeDBDriver.adoc b/nodejs/docs/connection/TypeDBDriver.adoc index e5a42f9709..9d53ea1175 100644 --- a/nodejs/docs/connection/TypeDBDriver.adoc +++ b/nodejs/docs/connection/TypeDBDriver.adoc @@ -4,7 +4,7 @@ [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -68,7 +68,7 @@ session(database, type, options?): Promise [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/connection/User.adoc b/nodejs/docs/connection/User.adoc index 4b3a257aee..ce78e6e38d 100644 --- a/nodejs/docs/connection/User.adoc +++ b/nodejs/docs/connection/User.adoc @@ -6,7 +6,7 @@ [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -28,7 +28,7 @@ Updates the user's password. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/connection/UserManager.adoc b/nodejs/docs/connection/UserManager.adoc index 9ed2b15002..0a17baa484 100644 --- a/nodejs/docs/connection/UserManager.adoc +++ b/nodejs/docs/connection/UserManager.adoc @@ -37,7 +37,7 @@ Checks if a user with the given name exists. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -67,7 +67,7 @@ Create a user with the given name & password. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -98,7 +98,7 @@ Deletes a user with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -128,7 +128,7 @@ Retrieve a user with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -158,7 +158,7 @@ Sets a new password for a user. This operation can only be performed by administ [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/data/Attribute.adoc b/nodejs/docs/data/Attribute.adoc index 88bdb5e3b6..24d8231cb9 100644 --- a/nodejs/docs/data/Attribute.adoc +++ b/nodejs/docs/data/Attribute.adoc @@ -10,7 +10,7 @@ Attribute is an instance of the attribute type and has a value. This value is fi [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -266,7 +266,7 @@ Deletes this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -296,7 +296,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -319,7 +319,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -349,7 +349,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -380,7 +380,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -411,7 +411,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -442,7 +442,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -474,7 +474,7 @@ Retrieves the instances that own this ``Attribute``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -505,7 +505,7 @@ Retrieves the roles that this ``Thing`` is currently playing. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -535,7 +535,7 @@ Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -565,7 +565,7 @@ Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -638,7 +638,7 @@ Checks if this ``Thing`` is deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -857,7 +857,7 @@ Assigns an ``Attribute`` to be owned by this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -888,7 +888,7 @@ Unassigns an ``Attribute`` from this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/data/Entity.adoc b/nodejs/docs/data/Entity.adoc index f1c2d94dd2..c85d7cddfe 100644 --- a/nodejs/docs/data/Entity.adoc +++ b/nodejs/docs/data/Entity.adoc @@ -10,7 +10,7 @@ Instance of data of an entity type, representing a standalone object that exists [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -264,7 +264,7 @@ Deletes this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -294,7 +294,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -317,7 +317,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -347,7 +347,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -378,7 +378,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -409,7 +409,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -440,7 +440,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -472,7 +472,7 @@ Retrieves the roles that this ``Thing`` is currently playing. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -502,7 +502,7 @@ Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -532,7 +532,7 @@ Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -605,7 +605,7 @@ Checks if this ``Thing`` is deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -824,7 +824,7 @@ Assigns an ``Attribute`` to be owned by this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -855,7 +855,7 @@ Unassigns an ``Attribute`` from this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/data/Relation.adoc b/nodejs/docs/data/Relation.adoc index 7b0d8b209d..d30814dea0 100644 --- a/nodejs/docs/data/Relation.adoc +++ b/nodejs/docs/data/Relation.adoc @@ -10,7 +10,7 @@ Relation is an instance of a relation type and can be uniquely addressed by a co [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -33,7 +33,7 @@ Adds a new role player to play the given role in this ``Relation``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -296,7 +296,7 @@ Deletes this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -326,7 +326,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -349,7 +349,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -379,7 +379,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -410,7 +410,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -441,7 +441,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -472,7 +472,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -504,7 +504,7 @@ Retrieves all role players of this ``Relation``, optionally filtered by given ro [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -534,7 +534,7 @@ Retrieves all role players of this ``Relation``, optionally filtered by given ro [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -565,7 +565,7 @@ Retrieves the roles that this ``Thing`` is currently playing. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -595,7 +595,7 @@ Retrieves all role types currently played in this ``Relation``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -625,7 +625,7 @@ Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -655,7 +655,7 @@ Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -686,7 +686,7 @@ Retrieves a mapping of all instances involved in the ``Relation`` and the role e [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -758,7 +758,7 @@ Checks if this ``Thing`` is deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -977,7 +977,7 @@ Removes the association of the given instance that plays the given role in this [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1009,7 +1009,7 @@ Assigns an ``Attribute`` to be owned by this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1040,7 +1040,7 @@ Unassigns an ``Attribute`` from this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/data/Thing.adoc b/nodejs/docs/data/Thing.adoc index 8a7958e6ec..04f4e92e91 100644 --- a/nodejs/docs/data/Thing.adoc +++ b/nodejs/docs/data/Thing.adoc @@ -8,7 +8,7 @@ [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -262,7 +262,7 @@ Deletes this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -292,7 +292,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -315,7 +315,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -345,7 +345,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -376,7 +376,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -407,7 +407,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -438,7 +438,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -470,7 +470,7 @@ Retrieves the roles that this ``Thing`` is currently playing. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -500,7 +500,7 @@ Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -530,7 +530,7 @@ Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -603,7 +603,7 @@ Checks if this ``Thing`` is deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -822,7 +822,7 @@ Assigns an ``Attribute`` to be owned by this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -853,7 +853,7 @@ Unassigns an ``Attribute`` from this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/data/Value.adoc b/nodejs/docs/data/Value.adoc index 2c6a1466e8..eb315da44d 100644 --- a/nodejs/docs/data/Value.adoc +++ b/nodejs/docs/data/Value.adoc @@ -8,7 +8,7 @@ [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -366,7 +366,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/errors/ErrorMessage.adoc b/nodejs/docs/errors/ErrorMessage.adoc index 86d7175fd2..de06952967 100644 --- a/nodejs/docs/errors/ErrorMessage.adoc +++ b/nodejs/docs/errors/ErrorMessage.adoc @@ -30,7 +30,7 @@ Generates the error message by substituting ``args`` into the messageTemplate [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -53,7 +53,7 @@ new ErrorMessage(codePrefix, codeNumber, messagePrefix, messageBody): ErrorMessa [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/errors/TypeDBDriverError.adoc b/nodejs/docs/errors/TypeDBDriverError.adoc index a195794b2c..6105bbcbee 100644 --- a/nodejs/docs/errors/TypeDBDriverError.adoc +++ b/nodejs/docs/errors/TypeDBDriverError.adoc @@ -10,7 +10,7 @@ Errors encountered when interacting with TypeDB [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -49,7 +49,7 @@ Create .stack property on a target object [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -73,7 +73,7 @@ new TypeDBDriverError(error): TypeDBDriverError [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/logic/LogicManager.adoc b/nodejs/docs/logic/LogicManager.adoc index 5d440439e6..0eb5bdb571 100644 --- a/nodejs/docs/logic/LogicManager.adoc +++ b/nodejs/docs/logic/LogicManager.adoc @@ -16,7 +16,7 @@ Retrieves the Rule that has the given label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -67,7 +67,7 @@ Creates a new Rule if none exists with the given label, or replaces the existing [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/logic/Rule.adoc b/nodejs/docs/logic/Rule.adoc index 0c49505217..4566e39c6f 100644 --- a/nodejs/docs/logic/Rule.adoc +++ b/nodejs/docs/logic/Rule.adoc @@ -6,7 +6,7 @@ Rules are a part of schema and define embedded logic. The reasoning engine uses [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -29,7 +29,7 @@ Deletes this rule. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -59,7 +59,7 @@ Check if this rule has been deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -89,7 +89,7 @@ Renames the label of the rule. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/schema/Annotation.adoc b/nodejs/docs/schema/Annotation.adoc index a406f1dd73..c9405827d2 100644 --- a/nodejs/docs/schema/Annotation.adoc +++ b/nodejs/docs/schema/Annotation.adoc @@ -6,7 +6,7 @@ Annotations for ownership declarations. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -28,7 +28,7 @@ Returns the relevant ``Annotation`` given the name as a string [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/schema/AttributeType.adoc b/nodejs/docs/schema/AttributeType.adoc index 7c6db32a5e..9c6b6c8662 100644 --- a/nodejs/docs/schema/AttributeType.adoc +++ b/nodejs/docs/schema/AttributeType.adoc @@ -10,7 +10,7 @@ Attribute types represent properties that other types can own. Attribute types h [caption=""] .Namespace variables // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name @@ -262,7 +262,7 @@ Deletes this type from the database. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -292,7 +292,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -315,7 +315,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -346,7 +346,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -377,7 +377,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -408,7 +408,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -439,7 +439,7 @@ Retrieves all direct and indirect (or direct only) ``Attributes`` that are insta [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -470,7 +470,7 @@ Retrieves all direct and indirect (or direct only) ``Thing`` objects that are in [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -500,7 +500,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -531,7 +531,7 @@ Retrieve all ``Things`` that own an attribute of this ``AttributeType``. Optiona [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -563,7 +563,7 @@ getOwners(transaction): Stream [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -586,7 +586,7 @@ getOwners(transaction, annotations): Stream [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -610,7 +610,7 @@ getOwners(transaction, transitivity): Stream [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -634,7 +634,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -664,7 +664,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -695,7 +695,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -726,7 +726,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -758,7 +758,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -789,7 +789,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -821,7 +821,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -853,7 +853,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -886,7 +886,7 @@ Retrieves an ``AttributeType``, ownership of which is overridden for this ``Thin [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -917,7 +917,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -947,7 +947,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -978,7 +978,7 @@ Retrieves a ``RoleType`` that is overridden by the given ``role_type`` for this [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1009,7 +1009,7 @@ Retrieves the regular expression that is defined for this ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1039,7 +1039,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1070,7 +1070,7 @@ Retrieves all direct and indirect subtypes of the ``ThingType``. Equivalent to g [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1100,7 +1100,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``ThingType`` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1131,7 +1131,7 @@ getSubtypes(transaction, transitivity): Stream [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1155,7 +1155,7 @@ getSubtypes(transaction, valueType, transitivity): Stream [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1180,7 +1180,7 @@ Retrieves the most immediate supertype of the ``ThingType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1210,7 +1210,7 @@ Retrieves all supertypes of the ``ThingType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1240,7 +1240,7 @@ Produces a pattern for creating this ``ThingType`` in a ``define`` query. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1312,7 +1312,7 @@ Check if the concept has been deleted [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1524,7 +1524,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given value [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1555,7 +1555,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given value [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1586,7 +1586,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given value [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1617,7 +1617,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given value [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1648,7 +1648,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given value [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1679,7 +1679,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given value [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1710,7 +1710,7 @@ Set a ``ThingType`` to be abstract, meaning it cannot have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1740,7 +1740,7 @@ Renames the label of the type. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1771,7 +1771,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1802,7 +1802,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1834,7 +1834,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1866,7 +1866,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1899,7 +1899,7 @@ Allows the instances of this ``ThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1930,7 +1930,7 @@ Allows the instances of this ``ThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1962,7 +1962,7 @@ Sets a regular expression as a constraint for this ``AttributeType``. ``Values`` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1993,7 +1993,7 @@ Sets the supplied ``AttributeType`` as the supertype of the current ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -2024,7 +2024,7 @@ Set a ``ThingType`` to be non-abstract, meaning it can have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -2054,7 +2054,7 @@ Disallows the instances of this ``ThingType`` from owning the given ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -2085,7 +2085,7 @@ Disallows the instances of this ``ThingType`` from playing the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -2116,7 +2116,7 @@ Removes the regular expression that is defined for this ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/schema/EntityType.adoc b/nodejs/docs/schema/EntityType.adoc index 9ff3ddb7ca..baf6604f21 100644 --- a/nodejs/docs/schema/EntityType.adoc +++ b/nodejs/docs/schema/EntityType.adoc @@ -8,7 +8,7 @@ [caption=""] .Namespace variables // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name @@ -260,7 +260,7 @@ create(transaction): Promise [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -283,7 +283,7 @@ Deletes this type from the database. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -313,7 +313,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -336,7 +336,7 @@ Retrieves all direct and indirect ``Thing`` objects that are instances of this ` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -366,7 +366,7 @@ Retrieves all direct and indirect (or direct only) ``Thing`` objects that are in [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -397,7 +397,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -427,7 +427,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -458,7 +458,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -489,7 +489,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -521,7 +521,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -552,7 +552,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -584,7 +584,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -616,7 +616,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -649,7 +649,7 @@ Retrieves an ``AttributeType``, ownership of which is overridden for this ``Thin [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -680,7 +680,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -710,7 +710,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -741,7 +741,7 @@ Retrieves a ``RoleType`` that is overridden by the given ``role_type`` for this [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -772,7 +772,7 @@ Retrieves all direct and indirect subtypes of the ``ThingType``. Equivalent to g [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -802,7 +802,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``ThingType`` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -833,7 +833,7 @@ Retrieves the most immediate supertype of the ``ThingType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -863,7 +863,7 @@ Retrieves all supertypes of the ``ThingType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -893,7 +893,7 @@ Produces a pattern for creating this ``ThingType`` in a ``define`` query. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -965,7 +965,7 @@ Check if the concept has been deleted [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1177,7 +1177,7 @@ Set a ``ThingType`` to be abstract, meaning it cannot have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1207,7 +1207,7 @@ Renames the label of the type. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1238,7 +1238,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1269,7 +1269,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1301,7 +1301,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1333,7 +1333,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1366,7 +1366,7 @@ Allows the instances of this ``ThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1397,7 +1397,7 @@ Allows the instances of this ``ThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1429,7 +1429,7 @@ Sets the supplied ``EntityType`` as the supertype of the current ``EntityType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1460,7 +1460,7 @@ Set a ``ThingType`` to be non-abstract, meaning it can have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1490,7 +1490,7 @@ Disallows the instances of this ``ThingType`` from owning the given ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1521,7 +1521,7 @@ Disallows the instances of this ``ThingType`` from playing the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/schema/Label.adoc b/nodejs/docs/schema/Label.adoc index ce8b9723d8..fbf9a5c782 100644 --- a/nodejs/docs/schema/Label.adoc +++ b/nodejs/docs/schema/Label.adoc @@ -60,7 +60,7 @@ Compares this label to ``that`` label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/schema/RelationType.adoc b/nodejs/docs/schema/RelationType.adoc index 54db6e4834..01a2120683 100644 --- a/nodejs/docs/schema/RelationType.adoc +++ b/nodejs/docs/schema/RelationType.adoc @@ -8,7 +8,7 @@ [caption=""] .Namespace variables // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name @@ -260,7 +260,7 @@ Creates and returns an instance of this ``RelationType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -290,7 +290,7 @@ Deletes this type from the database. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -320,7 +320,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -343,7 +343,7 @@ Retrieves all direct and indirect ``Thing`` objects that are instances of this ` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -373,7 +373,7 @@ Retrieves all direct and indirect (or direct only) ``Thing`` objects that are in [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -404,7 +404,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -434,7 +434,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -465,7 +465,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -496,7 +496,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -528,7 +528,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -559,7 +559,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -591,7 +591,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -623,7 +623,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -656,7 +656,7 @@ Retrieves an ``AttributeType``, ownership of which is overridden for this ``Thin [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -687,7 +687,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -717,7 +717,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -748,7 +748,7 @@ Retrieves a ``RoleType`` that is overridden by the given ``role_type`` for this [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -779,7 +779,7 @@ RelationType#getRelates:(1) [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -802,7 +802,7 @@ Retrieves roles that this ``RelationType`` relates to directly or via inheritanc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -833,7 +833,7 @@ getRelatesForRoleLabel(transaction, roleLabel): Promise [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -857,7 +857,7 @@ Retrieves a ``RoleType`` that is overridden by the role with the ``role_label``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -888,7 +888,7 @@ Retrieves all direct and indirect subtypes of the ``ThingType``. Equivalent to g [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -918,7 +918,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``ThingType`` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -949,7 +949,7 @@ Retrieves the most immediate supertype of the ``ThingType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -979,7 +979,7 @@ Retrieves all supertypes of the ``ThingType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1009,7 +1009,7 @@ Produces a pattern for creating this ``ThingType`` in a ``define`` query. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1081,7 +1081,7 @@ Check if the concept has been deleted [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1293,7 +1293,7 @@ Set a ``ThingType`` to be abstract, meaning it cannot have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1323,7 +1323,7 @@ Renames the label of the type. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1354,7 +1354,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1385,7 +1385,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1417,7 +1417,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1449,7 +1449,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1482,7 +1482,7 @@ Allows the instances of this ``ThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1513,7 +1513,7 @@ Allows the instances of this ``ThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1545,7 +1545,7 @@ Sets the new role that this ``RelationType`` relates to. If we are setting an ov [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1577,7 +1577,7 @@ Sets the supplied ``RelationType`` as the supertype of the current ``RelationTyp [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1608,7 +1608,7 @@ Set a ``ThingType`` to be non-abstract, meaning it can have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1638,7 +1638,7 @@ Disallows the instances of this ``ThingType`` from owning the given ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1669,7 +1669,7 @@ Disallows the instances of this ``ThingType`` from playing the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1700,7 +1700,7 @@ Disallows this ``RelationType`` from relating to the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/schema/RoleType.adoc b/nodejs/docs/schema/RoleType.adoc index ac874a82d8..b0eddd18bc 100644 --- a/nodejs/docs/schema/RoleType.adoc +++ b/nodejs/docs/schema/RoleType.adoc @@ -10,7 +10,7 @@ Roles are special internal types used by relations. We can not create an instanc [caption=""] .Namespace variables // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name @@ -262,7 +262,7 @@ Deletes this type from the database. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -292,7 +292,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -315,7 +315,7 @@ Retrieves the ``Thing`` instances that play this role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -345,7 +345,7 @@ Retrieves the ``Thing`` instances that play this role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -376,7 +376,7 @@ Retrieves the ``ThingType``s whose instances play this role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -406,7 +406,7 @@ Retrieves the ``ThingType``s whose instances play this role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -437,7 +437,7 @@ Retrieves the ``Relation`` instances that this role is related to. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -467,7 +467,7 @@ Retrieves the ``Relation`` instances that this role is related to. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -498,7 +498,7 @@ Retrieves the ``RelationType`` that this role is directly related to. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -528,7 +528,7 @@ Retrieves ``RelationType``s that this role is related to (directly or indirectly [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -558,7 +558,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -588,7 +588,7 @@ Retrieves the most immediate supertype of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -618,7 +618,7 @@ Retrieves all supertypes of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -690,7 +690,7 @@ Check if the concept has been deleted [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -902,7 +902,7 @@ Renames the label of the type. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/schema/ThingType.adoc b/nodejs/docs/schema/ThingType.adoc index da927fef4b..9fdbcbf85f 100644 --- a/nodejs/docs/schema/ThingType.adoc +++ b/nodejs/docs/schema/ThingType.adoc @@ -8,7 +8,7 @@ [caption=""] .Namespace variables // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name @@ -260,7 +260,7 @@ Deletes this type from the database. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -290,7 +290,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -313,7 +313,7 @@ Retrieves all direct and indirect ``Thing`` objects that are instances of this ` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -343,7 +343,7 @@ Retrieves all direct and indirect (or direct only) ``Thing`` objects that are in [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -374,7 +374,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -404,7 +404,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -435,7 +435,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -466,7 +466,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -498,7 +498,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -529,7 +529,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -561,7 +561,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -593,7 +593,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -626,7 +626,7 @@ Retrieves an ``AttributeType``, ownership of which is overridden for this ``Thin [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -657,7 +657,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -687,7 +687,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -718,7 +718,7 @@ Retrieves a ``RoleType`` that is overridden by the given ``role_type`` for this [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -749,7 +749,7 @@ Retrieves all direct and indirect subtypes of the ``ThingType``. Equivalent to g [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -779,7 +779,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``ThingType`` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -810,7 +810,7 @@ Retrieves the most immediate supertype of the ``ThingType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -840,7 +840,7 @@ Retrieves all supertypes of the ``ThingType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -870,7 +870,7 @@ Produces a pattern for creating this ``ThingType`` in a ``define`` query. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -942,7 +942,7 @@ Check if the concept has been deleted [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1154,7 +1154,7 @@ Set a ``ThingType`` to be abstract, meaning it cannot have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1184,7 +1184,7 @@ Renames the label of the type. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1215,7 +1215,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1246,7 +1246,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1278,7 +1278,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1310,7 +1310,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1343,7 +1343,7 @@ Allows the instances of this ``ThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1374,7 +1374,7 @@ Allows the instances of this ``ThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1406,7 +1406,7 @@ Set a ``ThingType`` to be non-abstract, meaning it can have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1436,7 +1436,7 @@ Disallows the instances of this ``ThingType`` from owning the given ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -1467,7 +1467,7 @@ Disallows the instances of this ``ThingType`` from playing the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/schema/Transitivity.adoc b/nodejs/docs/schema/Transitivity.adoc index 20a46bc870..621df2f740 100644 --- a/nodejs/docs/schema/Transitivity.adoc +++ b/nodejs/docs/schema/Transitivity.adoc @@ -4,7 +4,7 @@ [caption=""] .Namespace variables // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name @@ -26,7 +26,7 @@ new Transitivity(transitivity): Transitivity [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/schema/Type.adoc b/nodejs/docs/schema/Type.adoc index 3a02625b09..d61be92d1d 100644 --- a/nodejs/docs/schema/Type.adoc +++ b/nodejs/docs/schema/Type.adoc @@ -8,7 +8,7 @@ [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -262,7 +262,7 @@ Deletes this type from the database. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -292,7 +292,7 @@ Checks if this concept is equal to the argument ``concept``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -315,7 +315,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -345,7 +345,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -376,7 +376,7 @@ Retrieves the most immediate supertype of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -406,7 +406,7 @@ Retrieves all supertypes of the type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -478,7 +478,7 @@ Check if the concept has been deleted [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -690,7 +690,7 @@ Renames the label of the type. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/schema/ValueType.adoc b/nodejs/docs/schema/ValueType.adoc index d90f8697f7..186bac84fe 100644 --- a/nodejs/docs/schema/ValueType.adoc +++ b/nodejs/docs/schema/ValueType.adoc @@ -6,7 +6,7 @@ TypeQL value types for attributes & value concepts. [caption=""] .Namespace variables // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name @@ -46,7 +46,7 @@ new ValueType(type, name): ValueType [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/session/Opts.adoc b/nodejs/docs/session/Opts.adoc index 917333d84f..d0f315260b 100644 --- a/nodejs/docs/session/Opts.adoc +++ b/nodejs/docs/session/Opts.adoc @@ -6,7 +6,7 @@ Interface for TypeDBOptions. Use TypeDBOptions instead. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/nodejs/docs/session/SessionType.adoc b/nodejs/docs/session/SessionType.adoc index 8f060ad74b..6cacf8882b 100644 --- a/nodejs/docs/session/SessionType.adoc +++ b/nodejs/docs/session/SessionType.adoc @@ -6,7 +6,7 @@ This class is used to specify the type of the session. [caption=""] .Namespace variables // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name diff --git a/nodejs/docs/session/TypeDBOptions.adoc b/nodejs/docs/session/TypeDBOptions.adoc index b05628e35f..c294493af0 100644 --- a/nodejs/docs/session/TypeDBOptions.adoc +++ b/nodejs/docs/session/TypeDBOptions.adoc @@ -296,7 +296,7 @@ new TypeDBOptions(obj?): TypeDBOptions [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/session/TypeDBSession.adoc b/nodejs/docs/session/TypeDBSession.adoc index a4a45697c6..9c9ed43646 100644 --- a/nodejs/docs/session/TypeDBSession.adoc +++ b/nodejs/docs/session/TypeDBSession.adoc @@ -4,7 +4,7 @@ [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -70,7 +70,7 @@ Registers a callback function which will be executed when this session is closed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -100,7 +100,7 @@ Registers a callback function which will be executed when this session is reopen [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -130,7 +130,7 @@ Opens a transaction to perform read or write queries on the database connected t [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/transaction/QueryManager.adoc b/nodejs/docs/transaction/QueryManager.adoc index 14517199fd..2977f71576 100644 --- a/nodejs/docs/transaction/QueryManager.adoc +++ b/nodejs/docs/transaction/QueryManager.adoc @@ -16,7 +16,7 @@ Performs a TypeQL Define query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -47,7 +47,7 @@ Performs a TypeQL Delete query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -78,7 +78,7 @@ Performs a TypeQL Explain query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -111,7 +111,7 @@ Returns a stream of JSON Objects of strings to JSON. JSON can be: Arrays of JSON [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -142,7 +142,7 @@ Performs a TypeQL Get query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -173,7 +173,7 @@ Performs a TypeQL Get Aggregate query in the transaction. Returns an empty promi [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -204,7 +204,7 @@ Performs a TypeQL Get Group query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -235,7 +235,7 @@ Performs a TypeQL Get Group Aggregate query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -266,7 +266,7 @@ Performs a TypeQL Insert query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -297,7 +297,7 @@ Performs a TypeQL Undefine query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -328,7 +328,7 @@ Performs a TypeQL Update query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/nodejs/docs/transaction/TransactionType.adoc b/nodejs/docs/transaction/TransactionType.adoc index f86bbd5610..942bb4ee68 100644 --- a/nodejs/docs/transaction/TransactionType.adoc +++ b/nodejs/docs/transaction/TransactionType.adoc @@ -6,7 +6,7 @@ This class is used to specify the type of transaction. [caption=""] .Namespace variables // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Name diff --git a/nodejs/docs/transaction/TypeDBTransaction.adoc b/nodejs/docs/transaction/TypeDBTransaction.adoc index e2cfd79453..42227d420d 100644 --- a/nodejs/docs/transaction/TypeDBTransaction.adoc +++ b/nodejs/docs/transaction/TypeDBTransaction.adoc @@ -4,7 +4,7 @@ [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -92,7 +92,7 @@ Registers a callback function which will be executed when this transaction is cl [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/python/docs/answer/ConceptMap.adoc b/python/docs/answer/ConceptMap.adoc index cf93586cbd..20c0ac2b08 100644 --- a/python/docs/answer/ConceptMap.adoc +++ b/python/docs/answer/ConceptMap.adoc @@ -58,7 +58,7 @@ Retrieves a concept for a given variable name. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/answer/Explainables.adoc b/python/docs/answer/Explainables.adoc index 6897d3e9f6..b98d2b9a73 100644 --- a/python/docs/answer/Explainables.adoc +++ b/python/docs/answer/Explainables.adoc @@ -16,7 +16,7 @@ Retrieves the explainable attribute with the given variable name. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -67,7 +67,7 @@ Retrieves the explainable attribute ownership with the pair of (owner, attribute [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -119,7 +119,7 @@ Retrieves the explainable relation with the given variable name. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/answer/Explanation.adoc b/python/docs/answer/Explanation.adoc index af4ea628ab..ca6a9022fa 100644 --- a/python/docs/answer/Explanation.adoc +++ b/python/docs/answer/Explanation.adoc @@ -58,7 +58,7 @@ Retrieves the rule variables corresponding to the query variable var for this `` [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/concept/ConceptManager.adoc b/python/docs/concept/ConceptManager.adoc index 25b292d63c..037b0a275c 100644 --- a/python/docs/concept/ConceptManager.adoc +++ b/python/docs/concept/ConceptManager.adoc @@ -16,7 +16,7 @@ Retrieves an ``Attribute`` by its iid. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -46,7 +46,7 @@ Retrieves an ``AttributeType`` by its label. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -76,7 +76,7 @@ Retrieves an ``Entity`` by its iid. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -106,7 +106,7 @@ Retrieves an ``EntityType`` by its label. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -136,7 +136,7 @@ Retrieves a ``Relation`` by its iid. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -166,7 +166,7 @@ Retrieves a ``RelationType`` by its label. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -280,7 +280,7 @@ Creates a new ``AttributeType`` if none exists with the given label, or retrieve [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -311,7 +311,7 @@ Creates a new ``EntityType`` if none exists with the given label, otherwise retr [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -341,7 +341,7 @@ Creates a new ``RelationType`` if none exists with the given label, otherwise re [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/connection/Database.adoc b/python/docs/connection/Database.adoc index 721b349982..5e2bbdbd49 100644 --- a/python/docs/connection/Database.adoc +++ b/python/docs/connection/Database.adoc @@ -4,7 +4,7 @@ [caption=""] .Properties // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/python/docs/connection/DatabaseManager.adoc b/python/docs/connection/DatabaseManager.adoc index fa7dca6e31..5a0cd02ea6 100644 --- a/python/docs/connection/DatabaseManager.adoc +++ b/python/docs/connection/DatabaseManager.adoc @@ -37,7 +37,7 @@ Checks if a database with the given name exists [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -67,7 +67,7 @@ Create a database with the given name [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -97,7 +97,7 @@ Retrieve the database with the given name. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/connection/TypeDB.adoc b/python/docs/connection/TypeDB.adoc index 74cf026067..2c6a39f781 100644 --- a/python/docs/connection/TypeDB.adoc +++ b/python/docs/connection/TypeDB.adoc @@ -14,7 +14,7 @@ Creates a connection to TypeDB Cloud, authenticating with the provided credentia [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -38,7 +38,7 @@ Creates a connection to TypeDB. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/connection/TypeDBDriver.adoc b/python/docs/connection/TypeDBDriver.adoc index fcf002fe46..1b9998b81a 100644 --- a/python/docs/connection/TypeDBDriver.adoc +++ b/python/docs/connection/TypeDBDriver.adoc @@ -4,7 +4,7 @@ [caption=""] .Properties // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -68,7 +68,7 @@ Opens a communication tunnel (session) to the given database on the running Type [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/connection/User.adoc b/python/docs/connection/User.adoc index 057687c68b..48e7d9d8e7 100644 --- a/python/docs/connection/User.adoc +++ b/python/docs/connection/User.adoc @@ -30,7 +30,7 @@ Updates the password for this user. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/connection/UserManager.adoc b/python/docs/connection/UserManager.adoc index 9d081f9de4..dc9a1b2a79 100644 --- a/python/docs/connection/UserManager.adoc +++ b/python/docs/connection/UserManager.adoc @@ -37,7 +37,7 @@ Checks if a user with the given name exists. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -67,7 +67,7 @@ Create a user with the given name and password. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -98,7 +98,7 @@ Deletes a user with the given name. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -128,7 +128,7 @@ Retrieve a user with the given name. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -158,7 +158,7 @@ Sets a new password for a user. This operation can only be performed by administ [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/data/Attribute.adoc b/python/docs/data/Attribute.adoc index fd8947d6df..2b86ae16f1 100644 --- a/python/docs/data/Attribute.adoc +++ b/python/docs/data/Attribute.adoc @@ -148,7 +148,7 @@ Retrieves the instances that own this ``Attribute``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/data/Relation.adoc b/python/docs/data/Relation.adoc index 2c499366de..13a3da00a4 100644 --- a/python/docs/data/Relation.adoc +++ b/python/docs/data/Relation.adoc @@ -20,7 +20,7 @@ Adds a new role player to play the given role in this ``Relation``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -73,7 +73,7 @@ Retrieves a mapping of all instances involved in the ``Relation`` and the role e [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -103,7 +103,7 @@ Retrieves all role players of this ``Relation``, optionally filtered by given ro [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -135,7 +135,7 @@ Retrieves all role types currently played in this ``Relation``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -207,7 +207,7 @@ Removes the association of the given instance that plays the given role in this [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/data/Thing.adoc b/python/docs/data/Thing.adoc index 4cd93f418d..5a26282d73 100644 --- a/python/docs/data/Thing.adoc +++ b/python/docs/data/Thing.adoc @@ -39,7 +39,7 @@ Deletes this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -69,7 +69,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -125,7 +125,7 @@ Retrieves the roles that this ``Thing`` is currently playing. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -155,7 +155,7 @@ Retrieves all the ``Relation``s which this ``Thing`` plays a role in, optionally [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -207,7 +207,7 @@ Checks if this ``Thing`` is deleted. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -279,7 +279,7 @@ Assigns an ``Attribute`` to be owned by this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -310,7 +310,7 @@ Unassigns an ``Attribute`` from this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/logic/LogicManager.adoc b/python/docs/logic/LogicManager.adoc index c057fe2f17..49da570916 100644 --- a/python/docs/logic/LogicManager.adoc +++ b/python/docs/logic/LogicManager.adoc @@ -16,7 +16,7 @@ Retrieves the Rule that has the given label. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -67,7 +67,7 @@ Creates a new Rule if none exists with the given label, or replaces the existing [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/logic/Rule.adoc b/python/docs/logic/Rule.adoc index f3c364a961..40da9c0c1e 100644 --- a/python/docs/logic/Rule.adoc +++ b/python/docs/logic/Rule.adoc @@ -6,7 +6,7 @@ Rules are a part of schema and define embedded logic. The reasoning engine uses [caption=""] .Properties // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -29,7 +29,7 @@ Deletes this rule. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -59,7 +59,7 @@ Check if this rule has been deleted. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -89,7 +89,7 @@ Renames the label of the rule. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/schema/AttributeType.adoc b/python/docs/schema/AttributeType.adoc index 023d96d288..77e0377fa4 100644 --- a/python/docs/schema/AttributeType.adoc +++ b/python/docs/schema/AttributeType.adoc @@ -47,7 +47,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -78,7 +78,7 @@ Retrieves all direct and indirect (or direct only) ``Attributes`` that are insta [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -110,7 +110,7 @@ Retrieve all ``Things`` that own an attribute of this ``AttributeType``. Optiona [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -143,7 +143,7 @@ Retrieves the regular expression that is defined for this ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -173,7 +173,7 @@ Retrieves all direct and indirect (or direct only) subtypes of this ``AttributeT [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -354,7 +354,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given value [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -387,7 +387,7 @@ Can only be applied for ``AttributeType``s with a ``string`` value type. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -418,7 +418,7 @@ Sets the supplied ``AttributeType`` as the supertype of the current ``AttributeT [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -449,7 +449,7 @@ Removes the regular expression that is defined for this ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/schema/EntityType.adoc b/python/docs/schema/EntityType.adoc index 465926740d..2400261f27 100644 --- a/python/docs/schema/EntityType.adoc +++ b/python/docs/schema/EntityType.adoc @@ -41,7 +41,7 @@ Creates and returns a new instance of this ``EntityType``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -71,7 +71,7 @@ Retrieves all direct and indirect (or direct only) ``Entity`` objects that are i [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -102,7 +102,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``EntityType` [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -154,7 +154,7 @@ Sets the supplied ``EntityType`` as the supertype of the current ``EntityType``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/schema/Label.adoc b/python/docs/schema/Label.adoc index caa461ad68..7addea50cf 100644 --- a/python/docs/schema/Label.adoc +++ b/python/docs/schema/Label.adoc @@ -8,7 +8,7 @@ It consists of an optional ``scope``, and a ``name``, represented ``scope:name`` [caption=""] .Properties // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -30,7 +30,7 @@ Creates a Label from a specified name, or scoped name. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/schema/RelationType.adoc b/python/docs/schema/RelationType.adoc index 00e39cc240..0e4a7f6362 100644 --- a/python/docs/schema/RelationType.adoc +++ b/python/docs/schema/RelationType.adoc @@ -45,7 +45,7 @@ Creates and returns an instance of this ``RelationType``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -75,7 +75,7 @@ Retrieves all direct and indirect (or direct only) ``Relation``s that are instan [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -106,7 +106,7 @@ Retrieves roles that this ``RelationType`` relates to directly or via inheritanc [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -139,7 +139,7 @@ Retrieves a ``RoleType`` that is overridden by the role with the ``role_label``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -170,7 +170,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``RelationTyp [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -222,7 +222,7 @@ Sets the new role that this ``RelationType`` relates to. If we are setting an ov [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -255,7 +255,7 @@ Sets the supplied ``RelationType`` as the supertype of the current ``RelationTyp [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -286,7 +286,7 @@ Disallows this ``RelationType`` from relating to the given role. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/schema/RoleType.adoc b/python/docs/schema/RoleType.adoc index 2520b97b45..29eb5cb76d 100644 --- a/python/docs/schema/RoleType.adoc +++ b/python/docs/schema/RoleType.adoc @@ -43,7 +43,7 @@ Retrieves the ``Thing`` instances that play this role. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -74,7 +74,7 @@ Retrieves the ``ThingType``s whose instances play this role. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -105,7 +105,7 @@ Retrieves the ``Relation`` instances that this role is related to. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -136,7 +136,7 @@ Retrieves the ``RelationType`` that this role is directly related to. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -166,7 +166,7 @@ Retrieves ``RelationType``s that this role is related to (directly or indirectly [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -196,7 +196,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``RoleType``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -227,7 +227,7 @@ Retrieves the most immediate supertype of the ``RoleType``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -257,7 +257,7 @@ Retrieves all supertypes of the ``RoleType``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/schema/ThingType.adoc b/python/docs/schema/ThingType.adoc index 9c3f59ff6f..7b3eb73dae 100644 --- a/python/docs/schema/ThingType.adoc +++ b/python/docs/schema/ThingType.adoc @@ -18,7 +18,7 @@ Retrieves all direct and indirect (or direct only) ``Thing`` objects that are in [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -50,7 +50,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -86,7 +86,7 @@ Retrieves an ``AttributeType``, ownership of which is overridden for this ``Thin [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -117,7 +117,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -149,7 +149,7 @@ Retrieves a ``RoleType`` that is overridden by the given ``role_type`` for this [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -180,7 +180,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``ThingType`` [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -212,7 +212,7 @@ Retrieves the most immediate supertype of the ``ThingType``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -242,7 +242,7 @@ Retrieves all supertypes of the ``ThingType``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -272,7 +272,7 @@ Produces a pattern for creating this ``ThingType`` in a ``define`` query. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -323,7 +323,7 @@ Set a ``ThingType`` to be abstract, meaning it cannot have instances. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -353,7 +353,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -389,7 +389,7 @@ Allows the instances of this ``ThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -422,7 +422,7 @@ Set a ``ThingType`` to be non-abstract, meaning it can have instances. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -452,7 +452,7 @@ Disallows the instances of this ``ThingType`` from owning the given ``AttributeT [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -483,7 +483,7 @@ Disallows the instances of this ``ThingType`` from playing the given role. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/schema/Transitivity.adoc b/python/docs/schema/Transitivity.adoc index eee59196ab..580f5610c3 100644 --- a/python/docs/schema/Transitivity.adoc +++ b/python/docs/schema/Transitivity.adoc @@ -13,7 +13,7 @@ attribute_type.get_owners(transaction, annotations=annotations, transitivity=Tra [caption=""] .Enum constants // tag::enum_constants[] -[cols="~,~"] +[cols=","] [options="header"] |=== |Name |Value diff --git a/python/docs/schema/Type.adoc b/python/docs/schema/Type.adoc index 2bd42c3413..79118adcf8 100644 --- a/python/docs/schema/Type.adoc +++ b/python/docs/schema/Type.adoc @@ -18,7 +18,7 @@ Deletes this type from the database. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -69,7 +69,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the type. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -101,7 +101,7 @@ Retrieves the most immediate supertype of the type. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -131,7 +131,7 @@ Retrieves all supertypes of the type. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -224,7 +224,7 @@ Renames the label of the type. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/schema/ValueType.adoc b/python/docs/schema/ValueType.adoc index 4d0185e709..e82564b16f 100644 --- a/python/docs/schema/ValueType.adoc +++ b/python/docs/schema/ValueType.adoc @@ -6,7 +6,7 @@ TypeQL value types for attributes and value concepts. [caption=""] .Enum constants // tag::enum_constants[] -[cols="~,~"] +[cols=","] [options="header"] |=== |Name |Value diff --git a/python/docs/session/SessionType.adoc b/python/docs/session/SessionType.adoc index 3738d70b08..817d8a1839 100644 --- a/python/docs/session/SessionType.adoc +++ b/python/docs/session/SessionType.adoc @@ -13,7 +13,7 @@ driver.session(database, SessionType.SCHEMA) [caption=""] .Enum constants // tag::enum_constants[] -[cols="~,~"] +[cols=","] [options="header"] |=== |Name |Value diff --git a/python/docs/session/TypeDBOptions.adoc b/python/docs/session/TypeDBOptions.adoc index f8753cde69..e38366a135 100644 --- a/python/docs/session/TypeDBOptions.adoc +++ b/python/docs/session/TypeDBOptions.adoc @@ -16,7 +16,7 @@ transaction_options.explain = True [caption=""] .Properties // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/python/docs/session/TypeDBSession.adoc b/python/docs/session/TypeDBSession.adoc index 88927d862c..8a149ec2e9 100644 --- a/python/docs/session/TypeDBSession.adoc +++ b/python/docs/session/TypeDBSession.adoc @@ -4,7 +4,7 @@ [caption=""] .Properties // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -89,7 +89,7 @@ Registers a callback function which will be executed when this session is closed [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -119,7 +119,7 @@ Registers a callback function which will be executed when this session is reopen [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -149,7 +149,7 @@ Opens a transaction to perform read or write queries on the database connected t [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/transaction/QueryManager.adoc b/python/docs/transaction/QueryManager.adoc index c31d9178ea..823e49941f 100644 --- a/python/docs/transaction/QueryManager.adoc +++ b/python/docs/transaction/QueryManager.adoc @@ -16,7 +16,7 @@ Performs a TypeQL Define query in the transaction. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -47,7 +47,7 @@ Performs a TypeQL Delete query in the transaction. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -78,7 +78,7 @@ Performs a TypeQL Explain query in the transaction. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -109,7 +109,7 @@ Performs a TypeQL Fetch query in the transaction. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -140,7 +140,7 @@ Performs a TypeQL Match (Get) query in the transaction. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -171,7 +171,7 @@ Performs a TypeQL Match Aggregate query in the transaction. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -202,7 +202,7 @@ Performs a TypeQL Match Group query in the transaction. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -233,7 +233,7 @@ Performs a TypeQL Match Group Aggregate query in the transaction. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -264,7 +264,7 @@ Performs a TypeQL Insert query in the transaction. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -295,7 +295,7 @@ Performs a TypeQL Undefine query in the transaction. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value @@ -326,7 +326,7 @@ Performs a TypeQL Update query in the transaction. [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/python/docs/transaction/TransactionType.adoc b/python/docs/transaction/TransactionType.adoc index 459a0806af..4053ff04d1 100644 --- a/python/docs/transaction/TransactionType.adoc +++ b/python/docs/transaction/TransactionType.adoc @@ -13,7 +13,7 @@ session.transaction(TransactionType.READ) [caption=""] .Enum constants // tag::enum_constants[] -[cols="~,~"] +[cols=","] [options="header"] |=== |Name |Value diff --git a/python/docs/transaction/TypeDBTransaction.adoc b/python/docs/transaction/TypeDBTransaction.adoc index 62eedf837e..1ca5c4ba4d 100644 --- a/python/docs/transaction/TypeDBTransaction.adoc +++ b/python/docs/transaction/TypeDBTransaction.adoc @@ -4,7 +4,7 @@ [caption=""] .Properties // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -92,7 +92,7 @@ Registers a callback function which will be executed when this transaction is cl [caption=""] .Input parameters -[cols="~,~,~,~"] +[cols=",,,"] [options="header"] |=== |Name |Description |Type |Default Value diff --git a/rust/docs/answer/ConceptMap.adoc b/rust/docs/answer/ConceptMap.adoc index 4463d9d4f5..dc7b100583 100644 --- a/rust/docs/answer/ConceptMap.adoc +++ b/rust/docs/answer/ConceptMap.adoc @@ -16,7 +16,7 @@ Contains a mapping of variables to concepts. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -62,7 +62,7 @@ Retrieves a concept for a given variable name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/answer/ConceptMapGroup.adoc b/rust/docs/answer/ConceptMapGroup.adoc index 2bc8b5c322..dd43f5dc78 100644 --- a/rust/docs/answer/ConceptMapGroup.adoc +++ b/rust/docs/answer/ConceptMapGroup.adoc @@ -13,7 +13,7 @@ Contains an element of the TypeQL Get Group query result. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/answer/Explainable.adoc b/rust/docs/answer/Explainable.adoc index 0f5c924896..e4d5844093 100644 --- a/rust/docs/answer/Explainable.adoc +++ b/rust/docs/answer/Explainable.adoc @@ -13,7 +13,7 @@ Contains an explainable object. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/answer/Explainables.adoc b/rust/docs/answer/Explainables.adoc index 39b6a10648..9799030cf2 100644 --- a/rust/docs/answer/Explainables.adoc +++ b/rust/docs/answer/Explainables.adoc @@ -14,7 +14,7 @@ Contains explainable objects. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/answer/Explanation.adoc b/rust/docs/answer/Explanation.adoc index 2b8a1efcc5..5f2b3b1954 100644 --- a/rust/docs/answer/Explanation.adoc +++ b/rust/docs/answer/Explanation.adoc @@ -12,7 +12,7 @@ An explanation of which rule was used for inferring the explained concept, the c [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/answer/JSON.adoc b/rust/docs/answer/JSON.adoc index ab64ea6997..cc82c6c277 100644 --- a/rust/docs/answer/JSON.adoc +++ b/rust/docs/answer/JSON.adoc @@ -4,7 +4,7 @@ [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/answer/ValueGroup.adoc b/rust/docs/answer/ValueGroup.adoc index 421257ab0a..0bfae60f8b 100644 --- a/rust/docs/answer/ValueGroup.adoc +++ b/rust/docs/answer/ValueGroup.adoc @@ -13,7 +13,7 @@ Contains an element of a TypeQL Get Group Aggregate query result. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/concept/Concept.adoc b/rust/docs/concept/Concept.adoc index 8557d53ae0..705223c0cc 100644 --- a/rust/docs/concept/Concept.adoc +++ b/rust/docs/concept/Concept.adoc @@ -6,7 +6,7 @@ The fundamental TypeQL object. A Concept is either a Type, Thing, or Value. To u [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/concept/ConceptManager.adoc b/rust/docs/concept/ConceptManager.adoc index a3a88aa67c..0a363fdcc5 100644 --- a/rust/docs/concept/ConceptManager.adoc +++ b/rust/docs/concept/ConceptManager.adoc @@ -23,7 +23,7 @@ Retrieves an ``Attribute`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -77,7 +77,7 @@ Retrieves an ``AttributeType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -128,7 +128,7 @@ Retrieves an ``Entity`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -182,7 +182,7 @@ Retrieves an ``EntityType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -236,7 +236,7 @@ Retrieves a ``Relation`` by its iid. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -290,7 +290,7 @@ Retrieves a ``RelationType`` by its label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -371,7 +371,7 @@ Creates a new ``AttributeType`` if none exists with the given label, or retrieve [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -426,7 +426,7 @@ Creates a new ``EntityType`` if none exists with the given label, otherwise retr [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -480,7 +480,7 @@ Creates a new ``RelationType`` if none exists with the given label, otherwise re [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/connection/Connection.adoc b/rust/docs/connection/Connection.adoc index c59e606752..4a63a18e27 100644 --- a/rust/docs/connection/Connection.adoc +++ b/rust/docs/connection/Connection.adoc @@ -96,7 +96,7 @@ Creates a new TypeDB Cloud connection. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -140,7 +140,7 @@ Creates a new TypeDB Server connection. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/connection/Credential.adoc b/rust/docs/connection/Credential.adoc index 77bec34195..ef325d3e3a 100644 --- a/rust/docs/connection/Credential.adoc +++ b/rust/docs/connection/Credential.adoc @@ -76,7 +76,7 @@ Creates a credential with username and password. Specifies the connection must u [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -111,7 +111,7 @@ Creates a credential with username and password. The connection will not use TLS [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/connection/DatabaseManager.adoc b/rust/docs/connection/DatabaseManager.adoc index c8c57b6623..aa5f6f5c3c 100644 --- a/rust/docs/connection/DatabaseManager.adoc +++ b/rust/docs/connection/DatabaseManager.adoc @@ -99,7 +99,7 @@ Checks if a database with the given name exists [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -168,7 +168,7 @@ Create a database with the given name [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -237,7 +237,7 @@ Retrieve the database with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/connection/ReplicaInfo.adoc b/rust/docs/connection/ReplicaInfo.adoc index 7e1e5c1a52..4afca870f3 100644 --- a/rust/docs/connection/ReplicaInfo.adoc +++ b/rust/docs/connection/ReplicaInfo.adoc @@ -10,7 +10,7 @@ The metadata and state of an individual raft replica of a database. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/connection/User.adoc b/rust/docs/connection/User.adoc index 1eb080fd55..8775400adf 100644 --- a/rust/docs/connection/User.adoc +++ b/rust/docs/connection/User.adoc @@ -11,7 +11,7 @@ User information [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description @@ -61,7 +61,7 @@ Updates user password. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/connection/UserManager.adoc b/rust/docs/connection/UserManager.adoc index f6a44196d4..463a481c6a 100644 --- a/rust/docs/connection/UserManager.adoc +++ b/rust/docs/connection/UserManager.adoc @@ -81,7 +81,7 @@ Checks if a user with the given name exists. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -140,7 +140,7 @@ Create a user with the given name & password. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -234,7 +234,7 @@ Deletes a user with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -285,7 +285,7 @@ Retrieve a user with the given name. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -344,7 +344,7 @@ Sets a new password for a user. This operation can only be performed by administ [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/data/Attribute.adoc b/rust/docs/data/Attribute.adoc index d590b9ad5c..6285b60927 100644 --- a/rust/docs/data/Attribute.adoc +++ b/rust/docs/data/Attribute.adoc @@ -15,7 +15,7 @@ Attribute is an instance of the attribute type and has a value. This value is fi [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/data/Entity.adoc b/rust/docs/data/Entity.adoc index 47251d3305..4d4347c23b 100644 --- a/rust/docs/data/Entity.adoc +++ b/rust/docs/data/Entity.adoc @@ -17,7 +17,7 @@ Instance of data of an entity type, representing a standalone object that exists [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/data/Relation.adoc b/rust/docs/data/Relation.adoc index eb5e486300..f617776d01 100644 --- a/rust/docs/data/Relation.adoc +++ b/rust/docs/data/Relation.adoc @@ -17,7 +17,7 @@ Relation is an instance of a relation type and can be uniquely addressed by a co [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/data/Thing.adoc b/rust/docs/data/Thing.adoc index 28ad0674f0..af64dfae5f 100644 --- a/rust/docs/data/Thing.adoc +++ b/rust/docs/data/Thing.adoc @@ -4,7 +4,7 @@ [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/data/Trait_AttributeAPI.adoc b/rust/docs/data/Trait_AttributeAPI.adoc index c8d363423a..9a7dee5f62 100644 --- a/rust/docs/data/Trait_AttributeAPI.adoc +++ b/rust/docs/data/Trait_AttributeAPI.adoc @@ -22,7 +22,7 @@ Retrieves the instances that own this ``Attribute``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/data/Trait_RelationAPI.adoc b/rust/docs/data/Trait_RelationAPI.adoc index e15630cdde..ed9115aede 100644 --- a/rust/docs/data/Trait_RelationAPI.adoc +++ b/rust/docs/data/Trait_RelationAPI.adoc @@ -23,7 +23,7 @@ Adds a new role player to play the given role in this ``Relation``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -80,7 +80,7 @@ Retrieves all role players of this ``Relation``, optionally filtered by given ro [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -117,7 +117,7 @@ Retrieves all role types currently played in this ``Relation``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -153,7 +153,7 @@ Retrieves a mapping of all instances involved in the ``Relation`` and the role e [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -192,7 +192,7 @@ Removes the association of the given instance that plays the given role in this [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/data/Trait_ThingAPI.adoc b/rust/docs/data/Trait_ThingAPI.adoc index ec86c124aa..5c920a2f7c 100644 --- a/rust/docs/data/Trait_ThingAPI.adoc +++ b/rust/docs/data/Trait_ThingAPI.adoc @@ -23,7 +23,7 @@ Deletes this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -79,7 +79,7 @@ Retrieves the ``Attribute``s that this ``Thing`` owns. Optionally, filtered by a [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -118,7 +118,7 @@ Retrieves the roles that this ``Thing`` is currently playing. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -155,7 +155,7 @@ Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -216,7 +216,7 @@ Checks if this ``Thing`` is deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -295,7 +295,7 @@ Assigns an ``Attribute`` to be owned by this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -351,7 +351,7 @@ Unassigns an ``Attribute`` from this ``Thing``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/data/Value.adoc b/rust/docs/data/Value.adoc index 3376a0d69e..5951e7e969 100644 --- a/rust/docs/data/Value.adoc +++ b/rust/docs/data/Value.adoc @@ -4,7 +4,7 @@ [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/errors/ConnectionError.adoc b/rust/docs/errors/ConnectionError.adoc index ab01a5f8a5..a054d17d61 100644 --- a/rust/docs/errors/ConnectionError.adoc +++ b/rust/docs/errors/ConnectionError.adoc @@ -4,7 +4,7 @@ [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/errors/Error.adoc b/rust/docs/errors/Error.adoc index ee1765862f..68c12716fe 100644 --- a/rust/docs/errors/Error.adoc +++ b/rust/docs/errors/Error.adoc @@ -6,7 +6,7 @@ Represents errors encountered during operation. [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/errors/InternalError.adoc b/rust/docs/errors/InternalError.adoc index 531f18da26..a59d2cc829 100644 --- a/rust/docs/errors/InternalError.adoc +++ b/rust/docs/errors/InternalError.adoc @@ -4,7 +4,7 @@ [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/errors/SchemaException.adoc b/rust/docs/errors/SchemaException.adoc index e25370d288..ddd6cb48d6 100644 --- a/rust/docs/errors/SchemaException.adoc +++ b/rust/docs/errors/SchemaException.adoc @@ -11,7 +11,7 @@ Represents invalid schema constructs discovered during schema validation. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/logic/LogicManager.adoc b/rust/docs/logic/LogicManager.adoc index a2575a69bb..5143c8bc00 100644 --- a/rust/docs/logic/LogicManager.adoc +++ b/rust/docs/logic/LogicManager.adoc @@ -21,7 +21,7 @@ Retrieves the Rule that has the given label. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -101,7 +101,7 @@ Creates a new Rule if none exists with the given label, or replaces the existing [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/logic/Rule.adoc b/rust/docs/logic/Rule.adoc index 261d0f8077..93a346a6d2 100644 --- a/rust/docs/logic/Rule.adoc +++ b/rust/docs/logic/Rule.adoc @@ -14,7 +14,7 @@ Rules are a part of schema and define embedded logic. The reasoning engine uses [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/logic/Trait_RuleAPI.adoc b/rust/docs/logic/Trait_RuleAPI.adoc index 05e7740172..7f1d2bc165 100644 --- a/rust/docs/logic/Trait_RuleAPI.adoc +++ b/rust/docs/logic/Trait_RuleAPI.adoc @@ -21,7 +21,7 @@ Deletes this rule. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -75,7 +75,7 @@ Check if this rule has been deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -147,7 +147,7 @@ Renames the label of the rule. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/schema/Annotation.adoc b/rust/docs/schema/Annotation.adoc index 10bd70bbfe..a11d46fe39 100644 --- a/rust/docs/schema/Annotation.adoc +++ b/rust/docs/schema/Annotation.adoc @@ -6,7 +6,7 @@ Annotations are used to specify extra schema constraints. [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/schema/AttributeType.adoc b/rust/docs/schema/AttributeType.adoc index 7d04230357..9eb1794cdc 100644 --- a/rust/docs/schema/AttributeType.adoc +++ b/rust/docs/schema/AttributeType.adoc @@ -21,7 +21,7 @@ Multiple types can own the same attribute type, and different instances of the s [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/schema/EntityType.adoc b/rust/docs/schema/EntityType.adoc index 95d1117efb..b05cf79360 100644 --- a/rust/docs/schema/EntityType.adoc +++ b/rust/docs/schema/EntityType.adoc @@ -17,7 +17,7 @@ Entity types represent the classification of independent objects in the data mod [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/schema/RelationType.adoc b/rust/docs/schema/RelationType.adoc index c02ec116a7..66d19e78b7 100644 --- a/rust/docs/schema/RelationType.adoc +++ b/rust/docs/schema/RelationType.adoc @@ -21,7 +21,7 @@ A relation type must specify at least one role. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/schema/RoleType.adoc b/rust/docs/schema/RoleType.adoc index 1e9f707ad7..fe40e5c250 100644 --- a/rust/docs/schema/RoleType.adoc +++ b/rust/docs/schema/RoleType.adoc @@ -18,7 +18,7 @@ Roles allow a schema to enforce logical constraints on types of role players. [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/schema/ScopedLabel.adoc b/rust/docs/schema/ScopedLabel.adoc index 3962192ff6..41abf59076 100644 --- a/rust/docs/schema/ScopedLabel.adoc +++ b/rust/docs/schema/ScopedLabel.adoc @@ -14,7 +14,7 @@ [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/schema/ThingType.adoc b/rust/docs/schema/ThingType.adoc index 9fcc28f0c1..42e18f9c1d 100644 --- a/rust/docs/schema/ThingType.adoc +++ b/rust/docs/schema/ThingType.adoc @@ -4,7 +4,7 @@ [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/schema/Trait_AttributeTypeAPI.adoc b/rust/docs/schema/Trait_AttributeTypeAPI.adoc index b176a544cb..cbfd2c6a6b 100644 --- a/rust/docs/schema/Trait_AttributeTypeAPI.adoc +++ b/rust/docs/schema/Trait_AttributeTypeAPI.adoc @@ -22,7 +22,7 @@ Retrieves an ``Attribute`` of this ``AttributeType`` with the given value if suc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -78,7 +78,7 @@ Retrieves all direct and indirect (or direct only) ``Attributes`` that are insta [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -117,7 +117,7 @@ Retrieve all ``Things`` that own an attribute of this ``AttributeType`` and have [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -155,7 +155,7 @@ Retrieves the regular expression that is defined for this ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -210,7 +210,7 @@ Retrieves all direct and indirect (or direct only) subtypes of this ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -249,7 +249,7 @@ Retrieves all direct and indirect (or direct only) subtypes of this ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -287,7 +287,7 @@ Retrieves the most immediate supertype of this ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -341,7 +341,7 @@ Retrieves all supertypes of this ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -378,7 +378,7 @@ Adds and returns an ``Attribute`` of this ``AttributeType`` with the given value [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -436,7 +436,7 @@ Can only be applied for ``AttributeType``s with a ``string`` value type. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -492,7 +492,7 @@ Sets the supplied ``AttributeType`` as the supertype of the current ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -547,7 +547,7 @@ Removes the regular expression that is defined for this ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/schema/Trait_EntityTypeAPI.adoc b/rust/docs/schema/Trait_EntityTypeAPI.adoc index 03f7e0d0f4..44d2e100e6 100644 --- a/rust/docs/schema/Trait_EntityTypeAPI.adoc +++ b/rust/docs/schema/Trait_EntityTypeAPI.adoc @@ -21,7 +21,7 @@ Creates and returns a new instance of this ``EntityType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -76,7 +76,7 @@ Retrieves all direct and indirect (or direct only) ``Entity`` objects that are i [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -114,7 +114,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``EntityType` [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -151,7 +151,7 @@ Retrieves the most immediate supertype of the ``EntityType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -205,7 +205,7 @@ Retrieves all supertypes of the ``EntityType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -242,7 +242,7 @@ Sets the supplied ``EntityType`` as the supertype of the current ``EntityType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/schema/Trait_RelationTypeAPI.adoc b/rust/docs/schema/Trait_RelationTypeAPI.adoc index 7f4d70aa97..f0a979d2da 100644 --- a/rust/docs/schema/Trait_RelationTypeAPI.adoc +++ b/rust/docs/schema/Trait_RelationTypeAPI.adoc @@ -21,7 +21,7 @@ Creates and returns an instance of this ``RelationType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -76,7 +76,7 @@ Retrieves all direct and indirect (or direct only) ``Relation``s that are instan [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -114,7 +114,7 @@ Retrieves roles that this ``RelationType`` relates to directly or via inheritanc [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -152,7 +152,7 @@ Retrieves role with a given ``role_label`` that this ``RelationType`` relates to [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -208,7 +208,7 @@ Retrieves a ``RoleType`` that is overridden by the role with the ``overridden_ro [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -264,7 +264,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``RelationTyp [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -301,7 +301,7 @@ Retrieves the most immediate supertype of the ``RelationType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -355,7 +355,7 @@ Retrieves all supertypes of the ``RelationType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -393,7 +393,7 @@ Sets the new role that this ``RelationType`` relates to. If we are setting an ov [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -450,7 +450,7 @@ Sets the supplied ``RelationType`` as the supertype of the current ``RelationTyp [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -506,7 +506,7 @@ Disallows this ``RelationType`` from relating to the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/schema/Trait_RoleTypeAPI.adoc b/rust/docs/schema/Trait_RoleTypeAPI.adoc index 86489cdb4e..39225bc6ee 100644 --- a/rust/docs/schema/Trait_RoleTypeAPI.adoc +++ b/rust/docs/schema/Trait_RoleTypeAPI.adoc @@ -21,7 +21,7 @@ Deletes this type from the database. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -76,7 +76,7 @@ Retrieves the ``Thing`` instances that play this role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -114,7 +114,7 @@ Retrieves the ``ThingType``s whose instances play this role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -152,7 +152,7 @@ Retrieves the ``Relation`` instances that this role is related to. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -189,7 +189,7 @@ Retrieves the ``RelationType`` that this role is directly related to. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -243,7 +243,7 @@ Retrieves ``RelationType``s that this role is related to (directly or indirectly [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -280,7 +280,7 @@ Retrieves all direct and indirect (or direct only) subtypes of the ``RoleType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -317,7 +317,7 @@ Retrieves the most immediate supertype of the ``RoleType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -371,7 +371,7 @@ Retrieves all supertypes of the ``RoleType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -431,7 +431,7 @@ Checks if this type is deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -486,7 +486,7 @@ Renames the label of the type. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/schema/Trait_ThingTypeAPI.adoc b/rust/docs/schema/Trait_ThingTypeAPI.adoc index 65efd40f55..5b046e7b78 100644 --- a/rust/docs/schema/Trait_ThingTypeAPI.adoc +++ b/rust/docs/schema/Trait_ThingTypeAPI.adoc @@ -24,7 +24,7 @@ Deletes this type from the database. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -81,7 +81,7 @@ Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -139,7 +139,7 @@ Retrieves an ``AttributeType``, ownership of which is overridden for this ``Thin [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -195,7 +195,7 @@ Retrieves all direct and inherited (or direct only) roles that are allowed to be [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -251,7 +251,7 @@ Retrieves a ``RoleType`` that is overridden by the given ``role_type`` for this [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -306,7 +306,7 @@ Produces a pattern for creating this ``ThingType`` in a ``define`` query. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -384,7 +384,7 @@ Checks if this type is deleted. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -486,7 +486,7 @@ Set a type to be abstract, meaning it cannot have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -541,7 +541,7 @@ Renames the label of the type. The new label must remain unique. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -599,7 +599,7 @@ Allows the instances of this ``ThingType`` to own the given ``AttributeType``. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -658,7 +658,7 @@ Allows the instances of this ``ThingType`` to play the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -714,7 +714,7 @@ Set a type to be non-abstract, meaning it can have instances. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -769,7 +769,7 @@ Disallows the instances of this ``ThingType`` from owning the given ``AttributeT [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -825,7 +825,7 @@ Disallows the instances of this ``ThingType`` from playing the given role. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/schema/Transitivity.adoc b/rust/docs/schema/Transitivity.adoc index 700b1d5bb3..57bcfeba5b 100644 --- a/rust/docs/schema/Transitivity.adoc +++ b/rust/docs/schema/Transitivity.adoc @@ -6,7 +6,7 @@ Used for specifying whether we need explicit or transitive subtyping, instances, [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/schema/ValueType.adoc b/rust/docs/schema/ValueType.adoc index c536b3dbae..380e455d21 100644 --- a/rust/docs/schema/ValueType.adoc +++ b/rust/docs/schema/ValueType.adoc @@ -6,7 +6,7 @@ Represents the type of primitive value is held by a Value or Attribute. [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/session/Options.adoc b/rust/docs/session/Options.adoc index ad59eaa117..55ffd9066a 100644 --- a/rust/docs/session/Options.adoc +++ b/rust/docs/session/Options.adoc @@ -13,7 +13,7 @@ TypeDB session and transaction options. ``TypeDBOptions`` object can be used to [caption=""] .Fields // tag::properties[] -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Type |Description diff --git a/rust/docs/session/Session.adoc b/rust/docs/session/Session.adoc index 953ecf76bd..e0c1ab5f0a 100644 --- a/rust/docs/session/Session.adoc +++ b/rust/docs/session/Session.adoc @@ -154,7 +154,7 @@ Opens a communication tunnel (session) to the given database on the running Type [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -207,7 +207,7 @@ Registers a callback function which will be executed when this session is closed [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -240,7 +240,7 @@ Registers a callback function which will be executed when this session is reopen [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -340,7 +340,7 @@ Opens a transaction to perform read or write queries on the database connected t [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/session/SessionType.adoc b/rust/docs/session/SessionType.adoc index fb78171dea..84fa0a667d 100644 --- a/rust/docs/session/SessionType.adoc +++ b/rust/docs/session/SessionType.adoc @@ -6,7 +6,7 @@ This enum is used to specify the type of the session. [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/rust/docs/transaction/QueryManager.adoc b/rust/docs/transaction/QueryManager.adoc index f0dfd0222a..6b69f821c4 100644 --- a/rust/docs/transaction/QueryManager.adoc +++ b/rust/docs/transaction/QueryManager.adoc @@ -41,7 +41,7 @@ Performs a TypeQL Define query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -114,7 +114,7 @@ Performs a TypeQL Delete query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -190,7 +190,7 @@ Performs a TypeQL Explain query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -248,7 +248,7 @@ Performs a TypeQL Match Group Aggregate query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -326,7 +326,7 @@ Performs a TypeQL Match Aggregate query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -422,7 +422,7 @@ Performs a TypeQL Match Group Aggregate query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -460,7 +460,7 @@ Performs a TypeQL Match Group query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -498,7 +498,7 @@ Performs a TypeQL Match (Get) query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -556,7 +556,7 @@ Performs a TypeQL Insert query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -611,7 +611,7 @@ Performs a TypeQL Undefine query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type @@ -687,7 +687,7 @@ Performs a TypeQL Update query in the transaction. [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/transaction/Transaction.adoc b/rust/docs/transaction/Transaction.adoc index c166e10143..3ff9d6e9b8 100644 --- a/rust/docs/transaction/Transaction.adoc +++ b/rust/docs/transaction/Transaction.adoc @@ -147,7 +147,7 @@ Registers a callback function which will be executed when this transaction is cl [caption=""] .Input parameters -[cols="~,~,~"] +[cols=",,"] [options="header"] |=== |Name |Description |Type diff --git a/rust/docs/transaction/TransactionType.adoc b/rust/docs/transaction/TransactionType.adoc index 55cff6ab3d..cab6475014 100644 --- a/rust/docs/transaction/TransactionType.adoc +++ b/rust/docs/transaction/TransactionType.adoc @@ -6,7 +6,7 @@ This enum is used to specify the type of transaction. [caption=""] .Enum variants // tag::enum_constants[] -[cols="~"] +[cols=""] [options="header"] |=== |Variant diff --git a/tool/docs/adoc/AsciiDocTableBuilder.kt b/tool/docs/adoc/AsciiDocTableBuilder.kt index ea2071f22f..9dfcc9bdf5 100644 --- a/tool/docs/adoc/AsciiDocTableBuilder.kt +++ b/tool/docs/adoc/AsciiDocTableBuilder.kt @@ -32,7 +32,7 @@ class AsciiDocTableBuilder(private val headers: List) { } private fun header(): String { - return "[cols=\"~" + ",~".repeat(this.headers.size - 1) + + return "[cols=\"" + ",".repeat(this.headers.size - 1) + "\"]\n[options=\"header\"]\n" + "|===\n|" + headers.joinToString(" |") + "\n" diff --git a/tool/docs/c/DoxygenParserC.kt b/tool/docs/c/DoxygenParserC.kt index 2af94b3916..be1b1926e4 100644 --- a/tool/docs/c/DoxygenParserC.kt +++ b/tool/docs/c/DoxygenParserC.kt @@ -198,7 +198,12 @@ class DoxygenParserC : Callable { val methodAnchor = replaceSymbolsForAnchor(methodName) val methodSignature = enhanceSignature(element.selectFirst("table.memname")!!.text()) val argsList = getArgsFromSignature(methodSignature) - val argsMap = argsList.toMap() + val argsMap = argsList.associate { (first, second) -> + Pair( + addZeroWidthWhitespaces(first), + addZeroWidthWhitespaces(second) + ) + } val methodReturnType = getReturnTypeFromSignature(methodSignature) val methodDescr: List = element.selectFirst("div.memdoc") ?.let { splitToParagraphs(it.html()) } @@ -209,9 +214,9 @@ class DoxygenParserC : Callable { val argName = it.child(0).text() assert(argsMap.contains(argName)) Variable( - name = argName, - type = argsMap[argName], + name = addZeroWidthWhitespaces(argName), description = reformatTextWithCode(it.child(1).html()), + type = argsMap[argName], ) } diff --git a/tool/docs/cpp/DoxygenParserCpp.kt b/tool/docs/cpp/DoxygenParserCpp.kt index e465fd23e3..b4051e34ee 100644 --- a/tool/docs/cpp/DoxygenParserCpp.kt +++ b/tool/docs/cpp/DoxygenParserCpp.kt @@ -247,7 +247,12 @@ class DoxygenParserCpp : Callable { val methodName = element.previousElementSibling()!!.text().substringBefore("()").substringAfter(" ") val methodSignature = enhanceSignature(element.selectFirst("table.memname")!!.text()) val argsList = getArgsFromSignature(methodSignature) - val argsMap = argsList.toMap() + val argsMap = argsList.associate { (first, second) -> + Pair( + addZeroWidthWhitespaces(first), + addZeroWidthWhitespaces(second) + ) + } val methodReturnType = getReturnTypeFromSignature(methodSignature) val methodDescr: List = element.selectFirst("div.memdoc") ?.let { splitToParagraphs(it.html()) } @@ -259,9 +264,9 @@ class DoxygenParserCpp : Callable { val argName = it.child(0).text() assert(argsMap.contains(argName)) Variable( - name = argName, - type = argsMap[argName], + name = addZeroWidthWhitespaces(argName), description = reformatTextWithCode(it.child(1).html(), idToAnchor), + type = argsMap[argName], ) } @@ -282,9 +287,9 @@ class DoxygenParserCpp : Callable { val name = element.selectFirst("td.memname")!!.text().substringAfterLast("::") val descr = reformatTextWithCode(element.selectFirst("div.memdoc")!!.html(), idToAnchor) return Variable( - name = name, + name = addZeroWidthWhitespaces(name), description = descr, - type = type, + type = addZeroWidthWhitespaces(type), ) } diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index 03d969638c..d8e9a4acec 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -240,7 +240,12 @@ class DoxygenParserCsharp : Callable { val methodName = element.previousElementSibling()!!.text().substringBefore("()").substringAfter(" ") val methodSignature = updateSignature(element.selectFirst("table.memname")!!.text()) val argsList = getArgsFromSignature(methodSignature) - val argsMap = argsList.toMap() + val argsMap = argsList.associate { (first, second) -> + Pair( + addZeroWidthWhitespaces(first), + addZeroWidthWhitespaces(second) + ) + } val methodReturnType = getReturnTypeFromSignature(methodSignature) val methodDescr: List = element.selectFirst("div.memdoc") ?.let { splitToParagraphs(it.html()) } @@ -252,9 +257,9 @@ class DoxygenParserCsharp : Callable { val argName = it.child(0).text() assert(argsMap.contains(argName)) Variable( - name = argName, - type = argsMap[argName], + name = addZeroWidthWhitespaces(argName), description = reformatTextWithCode(it.child(1).html(), idToAnchor), + type = argsMap[argName], ) } @@ -274,14 +279,14 @@ class DoxygenParserCsharp : Callable { val name = element.selectFirst("td.memname")!!.text().substringAfterLast("::") val descr = reformatTextWithCode(element.selectFirst("div.memdoc")!!.html(), idToAnchor) return Variable( - name = name, + name = addZeroWidthWhitespaces(name), description = descr, - type = type, + type = addZeroWidthWhitespaces(type), ) } private fun getArgsFromSignature(methodSignature: String): List> { - var splittedArgsAndTypes = methodSignature + val splittedArgsAndTypes = methodSignature .replace("\\s+".toRegex(), " ") .substringAfter("(").substringBefore(")") .split(",\\s".toRegex()).toMutableList() @@ -295,8 +300,7 @@ class DoxygenParserCsharp : Callable { if (splittedArgsAndTypes[i].contains("<") && !splittedArgsAndTypes[i].contains(">")) { splittedArgsAndTypes[i] = splittedArgsAndTypes[i] + ", " + splittedArgsAndTypes[i + 1] splittedArgsAndTypes.removeAt(i + 1) - } - else { + } else { ++i } } @@ -309,7 +313,7 @@ class DoxygenParserCsharp : Callable { private fun reformatTextWithCode(html: String, idToAnchor: Map): String { return formatSeeAlso( - replaceAngleBracketCodes( + replaceHtmlSymbols( removeHyperlinkFormatting( removeAllTags( replaceLocalLinks( @@ -341,7 +345,7 @@ class DoxygenParserCsharp : Callable { val seeAlsoEndIndex = seeAlsoIndex + oldSeeAlso.length val seeTargetEnd = Regex("([^\\s])+\n").find(updatedHtml, seeAlsoEndIndex) val seeTargetEndIndex = seeTargetEnd?.range?.endInclusive - if (seeTargetEndIndex != null ) { + if (seeTargetEndIndex != null) { updatedHtml = StringBuilder(updatedHtml).apply { insert(seeTargetEndIndex + 1, "----") }.toString() seeAlsoIndex = seeTargetEndIndex + "----".length @@ -359,12 +363,11 @@ class DoxygenParserCsharp : Callable { var updatedHtml = html val regex = Regex("<<#_[a-zA-Z_]+,.*>>") - regex.findAll(html).map{ it.value }.forEach{ + regex.findAll(html).map { it.value }.forEach { val newValue = it .substringAfter("<<#_") .substringBeforeLast(">>") - .split(",") - .let { it.drop(1).joinToString(",") } + .split(",").drop(1).joinToString(",") updatedHtml = updatedHtml.replace(it, newValue) } @@ -375,10 +378,6 @@ class DoxygenParserCsharp : Callable { return html.replace("
", "[source,cs]\n----\n").replace("
", "\n----\n") } - private fun replaceAngleBracketCodes(html: String): String { - return html.replace("<", "<").replace(">", ">") - } - private fun updateSignature(signature: String): String { var enhanced = replaceSpaces(signature) enhanced = enhanced @@ -386,7 +385,7 @@ class DoxygenParserCsharp : Callable { .replace("< ", "<") .replace(" >", ">") enhanced = Regex("\\s([()*&])").replace(enhanced, "$1") - var splitted = enhanced.split(" ").toMutableList() + val splitted = enhanced.split(" ").toMutableList() val methodNameIndex = splitted.indexOfFirst { it.contains('(') } if (methodNameIndex != -1) { splitted[methodNameIndex] = splitted[methodNameIndex].substringAfterLast(".") diff --git a/tool/docs/util/Util.kt b/tool/docs/util/Util.kt index 17019bfc82..86324bde0f 100644 --- a/tool/docs/util/Util.kt +++ b/tool/docs/util/Util.kt @@ -49,6 +49,10 @@ fun replaceSymbolsForAnchor(name: String): String { .removeSuffix("_") } +fun addZeroWidthWhitespaces(html: String): String { + return html.replace(".", "\u200B.") +} + fun escape(text: String): String { return text.replace("|", "\\|") } From 2b2c0050e5cea9572f16aad94ac7a03c88eb47e2 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 26 Mar 2024 15:39:56 +0000 Subject: [PATCH 053/118] Remove excessive files --- csharp/docs/schema/Label.html | 710 ---------------------------------- csharp/docs/schema/Label.pdf | Bin 73752 -> 0 bytes 2 files changed, 710 deletions(-) delete mode 100644 csharp/docs/schema/Label.html delete mode 100644 csharp/docs/schema/Label.pdf diff --git a/csharp/docs/schema/Label.html b/csharp/docs/schema/Label.html deleted file mode 100644 index 43088d117e..0000000000 --- a/csharp/docs/schema/Label.html +++ /dev/null @@ -1,710 +0,0 @@ - - - - - - - -Label - - - - - -
-
-

Label

-
-

Package: TypeDB.Driver.Common

-
-
-

A Label holds the uniquely identifying name of a type.

-
-
-

It consists of an optional scope, and a name, represented scope:name. The scope is used only used to distinguish between role-types of the same name declared in different relation types.

-
- - ----- - - - - - - - - - - - - - - - - - - - -
Fields
NameTypeDescription
-

readonly string TypeDB.Driver.Common.Label.Name

-
-

readonly string TypeDB.Driver​.Common​.Label​.Name

-
-

Returns the name of this Label. -Examples

-
-
-
-
label.Name;
-
-
-

readonly? string TypeDB.Driver.Common.Label.Scope

-
-

readonly? string TypeDB.Driver.Common.Label.Scope

-
-

Returns the scope of this Label. -Examples

-
-
-
-
label.Scope;
-
-
-
-

Equals

-
-
-
override bool Equals(object? obj)
-
-
-
-

Checks if this Label is equal to another object.

-
- - ----- - - - - - - - - - - - - - - -
Input parameters
NameDescriptionType
-

obj

-
-

Object to compare with

-
-

object?

-
-
-
Returns
-

override bool

-
-
-
Code examples
-
-
label.Equals(obj);
-
-
-
-
-

Label

-
-
-
Label(string? scope, string name)
-
-
-
-

Creates a Label from a specified scope and name.

-
- - ----- - - - - - - - - - - - - - - - - - - - -
Input parameters
NameDescriptionType
-

scope

-
-

Label scope

-
-

string?

-
-

name

-
-

Label name

-
-

string

-
-
-
Returns
-

Label

-
-
-
Code examples
-
-
new Label("relation", "role");
-
-
-
-
-

Label

-
-
-
Label(string name)
-
-
-
-

Creates a Label from a specified name.

-
- - ----- - - - - - - - - - - - - - - -
Input parameters
NameDescriptionType
-

name

-
-

Label name

-
-

string

-
-
-
Returns
-

Label

-
-
-
Code examples
-
-
new Label("entity");
-
-
-
-
-

ScopedName

-
-
-
string TypeDB.Driver.Common.Label.ScopedName
-
-
-
-

Returns the string representation of the scoped name.

-
-
-
Returns
-

string

-
-
-
Code examples
-
-
label.ScopedName;
-
-
-
-
-

ToString

-
-
-
override string ToString()
-
-
-
-

Returns the string representation of the scoped name.

-
-
-
Returns
-

override string

-
-
-
Code examples
-
-
label.ToString();
-
-
-
-
-
- - - \ No newline at end of file diff --git a/csharp/docs/schema/Label.pdf b/csharp/docs/schema/Label.pdf deleted file mode 100644 index 6489baf675df0aecf1680b3409d978e2a1e5e8cd..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 73752 zcmeEv2|QKX_joB3Nr{S-+ki6P*_Fsx%2a3|WVq&eo;9IJWvYZUBbh2xW(}kw5lIO} zqKuW9|33HLbMIANq4(bR|NZ>F-|rK9pL5n(d#%0JUTf{O*WuSxR2D^wVOaRb!T(s0 z2nmF}u@#H7G(ue4(#3{|Sg&K}0{vmSfkj-wiD=|v?}S({=WJqWX=-l*H2?qvN(?PV z5J4ClITKA0_I3zOCnI+|(2Eh10FP-p*_*nW5U2f|n!Tx_kqbaUQ3@r2!bqS|I3xy( zL`w=wNC<-eV2mv7?IyVog&|PylaXN|+L=NFL(vb=(}9Q(S1@uhvavS@Xd0Oloe^ko z!%h})bt7BQAdnjxt}Zr~cA$;IkUOATRgH{^HlPbn>jDS^fI7}Z_yHDi4F{r~oQVrS z5ur!A6Cti_>9Q3ei9w1<67*TbcUcnMiB6hML^Glj(ar?C1fsp7rL%*Lk*A`)37HEn zPOd~2Fbdj0AUvs@A`OIuKVXu*tDOr1%_6?t($pD#DN+)`5`lt-zf+$M3^X7Zj4IL2 z+{FTcf-XC|0AAa&II=*5qckWa#L_*YO?@*&KQI9BX6O|x;%Y=wOCx!E4}_is=)e-N zVkk-4s1=;-9scs7ybY0P`j=O=oh)tt@}iuR%U@nou(xvo2s$GuOx#Iyws&=cDGny7 zi5AfXp(hSaXmM?#hYLbn#TGDHp7L9P@>_*OKN=@+bo8K*5Q&#WN=_i7xFXTb(uBBk zi#)=_nMFbjFoN>qY+}bkcU3`a!c{E=bru$RZ5E8A7?^x`Nt_rCheK$avWP3A#3T@a zui9oT(ijsQ5{JTJaV9bdZ7UWfZ599o(4F!F0fGO9enYQ>Ul0BMvHinKv65mq4E;+b z#IU5-VkN+9(Kuu9FCK^eTVG8;ieV+efa%|jga!=18*PM=n8q7%1Pl_QIT8i_fM|~g znuId&$*;jgAmGK&5;*KcRM7OOU@>?C9^8V#U{EL`27^c82zVS0i-%fhoEgp({ND^m zoCdlRrw2W+V6-R`0xcmX2~UU#^Z~>DcjyB+gvOx|czR4GkmnzooRSzZ9AN2$_fDVy zN&+Vd$Zmqe;L#`vJO;F|;5QaW1nfbA-#}dO1aKDt%x=&N?jYcBcmnvBh{J<^BAC~v z&@%uE4*Ux!il?v|^*1sTa8MGUhR}AWmvjk0LrIFzO&Au2fX4u2pm{~aqrp(n04Xp) z7)cxv`Wp`om;l`a24O-s6-bHzyoz2QOs*d$7YnkknEV=PZvHSFBpxq@LZTt%ML(no zGXx9+3If1YwU)MUu~L^+`SuweE<|Dq{kg@q_N0|fsbDx%S7F6m>|`;ox0U*WxrA42OfP2n-4u zH`&mdGQsGc6juhm5rQB_z>`fW3=R+rEJ)B|MdjJ=bTozovzZwQ)V?!1Kuq<)FY5n0h zw8~Rv8WyYHPN9&1M`VTg zSImOlzdv9W6;Ud$08lXrFhyp>Dk?ZCr(ke1VH6eGROtG9Ho>S+p}`$9XA)WxO<8dM ziboh=F+esRum*su4%-5M$+0Pj15K$wYwh2ovfzb=4jSA=C#%0FF^n5h42{816(9r( zi6hKZ0it1ORKcAD;N%K$hIYIphyfvKjxj}P0)Zr;31p=?(Tjv^J|wUKX{Ipb8Uv04 z(-=?X^*`>!(e%3nMvMSf9Fl&YfGU{sQ;HaY_z^X-2mU6l3e^-(v#O7%bRj0)cN3js>Ba zX+$F&0iFb$1PC?!_#5(A&>&g_1qHyaju;XPSxi_ASUND&4ja&c0&WojN$Z0q73mhR z!HkoHF2Efi1_OYYfM>{e0OJ6P6hJ`89T)-#`Vl|`oenCnsiB+T7gL%hG~6gXHlPP9 z20~1v$H@;-2}cD??V-FIfeOwNgJI|sFA$C3R__~EZUeVpuaPL zes2(vEp}+`LKF1wvH#(C4;?hPYg$U0h8u`cQoRYFCO}+hnyUxZkb*`^hDPn01mNUK zdWKdlo)QhEXm7GNfdvK~Zc5$++6?IF|ExcOMS_j^ztNw-lJ*m(F^gwNd73{V0anUM z{fP;Ce}67c)Ja8?D0;(!yi!mDl)o2GDm++#XbuJ3GcA##!kd~L{2oF2(UIi}?)jI+ zie}#acSsfu-~V3WqK)C-k}r62(Zq|+(w??-!O&n)qWTnY$FyV%hDH-DxMvbk_`PJ& z4U8;Ul#WS&O}dTMROTrsY@sM!5jXi)_7PP{50wu+@krCyruCnQ$OQ>~C}Q z!M+aI+XU%{Vv@kHhGr57ebYLinFMlyNp3!T6Rc8^AP|8e3nXdx3nL*(0s;vnsRPpF z5@5p_0z&Qp*<~OmL-NyMsAyp6LpM=g3^xG~5@v84zyQF|P?8L$UhCsRxLL16rG$V%{K{hgF802BiDESE_PKpt*=outG z(Leb^@{^u4SjdQATNWgT0n7o`c$5qR1@REP3n2|fBf;39EnE~(Q~C()ZBt5dClT|f z^e7ZKih#vP{#km|p8$c)(TOl-kRAnyA%+LZp?{R<^(R26Bbk86FGuowgPWps!G07P zoEV`CUZE*nbl$)e_7=(DU|Q3GgS+U!O$Rv;C8x&1z?lLlHFkPCDbyGMG%hkUYS$zH zr{Y}DQj5?MP`sI<0Z9i%ps|sTiu{eKMKDKb(Ga+Yj;K@M5#6}SvPlCtBQ8sv1QBKMguFI7#q{&YGv1#-xLJ zWMdQZ1i+~TaIgv|`FAp$I$Da!NeyhmvOO*KP@z%emIiGmf=q=r72f=w)l}UIi!$6X zRYuQTkYT0#J5h$cxhZp)cIE>GLIoHJaC#cdt?8ZlpnviQw?}$nddQT~`jfmqiuy)_ zFeW$;HJQ@;D-U_f=+RM40!p0#XEdizHM%E%q#Ef&E!lbhXEIgD(FY_*kO7G>v;Y>| zK_9?^`zVtg34(+K0+tj}CWWVf|4ITv4Pb$T(jdfzqXn=)zA6ZD0Y4vvtKa|@I8#l! zi4wqqn{WUNZqo&@;4U(IX)xh7`K53G3&si#V9}us2e7CEBL%SF))WF*@U7IiAKdYO zoNQB#8IuE8ND#s#;6Ts{+D9Q}4o{MYLXGx-=ny4fg(CbT(PMCYmvqLPgbvA@q(qOY zX)#mQ4!=$kqlg~xMSvQj6Fo}DggHd%gGCP{;eoSsbfO2gq97nt(E}M>5-2*!1BRa@ za-!gYgmdT?iri6Ju-H+WbW%s@AqyE59HmKq8&%{e*ic1|hAvg)-~o|Ej?$Wn$Wd;k zi5#Wl|0ubpCu&gW22_OjQPSuVF(v8Ke#mJ+@NsqMq&WRm5MhN6ss0n8VvuqL&d`!^ z{UK5eLfRmBO^T61wE)1Wb-EEqfMa~nQCm~;6@W3=X98mY5oOY;Qz+_6f3_Gt`wov~ z>c?au@unSrBcD{GwIRQWWacBbu}C1S-~)oiUG%4 zfg*zUn!z~*;I^TWQ`SX0Kz88Ia!z{d z4M|m-HXxwa?nJCNgcz(SZ>Z>G=|*%iRIspHnDdg{sf1_C4hmUk)4T!y_2Ymy~73s2zZmB+XHl*EKP}q#`g9$zrs?<(bdSt z+0f7sj1*8D`UPPL)o6moM}W@t>tR$Lb_iY)V_l7 z1``lG3AkE!I9U||IHu!yS~Q5q;LmPLHGrKyVrsOm+j`J`>H zV`pgsmFYs0r!K9G6I34PhY9v0rWjLG6A2^@(I31GY;$n12LRiC- z8X^iPC-wt5B``qsql9f8Y+Rj@wsxXUL~~agBd4k0iXqF;R0s;{ACPEI!xbv4G*JNQ zYl}^es}We3i1e&i0kzmHO{Rn^g`-oTEAY2|#FZo;kS2na1zgl@q8DXuKP6uYJ#<8!0*~m% zP1Z7W0I7+bGfDcN8fkyecIrf@vWnXCGwY|yDeCseFPQaD?IOc`qV7b%9n)hRjS4W| zC_$YW2^SUGRH*!WropICp}`$9XBoU<@z)#!@A#W`kzo@4O)87B*w90xbkVW=_e7yAL_(=?nUx z+CRfu>bNLN7EQNOI;JIPRA^Mb!s=@#Y^6e*3KxFQR2UU1G`M4`ES7wDh-A$<0q%i+O+ zY&X2*WQmJ38)YU`!h$T68D%=*=$`zMO8-*M4k(@rGU@TO!~wX2ekUC6qfBiaNV@@U zD=l#V2Tgtegqk=2u7MOCJS}Gj?5>L8P~aiDoE;qaFadNEC3gUB!pQ@0n=X3*?jommkCSbBi3B)sGz$2EbhZX1 zXNL&RErHJo(8LlXDuN^5U2GCz5a%Sp;b?;WqiDut>sK!6HeAHY}3VfssTKZcRZX;ajO933vP-C)@Ny z5-R-#lH-07NqSMFw<>7n<3DoJ6AP*qN`eE8)QlDC$85lk;2-Ai!2ZmPPIZEk{Ge>Z zOcHhJpZsCb|95v5F_4UcbiY5^#rhKV7;uLTfof9>M04N0O!NK6a<`{U#-?SeGlkjg+Sripb4~^0_EgsR-sU!hOQ-A;z`1;gL z6(9gghDH#>a!BRXeA)`X0aurrxGhr$f z+EjS(dzQkeP@%ycQ)TGPMV6|5|59k_eY6?GG{KjH!56#8GiZ9JH|d}J!M*vaLO%!z6k+L~N7v!Z?8N^|J`Hiv3QX8gnbQ1;4 zatx@!K%G!<2mOSC`zS(%!a-%N>EsYBwIm=^IYfaEr9r7(R5?U}r2-2CgI*3%z)XN{ zqR1iKgyj%!)5#&+MV31nOt?*cDJ+LDRp$*F+bzmepgj-XPL-^MJkqv`@X#tUK zdUA+@T)+w09%MPBHy@y{sm|ovOMfIe^yV%3OeD?xg_F-HlTHGvIxvZ;JF!*-sfY>r zbJlbv=|L~_!I6pI-lgp@LDm1@3W89<6Y7ai(g#$hf7X+>wT=XbpRojTU}}1%1O1af znhq0(JY|dK&&y+gZ;nBk0(ANuvY*M>oV28{DI-KjCp1_n0DBkIAs|%M4ytTG$DOE}9aPYefXW#FH4c}< z05vqATPS*+(t_1GrAepNDLrI)qJpC|$!~*II*bjh(&^BJRXTM*B$W=grl8W{TmMHc zh}+XuJHI2-{FR2_vtQ;(8QII2!M`b|3bNuvBtggE)II#~HgsXr4Aev(c?PjWLF#3CSX zapKMNhomW|L{XsF?Sw<3f7ek^;0{RO$bv=l4D_V27*KK-GCsg3H$ll=Gc289G4+zW zQ}Ge-V7D1;t5FprrA@z#P`W6q2p-f=$AM)8vh7K3IQWhj1cADU0J9%BV6;U9lo1xg z;GoLhv{eKTzBUH#p{yd57QBj3nsloOrH8z1(BQ#s()-|Lgn|ydiqN48uOjexNQ(%i zF@-gRa_9djHQnU{j|Io5CFw(Cl;z{60^mRT1`{Vf$kh5L>bT&MI5ALyg)D?5eFPhr z6K&rA&&+(BBw@ng^r^cw^iTe1zD^wSl-I;RH}gSF9MWNQnvDT-0hCO~k&2B&-wq~~ znxmg4Q$~?y_yZsyUNNKGW4b4Qq};z`_=C?Nf{&g+)vhVZ6Yikb*l-_3LqngoMn>sL(?uJ`aP~PyZ|05gtj6G!vP2Uj!wf{jNlinAf#1R0W z{H8ZoAg%rHI0AoH%_{Vib;{(f0H{p*U+xN^C^e@3fvQ!1W&M-YDaB&|mj2JK01{Zl zu%j@+6(E&IB3bt&%2Qo|$?8@C2k=MUXt=uASlSVtf%|3e3OqGXwTM*41_4TglPc9f zHH;9T5+TJ&p%kehU4`B%EsYS@wsf%}BBafTW@Zu+SS+yVi4x#L!r(W7^4kRb4fSKd z&?qh;2^UZ?iTqj#7IAf=2lYjyLRyH4MQtVwh*mC#gxaK-V4$}m!4Hb^c9UPcUDJu^ zMjbO$#%qdir!T6b?rQ4{xwa5ZG!g5O8-UY@<%*Q;ooqpEtG{%8;SxYN>@R&g;DA!f=t1FPI?qo*YeIoND0ocD zpqW@u&+(^6BtfM=FhcOfR{G!MT^>?Bdh+@R!gUg)b)LN23ALaUhsl)=$xWtC0#Yri z|KkMt*^Nhnx^!T}4^$;1+L^mpAi(wn8WMIJ7ornFPh8o?$c3m#gbI?8W+kY$Ml`Zz z@rcdyWYyNIjcOzG8~DyTJhyGm(TXTB`2(ls&RaJ&@6;^rnD~Kt^^WV-9yDEhB+Q}N z$4W5z)%>g_f@2uh_DAARzI`B?@vn*acqa`l{8)82y2}-HqP`YqYuN7g+H&{1ZS7h1 z=c2Y8_ZZ%%Z-X!usKQ!zz9g7;`F^i6A20vNP(1IVhznZ z&GFW`CF8vE+H;;e39vt`OFHkXu{v^a`vt7pGqo+}#=h71D;;e(c|zFccCARynnY2IV8phIJ`HVqGTUF=d=pS5Vwhm=caHoI+Tyn1o#$XH2Q zu<-10@4}B}mm&g;;V9cPfZm<73$*(Q`D$I+XW9s)|mL`aP zwKwv6zU<4n81{0d@>PTJ^RDtSuIyiJEPVP)Qey6SW8TfvvX>TYSW{8ItX+oxi^c;c zK6#aZ4_uCn-P;xi>|{S4ab9=!CjJ6M;s-8+7efiB5;!mIKE>t9TIM2h;=T@3)BQ~dO){=N9=dFl6YVx_1`HMj-_Xm?z ziVIxlIIh7qZ)IJ&>*ym*#y;!Dq|H2Gi~}NxhsLm0SM|ac54A@xV@$h}o6fem$1Fv5 z*v74H7rPRx+ri75uPENjM~iMU(G&P^eZk{f&Q4t0qNK$6oaR{OA7~tpENME|ed2^i zU=S1Ykb7raeP`#FPi}-9sg1l}Y*R#^sfDt+>G`TbA`; zS0q=uOJ>B{%86bRs(F}k%sr0Ro2`qdm%*p(v0D1ElO7&|>}aBN`23^0Sl8~^ZBY7H zApN8(|2_7ArTQ|0rFvysyPEGE`gBd`cI5fl`*Zk}49@$;ur5k6)7cWj<@h0cat7jQ+L-LizGhbdFmfTe?DrQ@sCHawo{j!|+ z@q1ZA?=&np-Ud69wVXDJgFy|SBir+jJR5{^91VBSObwN!N7v(gQ2$XUO+pnU0&D`Ol3UlD#D zS6FpNyMBa#!1~fp?Jq3^Zzq*#E6L%7RTr$ivTjzMwf^l@ZfqBJAOZy!7kpftcGEzt zRLx;Eu4(yKj{2kC14rkTH@;u{z}0k4R{7pWfhz%>*dvnYO55ri?sk`gO1duO#oT*q z{r2;v$c{b{j;2_|qJynau zPMUn3D?VX#iXPS8eb6Krc$#-$euY>U{)59QS!At^59*Z14C`rkqtdric-rytC~8*9cfT+`?BHQ z+2{PHxc3C8>9C8G>A&IYQ*|(NYs=tZGiKybT9~**bA2ppB=3b>7Ob*H1drC{`#s~}dXz0yHfxxhlObS<1=u@o=v6 zspP<2E$jJ4=cb(AWB1lOq}TU|Y^K=BhTDD;Lt4U{+Vy1a`FIgBMjCo6PWxwz+|3%Q z>3H%f`fZo1>3%1?Z$w)1#qV+#9WI)1Rb5W=JFt?kaa=9!v}8kfp5xchD*JT}18-L} zuib5!=hY`9I&Qyb>|WQms0e2(9V-njeXu{o}G-*~@B2BpQ{|4fi}Xl+1i4@W0dj1wm?!&}}Pa zon0*!xYMC!DK~fAF%E5BwPik!ubi8fa^{oNCw7n9)=M2SP|993C)z`T<`}oCIJe&#})-;C=FhmX%7dI?#*nZad$ozZ9M@}{> zGstskWN?RSe(&Y%eYEU&MgZfgLqhEN^EtO38*17v7rIn&w^El~ZYHXJ$80a2i#ok( zS*hwmJG=d>*N)GP5zjk#<+%6R;%jq zCoi@ZnRsWNJ5ZyQofxmR`%^-VV*f!0ejZ^Z5f&UO#Y;(}dktb)8jM^xMzQxoH}>$4%qdeH<^Cpm?`*^NcV@b0tDfrYNU~7>dUKD+ z!eiq*i?_C~3tIP%zx8sqT#!qt^tllo#O|1sOa;#vw|9PP6;~P%#O~e8-Sl82*qzI2 zZiwNW28Juld7G^Rt7`PD>l24QOQDGmzP;8}j#?W&=d4=krP}YgVI!l4DWAEu&Ty5r zC=stC+k2l#_Qgaz7M9J;Sj1{5wg0k=--f}Mf|JTGSURq^#cNk{UU{Y}!Y}K|*x}fd z@b>)~|2a8po<8wm=qtYAC0c4*vdgRL!QI%R;{;9pq^r6;0pUWp-Ru0fegD*W_Bx=L zxQNzCB=c2`gzb8-Bm7VJM~Qgs(XUJF<3G9O${@Dot44A=OO;u8$*AvPm9Ge0y!m|j znoz9`1pTE~pVrj8KDsJ&Lw)Jo>UW_V*aGSXni`6DZB~Un+w^ey+mD^UGUHw2KMk~Wq=D;99Tg^CH$vErk(#(gPt@EYJeHtZ4lZD?B z9=4PP?dI%gzSmvtt|7Vmdrjx7cRH6W^J}rC65a-WF6OEH2GeA|QGe&R*(@RNJau*_@g9 z@Ocwb$1dK^wyr)Ynb+6!b78c8;L4KJXS}&S7gDc`Hn_RQCEPX6i4*@SD&-{o~V(Cu&2P^TEd*-d%eZAvjEMIJVWWBxqDdVHZm4UhKt8O_4 z)$3cn!H({K_o0^EwfCOzX7f#5Tdurolf86#f%9D-yBEr;*?s4AEnD*3>fV@@5^pX= zpRNC-QFeBpLd;+hoOZL_Z_#c*V$>IayDO zt>Q3)XOUZKn|W=W#E#dF^`#kvFWuu9TAS=Xq$hUN(za^eH-6hbO;GV zx4bW7vfcGTTglqf?(WB?O4)*Si}`M!$o#a~aN*ay+2%2eu?bGc+l(96#h^s=R-Zn~ zUxQP1DUml#$;=wMhiVP<9eNd>w~WdzIX7JTfl=3Jfnm2%8qA81t_n4&K z^GrzN?|wPQZFr0|LaqNRcEhdZOjVegv$`%$Bb8+(DGFE?rDvMSFKu_8c$bCYOxPl( z4SK& zRE8pJ+4GLCqQ$R`&-F(KyGPrLtS=sRT97h$GT-^>C!eqO3%3}0CptgWSg|kS#E`z7 z_lZ2IZsJhulQYA7Jm`1jZybjnWmL)f)w~^hp2=KXW$tU%e5<+h`oYsXCCe8_XiG3h ze>}zfMIq?Og7)QRdyvS=!k5nft?u#y6 z_>O2cZry)6D+8sav;GOrbp3X0@42M3Ri)2AZMzc9Lp00liAcKT=iC(?Q!(0fIpM^z z*FvnAm-;Q&;@rMJ(s;ujb4$3Lmnly_-g~%*nLW?X^HpCx$CkWKmFV(a21X|6Teq`< zonmkyP1VY{-H)%MZeD3OOUSYLXd<)X5$5!I)>phMt$Fu3yz{nuJ@)i*UBK}LHPzbJ zt*>V%wuBzmvP~(^>-6(IufN4!zL%Kzy698A=sCvBmwU9ei8?J!@yob7 zv^|AcFZBg7iEWIrmWaegwtk4jiKLzSa{OFMV&&Gg*@oM`IHWi1_Y33c&6{5?E2DZ_ z@ovjt#Osv~D?S?%d1C{lkUsmDzBd!ux$M~{{Kh?gu6xdIw2za*DBa(EPu((mr)oun z!pZ%2ZL^fa4chHW_)~V*e7O~>m=Rq+p71;c8);%2t+GoKv*}BnufSdZMA@r?11bj_ zPusnFA^a@fwb<+N6Im`*roCJrWS68HNbh(4{`%hAp=upH73J$YpWR!zX+>G=M7KDPmbv$_+)f;Vcff0Pvc(3g6(`GIf8G6tukHj-1RKI-dx|L%cT>R8$Cj-(CUhR zq`U9=Xf?aWmei+MT)F$k+S>3xCSSxlF1*(SxAKw*a`A{Pdw+Xq} zW~G36*Ou5z_W{S|SeO^;KL$%G`?9N!dGwly}_?>(QNjjRLm&bV>u zwyzB_+DBC{WV5**PHWeyWxc8P`g1(t=x6Kf7m=Om!>lE1djwjlI&@WeoEi&Pr`WXT zBv|$q`{j%l?w%v+a5~vpxLYYH_2tg3C)SPzJ9_!}=t`an51#jiAXJgSwc>c$If2xN zXWzN@j@~l&bGRh@?#13{sTZ=op}Z=KD_?wD(dGAUsh^(^@!+YTZNYD zDlZb-cKpJoZ=+F*k+s@M>Md_-g zNnHKhf@g6&S(b@ee&%Wheh~$=&ZcjwSNS`>7=N(muD@OXk*t?j9^1!rJ3f+bZ5R<)zZq-Pyj~e|7E44(^c?H*P=Ft}@x#8dV?sa3JvJ?JUXR=%Iyn_1S6f zyUy~wvJH#6TR!T`_2}XralaSZ31NzMhPb_~>qf>x_Uq@*liIAB&N0GG=%>&YL~%lS&0kcu3wKo^Cy(9l;mqK(~!wa*|R(K znwQ?bz0JIb4bE)PGTpYpN^jRv-`KFDpT<_1d9Mqx#;A{`b@|&{^^Vx2AwT9zy~|iV z)U!taM4Q8v2a&d6+=q+ut_Hd#??}3>`*r7t>b+~}h-bxN&$zgneBH+g)^gV4i4WJW zOy^Wx&6MA^QzFzQQRe{ntNu=|{fl1*nlbJ<9@#c~_UT#URSY7GL*cU$in5<&GfJ+E zt~|*oIVWoWr?_#EWhRGbnK#RP=4cer-WC3u23Oo_=^Ar)wP29 zLWK*2t|>5x$a{W80*Dp0bC=u2ewCf?z$0XyHQzz%_5JGk4op@iH7>6LbtoaWZa)>d`rEnK_=O7EEqKC>x#x?rQ~J>$;~5=&!cITxHA zzTC6EV}5y1g4AX7!MMsgi;-^L?kyu#O?8$v4;qO3=a&e$h)D9WZZWUpan4N1dL-3i zkKtH&zQ`p=me*v|#;1XAp7KZ^^Q*RMuS^;AN2W{Y<*XVNH`mJfKlpTVxK7gpx6q39 z>;408-OuLT=iQ1dIatRVT=Map$m!wEoC@h@8fNE@D~nVW-2tA@Y1g-ljU+1;g^15B zt_)k0_-18X=&kc@+9NXKKBrzuEIGfR{L%jMfV#~N=R<=I-6+XByz(q-`L(m|SC(IY zm1CELyrsv=dc>q>usfeIJ&;j-TqL=pJKgT&i7%hK?`+cfe8>BW`+k=rE4!Aj>TKh4 z%#r?FC{d4n-sN)g4)f6L4zrCzg0E!U3vLCo1 zNWEVf;ORDdo!p-H@km$Eg&B_ryZ1?(od__0S~+O>WOM(*>VQiY3s)-ltv`Nk$GnG& zS+kE@Nq(`K-F~oP{d058MH2WM-&OWxi+pxRci*%aC{J8|lJO$jp&JUC%m;4qDVJPK zcTiyKbyh866JRl!1L97%e8!EQBlu+xjUdDqe6=i8)65DlYzXT~>p#(Rd%5OgRgqVw zOiye&lmk5TMm3uYKLsJ>41zpeW?AeocwHkikexa1qb}Gb*i5+ea^8Nw^=x$mgcLoD~#@ae2^{t{UK8{-$lu8OwpK~Tz^j*_nl5%Gba7Zh1RpB=jASy zbK<;^vSkbIncr^t1s1FqSbK)&*|YUH;Vbw)nkY%HVBYYcs%WF**@JEz-Fsz1j>fUh zVjft}VJ$D6#w?vP=k;vAnmV>{cbik1jFBl$7Xtg+3%1;v_3qK&f_i4%hm4~;QKLR7 zhjp5o-gnMEYih)tmK;=T!h2zHHLLDP`R&~c_lV!u?4Q%AEavxlmgb&45py=X_O5*+ z9oyc~y4yhZ+<`21uX*fYE9a){Y>57tF;sIJ*q(q&?1kj-szEVSymhIGNW9z}&kMD_=6oHw0$Ju6o=J>plYZWp>V zE{oTkOZfS#QlxLyOx!G+_%$2y*KMHB=pg>;i#X5&VC#qoGE^zM?0k zNQu-EMG?S`w1SbtR-&c31-OdAf%YD_B|(scHZLjLqNMNWzypJ~H$ic{sqAtQYoFNF zD=!ah%1f1h;<9+Fv%u{8o5SpK+h)6Z&vtg1TOE!NW_{;7n78DLrFG#W@nf-``G)sb z`wo2lT2(dZ@{Z3hN59>{@-+XPAJ;zGAv{)7>+^PHRz&=} zcb%i(K1quW2L-)t>i=>-d-#j*cvFenhEdS2)$7Qv8YGT4RcKVycYGAD?Jyk8jPDwL z-`V5%Zs--$5W&#@ahk7xto8)>vR^DiB=vivi^Ye2+d_m3#)C!_VVN^8yv1J zweIHeWHVTs_REV8ty?lZQgWB3Mb$QE_Uh*DG6<?IZEcZ^x{% z2k#}1*q=GJ?$|aC6^^KN;p>D{)~RTRZw*ge7q)JP${LkR;fmpk{6F2G7=C5lv2`jc z94g`A;3-#`CbeFHT$P3+_{TBb0-j46*4Y=wd{Fa<$enK=j-PmOS*}hXqkWW7ksh|^ zP_|VTqrKJzM*AgBMfI5aL)p%=8d7CMJaUS~JvQEI`qF;?P&OLbQ2xMU+Z`%&x(c($F|u7D+F;v|-ulZ68&eH94kL?;b1p6O)Q`GY zYJJz2Gk33=s0S-??Wt45ROYfeLr>w3ixzK!@zz;V!^z?onp;|RTd>KdI-{93xvpMV zyQ>9yAM@*p@&o+>T9!VGJ#*H7<#!Zd33oS%A z&#%uCR=s-ft;p3wm@P@z2I;F`Lj#IU6k}NRo+KpoToiHvf3aCvd%J@9vEyGZ0U_3wAnqihe@obyPRIw!DdpRd}j(7QPs zMi#y3Rz)4Ty^mjE>l0;s>&t{=C1pACCsZHL3kcuPYSnt+QO-7`6#o+TYg^x?No~^V zNE)xd${WusLM%x2N= z2UaKAA4JK%kNYm#Ij$ltKjg2xUckDBZ=TcAFs{{0D*0mL`kwiXy2LDAUDsdqNJjBd z@RFdN@7bj@1T%)TI9cx>=qUMECL_@GF1SxxnC}P|$C*2`f_FZ+P|En_ir^XX`^z;_ ze9~_kHeWi2GhmF=I$)rz(#98d^z@5Lb&G8xMi-uD6clT0X5)xkviCsRiQGDWWs?CD zCS=B%z$K0g?%P%#KbLdwTo_xA#cJcjU)Q~Fz3jR#rcI}L{)I(6CY)DzEOgMFnTW|1yH+P%DR(?W2RtU>;w@&G(-C?-TI;Q6FatcrD*R#Jq z`@mmuf&1*ocTBc!+r-_okM~q_%G$i)*KKBj0m$G7;afKx;tiHVajvLbrqR5dpJCPt zF;A!9HCWM2YqgTf%63_M*q%6*tT2>2Qt-BaJpM`Ra+i(6!(QI^a-`f{Zf9p^fg|ys zL)pG%-Ftnm{d(D#dZDruezS;5&Di*a+7=dqu3Dh{`N*@2_=H2kwmn#Lf+!*6HcxGp z%$5Ell6lWx7$b;9tP8rB0tFw;Nw&PDdbD2?>38c2+q#mht*_UFXJJ)hAMCztrGV^O zH1HgoQz+gPx5@5;#_Iq%nXiklx@(@Rs*;!Hysc|dv=Jrn*=L@&$CkuTg%2*>H(~bO zZA=W6zpP=lUU|1^#^y&1TxHA5(i%r}Rp$%5+u<1?_rl|a?a`Nn+{+g`S7qN%ePPAS z_Auq*+#>a4&9yq*9QeR>+WfLAs#^pHgdf_A$Yezx3EZUQc)2*yy>z8<-gCDwR}ryQ z?2kj_84qpJcIam3mT)pm+>^dhUP;l~yGvL0ONV~*sjX+$b%(^SS$?9s^4T+9`^dF5 z{Jz2S>gIOp@3Y|;xTaKb$=$N0G`&!8e#q|T=B4H<8;z>J1n$}{oEEPcaBkI#1^k`@ z4n&u9wY)DEBhTx1F1l>pESOt(us}*KN9}49duo}BzYZ482I3w##=n9mP`+*J$&EW( zE7RM#Own9yfy>#GJWVnMUaDA~xKVQh+duDsnRmQ5^1&zFEsV?q14r;Krpucx#ShAF zW#RX^_JSqkv6Ekp<*BmX{W=|O>-ac66^TB#GMRIf^Mxt$*isIekX)Iaa?D_2 zSjCeH4jz~MnFUarXWOq|n8~Shq02qU#tmW9uwMCuu-TH^-CnaUscZ}oH{~!>V7X|- zreS>AZzq)c+xBdIzazBx2Jic~Lbj#2c|uH#+4iUA@_XEB+$5p4 zJ%tq+I@-kOHhwb}c&RR9cYJJGSro$dl?yNFKnr9movh48OD;(LC*0nDP z*5IriQ@hGm&VXMns-3p3V268@8%fH-os{wZjTqu%7Gn@X}*WtFJFQ*pjkZ zvG{G4TIwZX#$(GbK4vvyKq{;?>j{3Qd?{cqbHV!CC&XBMJFSG+lAj&Ee)vk7Y4wTv z;S~!WrgvlaE$&{sX}8TlSbkh*?fzTu`98T96z{)QSta4YzpVXDT2FeKrkKK=BPuM? z8y2bMX`b5Y`O+G9&M1+tfSh}&`BR)GN?`3(6vO|^^t^pA)O_{>*i zQokSAd^kj9VN=zDIiI7yvBU=7%U~dcv7KLihdY)b*0j-w{rvK{H5yNIZyt)>zI=;8 z>FJkw%?nZ*?+Z&>G6vwC0t!5Juk|(WIgHP$Mxq1DP{FL)Oqjmx!;@G=f1RNP|PfD{IGuI zK3}w!^9Sa$1TRM5I{9 zBqLk`lk)wTyvrN)%y*SbWTBUD8{y9V__besJfW&q!#P1+)_dsDC%uH->LFXBKY1;$ zaKC18$l>Fl@W?a2UB}R|(Hn$$=4W48e3<*)ijwWZ_ODj0hImbimZC6c60PO2*tg5~+q~PBHqRPe zYq{shneHXKhlYcLU!PegoX)=eo_j#|+SU4ep0B;!0w0__a?1ImSU=ZsK0ax;-gQ=` zcI;8#?<$=CT=f0<`b9W--q~w53~%GHTE1W|L(v+qro!`^D_5;wcCk=MP?K}>VwTD+ z2ub$dqQSwpvvW75uQ;+;T4HO_+BNfe)_66ZbohQi+E!Cr@k7W~_u0L(&34S{TvN=# zNkn8YTrIY2)RD}58e+huUmttb$#&~O_0_lK)zK@?8z~KpTjE6Y`TdUj9opAc5$Sdj zi8;CI(pQw%GMV8fh18C={xggK;sWPzT}Y(BZ1>`#58Y+Pyg zW5=1ce~mwUuGE#QCY|?r%?Y!E-qF2gm9yF#E`8n7M)-<&9W=DVHBw95>sxvDj`lLq zuPk1RMV0R6wOK@Zt#tzXe6K40rIgj^5Gqft1SrW&~(%Vj6(%2luAQP3ysCMC2 zoBOLk_GUacch!Tr(c7OEq(^-g8P*az)90}L&BsetmEO%edtxQmg>5??{&8LQ)xj4f zSF=sZj8}yWZsA_L;`Hd5J=hyQCJrbW=E~A=`z0byDf<$ltV>?qBrZYU8WF8bHoVQ| z%y(aE&yxILjbf>o6Q|U}3b)?Ke5Gsl;Rdng^iJ$yjn?nHt9rkvKdJn9<;$ybd*O1I zmwd5pT6YI7S_KH{gy~#Jx~_&_bVK51V}JBg$=aLquI|Z9S}MR*;NQs`z`fF7a5-Oq z-_AwX*C!K?_G-6jlp;|#n&DfZ888_R3^SgLr6fp5QP8*|Eynqcd_4$Nnx z3$GkXs!9B0Q`#o;W=Z}Lf7=^13EQrS)x~MOdfAbkj26{zQJZu1u~f`nVo%)4p7SxU z%b#USJGH;rKahAcT|R|1UN%JIGr{|_gVxJcL8-U>uL-D|JWlS-Q}s`Jc&qJtT6P6{q}iU~>*wC= z$az$l+Ba;y{S7;&Lw|JR^&`zIO^OcdNNihxmvzJwh?DY$4-=my^UtVvqzNUbD(GZfWBc`JAWSh*v@%iI} zXSfACqw89ND^f(88U|43#h*sr-FLtD%~#oG>zwnphk0|K@XDxX#4?MBE1OumK1fC| zs8*w}C!`qWcskoxk`9>l=2Sdq5M)(oe!2z^FfYc+`Zz&B58OqN+!gX2hA|hw|Dh`7d65Ud!X(`*Hp9=c}{hm6xvy zQRe#gc=^+020Q$=&8~AJFfTONo_gW}#7+)nzH|h;_Y8I7Z9{vuWJxlu@QTgMHyc%$ z(7vhEe8QbaZ{}JT@G&aeIJO z@tD2v`f*I&&HGwkyv^*D?p*hdSG#)sU9HJGt%xX{_r%`((c}`IsMf#{*07ZHP~+u( zim!Amvd&7~s0$VJJD6FM6f)+!%sksZ-q*-#XfVmC&}F<#?K{H&cRH8tYnKNdPnJs- zNZ&h({GM?pztw?v$laj630eO<^-Aueo7Xpee`BAY{?T#ujvdn7Y)Ws}c1e5oyba1G zo_5_EBm6AYOTVW&`Q%vZvbU~|gL~zxa0i=NN1b*j6|~n}wp@AtDA%W@zULR$HYWCU zKU%pn?9s!;A4~6xUs0(_UUPnf_({ohDbW)|?h`fd103Y~^SvBuwKXm$2y_$aT#nGwz8BhUSu~FWfH$QA}k>L4sTQ9@ZHpXOs zz1r1NsV%cy@^>v?T_==Ku|B`jGu>z*XP8PDM|4+u$YFzWo-~nC4nZNUsDS_1-d6y{ zv2E=_Ah?8(;1=A1&oB@)xCeI&?l8CqcXtl~0)Y_Rg9UdD?(XjThI3EuIVb1dcW?c# z>eZ`y>8hUHz4qGDyL)=}?Deg0AvNpF*e^AJD%5BcSMsCfz>@jAsDztC-+A43TN&?M zb&n${02#^?$-#slCCk6Di9*#$lV!D`K!)e)BmmSK9Nw zN%T_|D96*TwaaAqsC3l^_tT-xq0sSOcvf8@PMJ!4=2)&#{wk^7z#ZKAGTG|7jM9Gj zYDa4xa!&=o$FIwto2X|&uf?E*2KP|Rd5X>1VJ-pJzu)5P7hUC=Pr{<2^gBA-=!6R6 zF8J8@drtb=KJ>xYg^8)iz=ay;DC+t0hAw3o-bdygM@3a%&`UF`;KR|ASdr*-EnF#E zw(=`xm9r=x$+{^k`%Qhu%i+AXk2(L;WvyRiaA&(L7}C#XoyR>R<>1}f0Ly{OiVie< z|F-iGsE(s~Cts=WVo{(Tjx#Vg>wbAE(G|&S@XS?Un) zcg&)soMG%7@1g;3j4PK=W-DJ?d|(+`#hZN|L^T1xMQ_`pi!A+eR?vFVo2_xTDBP$0 z6%*QfV=6qd^|9G(6ZczI?pnvfhJC_}a|D%vqawxE2D+T6G8#qECOfZE*M`$xnaZss z$EWk#u8(W98}EEncPTK3S>41B4y&s)Fh?+0WAfV@J{x;9VW0eR#a)>z;bdUce;dfu z9YAEPf^5wxy$1}noo;05_cQ<BD_zXoKjOgD1c0cvrAZ6{d zIK)^)-3~!jQbe00Qw<%2TLRR}Wcv>`r93y@+}>Z&IWzQ(hFv@COiV`>TE4de#9%jI z+$DVM@VtaIXTlAS+2>+DKXS7_z3H*FWqeFa2g4Y3r%?QbkU3j1kx|K))&Zoq3JR_*kJ zEptXwq9d21Z@g+LWCD@rY}Nwg1)4qR?1I8`SBBE^!na$^*h{`Rf!cG2@25X^vy$h= zahTCvRTYd>p;y`WId0Ik6A>Gy?GEl6JM7W=z~Vn@o5M68D4cN>&dlGSVa!`t?r~(t z&J!nie1&97!#L{bgrD+J?bI|xps~=#jUlU=lijLrGBR#tki&f2<2@DePM>-WqR|i~ z80$O#STbH4z8nSh_a!6=+P<)1oUkwP5sdUS0~@Ip80kZ(YY0MObv7Con7Qh-b2Q;0 z7$(zbwMhvs-@QFbxBG9v>nltf?9E?q$i{__iwjk^+X0T4Z#5nZk>3cYoK9T_h`ToI zu?R99<;I_UpQ^Vvjms2%$9)W^dBmt#`HUPdAS1bzSS~Q$tP@F>2sGi(m{c&<-;VNn zY2N4Mif`-(!xs$JLP(b$GK~&A@j709w&aunEZt89RB}apCxf4zT~&Y-{a=%Zca4XN z>ERP1UMS|&s=T4{=WVews-oYWQr6Zbuy#{zZ$hEMf{B zk-`ycCqN!FXUvK}X-%fRf`g06ab|IqPX&j6c%=*#%!UeQJh{RdgVPxGnSnXZ^bQ}0 z<8qR}s$MFvq;KDzmHYOYSgCjbC^hQCv=Wk$3nc*%6h6zp1(t%|M71 z_qo*j0DjT^I|V}mH&9c)m+_V@d;lZb*BmEp>O)7`gx)Nik+QRzhADL831KGCJK)(^ znjRBT=ce`OH6m$ojK?c`Mp$4|8zE*v2&_H$!l1l72q6xb#kGNj8&YqwN97VC1Y_d??XHIcj(dOE$as-27d092@ot=DX8d`l%yd1qZ zJl8g{@tH5AadY%!UpkVAcVwFGUCVN&bM(xH4X@!Y_n{~_ON3oo(vpN2-`YOZfpeBWCtpIk&uFOVkAyI4!`=10;*tAZ$-?a%2QhBT=t`g!C6s&rK}f`ipGipOmQhU_jQu_xhWIIHTM{ueu8~h z9fy8wgo8T{53q}aX>@h|!1}eR`X#fcKDn3beCNu<3Ib%%a5K)sTc{1)ZAW6DS)Mdm z89r<0<;FdMGjX2rY+`2@SWr6{7&ttBkEnw>2N+c(ctmC!Q`Y?ljM{N36hdG9>pGeIs|A;XCwaW7MUHQs~VNObW+W4N#;jaA+I3~%%ZmvObn#$E7M z#2cJY1G14jzGM8=&Z8oiF~*_dVOh?``;Yt4^3pQpkaa||6HM}O;U{sOjyj>v>rZAv z);}mf8Gncikj2rZU&Ys_`jn$p?L)Hpn9jYtk)s^l$z$+PG3#zR-lHNr&BgyBSmir9 z1!H+d3#+I_(tA#C*&>U0DlQ^aABH=kWD#}~G+_Wf4JCi%Ctt-G-@RO7GSR|_UWCdk z{xMhs;?Cp`$+vv7b*CrsbK?NmckJkuPa4lhhMq98%U+TQ1v&u{)BgXZKHf|A@@7DAj%X(*wb{UJrh^c2uh0UHY`ReNeQ1q0Y{ljrRq82IM?6}LIQOp6y&v)tW2B9~ew?xX& zeF2>^d8>gpMC7R8ERAfDOC|@*&lySz&`unD%B-#Ybg4Ph{M%@JCCK(!M0^eC2M(`W z(MZ^*f*dkmBwL7Kl$Cl<+@q58MZx|H6vzYX%MU!A!f&h^{~jpFrmwHZ#7rk`WoIRC z05&oF2Z-=@jNtEFGXD}I$N~w%#>~XV{(lK0_-DeFUl_q(7{Ol{!Cx4`Ul_sv2}bY- z=ksqEK?u7S$$z^)K*L#?nILpqe<}mP83KOn|E8|rxY++q9t8XJTl+v})__?gZm;xbKKSdPp`Vd-& z1H#}2Ifq0fdAN2CNO+J3Y~Vw9_Xqvo%Ca+)umPBV!w^1{d1w<74j!Td!5%(@_4zl~ z{!9L+=ji{xG5P}|_-9(U9~eOZkOkrZ@%v1Nm7SgWzk&#=xGJcNxMb8keTsvE@Z|u8 zesA@NMbvs|1f6J!A{|Z@feaeDCpuE!$Jg(G&ZBh>WCr=H!w(-%N#~ZDHNWks4PLfP zn+;>%2110fGNMuKrr#;+?76WXUwa(8&%3cY zG9Zxof`>3gy&TZczT>}a1l{ty2BFlyx?ydY+~%#jDMDag9#meKPgqDC4t?RPki?YE z3cye9s?)kB^L*ZJCoVm>^`7VDw=P4s($m`ro177SY{ zh&*S*Rc097$50;~fWU+|H!(-5iT7eS8EIkgM)Dcoy)D~$U)P~wXxs3dx5YAYC5>Oe z#}+z4ac`XQ#{`cy$|~*(?hL!QX-5g{h@eD!@X45nHwFtcABMD@(~NXy&`!zw31b*M zl0wNra7S&uu)RU)ewRspY-^kmWx8P6Bx#5hlNQy+Bz|!X$2z6dW78Q9vU|ha5X+Y( zj#+6NA$-WT6r}iO?LC3lQ?F8}RRe1F%v7&oq#X2MsrZ0Q*!Q57x9VOdansps-ELvv zM(K8ZD`r8%=H&fNGr05l6F-!4IesY?2INe|NsfY?bd6Y% ze78PvZ|~Pi>b_&|E4Bx(mZDK><-!>;yXoGn-gBSd56B>G%I6g`DlVU7yPP}AiyEt@ z$bEN7{#w2tnBYp~hrB(8C#NznE44a`Cl}f(>`KgCb*Kn!1se+#M|e@lRCw zUz>=JzG~lmtirKQZ(H&_#zJCE(K8UeR*hTM3#E9i@a^@W2i5ks-W2a@XV`i6lcM(RFt5a+OKf zSm1IOXmdkySR#IXcuRf|*~SZg(uw_Gxa%2D$dz1@^gsws#&N?2 zNkLS1fS{fx3D@E*lq~+alRSOudkOSK{cim|(sT}lE&7|WrcY%sQkfu^r<$*;WbqOf zExEk1E@*BrZ{R#SW0@QbgE=~GVryF5TC<-6kOD~GgL10#t8*?SyJ&?B0$AR2!KNe! z)N8hAcsu&wy@>H2S4d)e6j4U>^^Vil#3tB?OW&4h1*N59@gxUiE{A|b?IiHd;wz$1 zRE)>F@sFFCVM9?lupVm7k@C&SR;;T_Hy;4sqSSBoJnmII0rJl77cnQw87T7Ru*KID z^xewHeW1qDZr}4B9YdW%hW8~%gE%kg3ES$8y;8rM!4~vo*RJQ$fZo_F)lm(+`I4|$ z^1OYK+o&|LoH0X1<$dM6uLqqx>7*6{84@)+IsxcihMI~f@uO!x{ZLheOt`I2gVNs5 zePl%;B(Ys+VbP{LsQ-2YaVNAxP()ZWG&eJ(H_Vi@C`k?#QUhWa*y4T&M^58XuKi*x z_15W#c|Ot8UF;Ap&64HHY+A44br)QZe-LFt^Q`uFEv*j)M53PdORxkbc~+Y*JP0qo ziwcZ&DCx7P^;S&0Wl?*%CY}ga_F6R#Zf&@fwn8buvr{?!US6WGEVrVh5?1-Xe{y`? zt*oooK;88$hj=38RbklVX5qQY+Wy40)Sd>VYgM^4FmauwS76TH`*EP+lv~WuM@2+~ zI4st|qUHq6#|3aAMJiHj@h~FcRBAxhqcl$(lk?if2KVJ66+HBX%jXCBm=OCQ zt5&5v1-{w|eNWYy1wqn+>WtG)Y*ziO&6Tlh<>k&0wzOgHe&ey;+ZkjXO#R1qFZ5l3 zpJT_epR-ZEELyBk=DFI?y`rj4sJU=;y_yBCS>o#~?s*qI!aB-~T(X4nuc^cFw^_;% zAfnRnhRZ{e!t2~y$Emu;TDD_ZS|a3|_o|I54WMZZc&bv9qG^a}5bmr~DN_Z-)4pK}j>LruV7qUm_V*55}4oXl$^ZutW9 z5h+UwMxjYTXxW_E1c6X#EJ4|PY8tGYQ1oT)JAnB)%labqy;85^`i{-nNSpX9b9wLS z(+P!l3x;MRx|0N9s#9@WNSGzZCI&_ldfHagMKE5>j4^k8b-`Uyl@X54O|+@5XBUfQ zrj?f>^}al{5L70c6rwW#8mtR#%A|T zL`N$n#+xfIfSNWNTz3)L@k_F&I2Ejqn78#CV*Bw>f@oCCSBf|6GQ@q8dfONecMU;l zgQckT?=&Be)9S-yi?tl-AaQ6CrPn6hncGp}Gc+rwjBsdAy7!tXgndTm`XXAR#9xU) zy)?XH71L;8X_#&n&lIV9!F_=Kbs50c(iFd%3=&)Z*qmEV!S#xdsJ{;;1!!J=mVCgf z*p_V913nEZwoEfncTrl3JJW=&flH>wi0o{|)|`#lwdasJ^JlrywU1zQ#|Wqz!|**sRR{9!iBnv|#wlFuW_fkDoo`lfl68`FXjTT6e{5rY|N9Vir4D1WEb^#pQGmP7d*oK?M4(bm-g$ zv1f_BcCz;83qORxR#=(Z^9p4RaK#KBFL{UKO!DZbB!mc;@bA#vT?Q z@S$1hXQ*D@&eEr=OlJBVFmX)Y^hRW?BcweAFZS2;Ifz%O6AtlW3t|uOig$Cn;Z!LT z=X+S1-G+!#xN#zUzXh4z3-?n4&DR#p#+gA2L`$h(n&J zLQjMQZs&}e{wC%_f+Gc2=CvWg{mT2WMwGrAFdC#3Bf}PA*jVCV=-}dk28U`BM4u|! zYx$`tch;XqC%qt~@9_uwI-}XeP681ZkX(lkza;}OZel+Ke!F^c!%m+v8Ue0)Qpb&w zMPwaXg?cX}dQLDjB?EbjgV*Wfy4w&Gc3>~XQk3R#5DB)}M$K)MU}8v{31NziHERi< zKJC&u#XHe~$C>On@ViM#Iy1zFQZmHk3&!-dr3K-(j^`*td^X%{3a?x^IbT(mj=eBW zup#5#+iTWkXCK}ISD;nb+smowcgVg9&Q!H~!f=N1?6q#}JMxpPumfjZK~ht`6#glH z)5T3bA7iMRp(mZvE8a?sTd?j`TyyUX7cOl0<@^V^l7)E|?4Vqqfy4*{?nqV(VGPkM zoLlKl#JPp_U&HD9mvY^U_oC?pW^oh)gaLTe3D51^M$cd`N*`BBbH6ug_IGZ=TPPDM zeTz28>;(5-F~9-l8>$)v-%X@jEwT&h71~MjiK4-ol;KA5ri52+r!E%JiAM;9^@@T4 zzMV$-en0g(=p`%}PdB43CR4ZUwznvHw6@k`QcQwo*gQ+`FTD&+lz9Ms9`7lc941ln zQtc|eXI)-|%-u|n+t5=HCrLlx$CmKti>;-5X%8Q@1fp}Lz^TV4Whv}OWQwxQ-ep+5~@pdgU9|C-WS+Q$8SYXf&5a^4_(UgD&XO5h-9c*ae$=U|aq1eXRJVw4V|5|rdP544<$kSUO9 zR(HIfM4qO6)^yD_fq``m-G~bMO0u}CYh%jDd*M-vA?)AAth4!qsx6Jh`*N8lbM>B; z!5ta*e%upJap+tCF14QHU~Tw4s&y`{z)GW7zib%4Y#6_682x`rv|+G4go^z!UHf6f0I>letWUqsbO6jOkcriQ zL302?w!<8cJMRl6pT?n=ID%I===8A&^u*Ca@mvUlq z%+kr(G9wX}{n`1t`E$cLlqXP$@UHLRWdgFmm;F01GSHDwa@;;ybAjYjQ_$6J*|>03 zZLKeP=S#6kj`gw&af4AJgy-Y*p&C&5a&gau$=OyvDAtr?FTS@P)img;>; z^iCOg>>SIgU+o&PR}99b9=s?*Xy>M_z9g0^Ct1s8L1Z22|I&H!Yq`&ev50aqD6U#L z0gk8BD=8sp6R1mc%Jc}&f0dtD+MVzPk&PFx*d9NcF`8L^R0B1~(SFmDnoekTkrqU} z7ipLa`2{&yS&!F4ipe$wruh3`=5u9A9dq@;zP9>Cmx@?{Tr89*p1Q<9E^WezxsMp( zl>)pYt*&9(X?JM+^6bi&y_h@jtH@LAOYF=DPon&q5bGzK%db6`xUm4b!Yml0TD#w| z8IQh`5=cGP2!F$x5(2a9m zo0}RoFM|Zi867XI)7?EaQ!2{WRF$vzT>9awxtN&E(A!Uga*o7_j;2YWni2cCkzVX% zNlisvi*kxw)?W{S6}qP=RXY@d`L{TCu&H{q!if`yTi)fejZj^FO_^cYZ>zDH!;09C zDU(>uiB{Bd>DfPG1~+O@s#<_)zE91$PfA}uj}aVuwn@Q!ho}P@t|=>{(Te-}^ESTK0?l8#g+>0?!T)x$E9)S9i`?CC5v{t%fmwD8Z zzqyUQ0b|VbA-Xz7>h9#XlF0qZ9MH;0X-~&l_2+U{touXZg3C~sOcB4o;RbfC$=**t zy3FIFXN*yoh{@Tv={Z$`-KsYYGmq(^wecVKp+Hhoy<8EeAx+6{?>Wu3ob*OxPx&An zBPGScQ$DH+&gm0>8B$r@k!!UzqA?%xcrR||POEm1NkC%YJqL0bwXGEQoEaO!-_7yK_wf~SQ`N_ z)>1T%(mfWeX&8~x%i7dcRf=f_e;La+!UB@1CQ=rYyz(2=@9xW4OX`YK$ML|ms1LS~ zDQR;`9^DI+UyaUxGH6?eVuv_h)D0|~l{qgP-D#5weU-esexdKqJ=+6aYq1Of1?1=45nn5`I zIy-OxNqChy?kNqaoUiGYFnL&4ip&_yj;@9m1`ZEM=-tq;9NQxwd5!3gGDDzjL@_n) ztRdurSmGvv<=bh>D`R)dUDQ_Ydb=D5@`Tug*{9>v*)m6m)^MoEUR1}KF)KbXD~pLCdT8O4*51#r*Nbgh1E0aj zrMIUyc}!vMIXz01_a%qVW89YnWk^J(A(n#pPY}QHdsC;4^!J-Y1EluSDP2E`&9Zr! z+?Ip-*kfagGUZrl3p>&y&7X~v#rtu;Pz~%8P-c-eM3Xa-5rt6QOHvX#=q-~FMzEgX zY?40;=UP7O=-Nua$9mxahYxQ*!Q1^F*_UYk8|@u5kVsHiqU&qeF4y9=)iWMH!DjgH zxoP)GeXnFN=Pu27WQ*5Z{V+AghHA5Bq5?$61RkT?oO4;PKwD1UW-n_+pIWdq45>V6 zQF{6XwaWMMG5I{ld?NKAV$h?P(w>Hik`!8B*ij97Ef@}zuWAe$T;?%|tw`Z|7rd`5 z5X(kXEUZljQ{NeuUCiD%6Qy-^S!u21JKEP?a2f?1Tdc$PA4^La4fqjBJ4B98iJD0W z^Q$3uk#Y3TY!Mg%yTDroWvNblHqlttJjtj0Sjq{f4r7<}4QK}|2m?*dgF5NwD^F3A zNY5qDK;jb9xps(dgPWXI(Orb#D4(-aP506>G~85o_8Kb0ngYlDW}m_8Voj|*>z;JK z`rT4=FBha8e!fO)7HmA%tRdsiv6|#+cz)FUuW1Aoktir$5PXP5l%?e>GN#AEC*Bu< z#Xl?0nriQm$V$nQCCEcrja{>9KP><(Zn~4DrylEQ9DiNwo6P0PL>)MEgdy*zJk#EU zeip-W;^~|$DFI#7RB*uH)~bVT?hO^%VzI;Jj_1j~9HCXzf@{uz_HG-IE%CNKqS${V<^>?vnqECx+rIQZxz=KFP1 zMUCeUn0X;*Hz@6xGZKR>^Ff2UE96DWhpCEzQ&Y_0EgR7Fq}F71S~({|PACq|V@YFd z1D+nlE97@b9g8%HSFZ*4qX#Zf;OZY0l?{c-J}Rs_Qk4^|&Rzsz=6=UADJU;8onLhT ztJ{rlPq8tYdUO*m6B%*zy$EZiOvSoOD_9h-){9K5=CILXHo42YjHT&n%Xn_-N3}o( zCJc(C>MT0AwZJ?lIUo4ilyJy%2X)Wt)$j_ufrx-xJ?wO)WL~bXZdy|RZJL)CV}bJH zxk>u{=a(cmUOCv6w-LYblmp!h3+o1;S(C8CJW#`7LPX{zx8Ym~o%_x4# z-!RHf@s>%!+!d-C-$ve;DLqSg3eIG_=b zZK$%F4ib^R(O(*bwk#^$tfeoXoq8{PQGMjYlk>8A>J&Yo(~*n!s+myR=-iIJz&mFU#2Bc05h6bp{uJXh8Z>+J#KG<*a` zqWX;cc|cLLrP=gM{)4kkyWsD$k7({UqTHU~4M@f7onMuQswO{Ef_q(d)&#`%mU{QvYKQJ`&LdZsE>*A3m9#b z5-82RIiW(zzcnHGejhv>UL{nqc(1z=Er69|z(5h9AMSb3L5C6-a@BDsfKqQqAERVx zRJa*bHIFSR({Sn`+vgp>tsY`IKg6m)8fS@?PE*xem`8$N>uF;);(K&;J3@S1Q9w~7 zAse_^b$nc61_ImE8NCNv(2vf0E_D_>$L!WdCsfP%3Y9hU@${Njxv^D*Fp0OP z@B^MLoy$pK;)wR^Ssrar3k+L>t$a7g_Hcb(s&JQ6L&kRF9N-;-knmLfP5Y`p9=B$P z%bp)`Ll%KDL#kVVoxR)r>3F)E#K!%1^={{!)n1vPpwx?Np`+c1uGbWHVwW&=RvHSD zuUWS=M6;S-!6o5J55Eoq;y%j=sS^w{EaIP(I)TF*9Lo>A_NX(Kv52pftE(M_WgV&ut9l@E;zi`VS;OR0JK%6T(lJx-fP{5a^mWqc@r z>tq2LS%)ywWEHuVJtKea9mh?FIoYIK@`$^Bk8HylGlhrJWYNdH1gZw-16{QY(;3IQ z5}q~%;yo)n9(KlxTWh^UrYB#I;}o7$N=3HZ&bcmsEEG^@yxm+4ke*Q9MakG}yo|he zzx3KaURzX$XIJ5l%XB1i(jAW%p5F6eoVuk;Ze%?u%q5$xn{)vMx-PLwv7R6cj)GedNzrCi514g0Qa0W={JOMd%lO2lDTeGB=n!gyN-4NGNwBE+)My=4u> z{UT}bS}0A0D%0XB6Wek^h&BSlfb(Q`kMDA--tf8oUR^ae^o=Ka2Ccrsq;kuF{Fi3Nt>BS11A+VcxblaSf_recm;7-(OhTsxYhv z?;);ADccjPifjSLt7D;$0?ni{z)F{MAJwogOTaK{8lrFvo&<%yqXBY{a04lH(aMX} z{G8nyzJDr)nqAQNf8>(Nzd z>w=_;pd3#x#jd^&(tyw78K0AaipX#kUPlc-#6+ihB-_X?MkQS$wMzq9dcGHp0)BwV z0b(UxLY2$dbhhg7#_VsK#ez>1K`=nXLRv2PF~o=hYs$~hc@!3FW^R*(Xt~gpHqy)}26g-?1@GUI1=W zwo2EI8#XwU4&vYseTR_)yp-*aJce|&865;~GP4h^viXvnD3}$WFIB`{dJj#gSnCjE zVaN{SKSjnT_%JI=4FrOA!dVW5U1iJy%0#}FWY*Q`>P5`1J$Y5z_Axw6$u**0kL+#V z+m?2%lG%nKHOecWjsC=qc?{fRk*v2)k|^QA!rp9(XpQ$h?#~0hb%}n!xYx0!22qDQ z3A8NF>4uUn5#yr@n~y6kveu7SCD$ZSIZ&{fsbMgS-VY%HiS zJq=M3^dWn`ShCn1zIHn3yRVAjMuz7@((viAwRT7`K|KHSGtzPr_RtduN10*3lQ|gL zC#HPe2;s8{Mnbr29YYbdmAd-^U16YC{!*~;S@4J4gW=B@`_VppLG46lPC`5(HPL%k z)6$8m%eYh{_w^%|O?-M$yfw4SGhI{J)(cvu?kQYWA9^^(N*r;QAy3|81C;q2!C0KD zVK+DXXW9%V1{_(c*;=P0Yi%`3J9@ndP$L-f#~kYE!-6<`no9t-YeSRpPswyD6>q7_ z;Px-$iqmds-)xENKi@FJF`&aZ&oa-+=Lj9FFpAJJxDEEF9&R7PPCh5XLhS>y#zd63 z4E46ZLGCNR2NOms9%m^igxM145*Lt$Q8wulCQhD$9GD6+Rg=dDhTr(dniYD{#(%#L zGU5TYPtfA?6}`>(6id?@!(KwODXx9>1S>OY@mZF~OyC>z@(<(E1T=H+TyycS!vd$9 z+t(aOgj#PWy%gwDbd9W|$9o+Xg*Vzt2ssq|x6ZPZyLLjE&EX9VLkoSWk8MKRn1dCP z7f16y)V1F?b{7P4APwY;#rEOqyGDu+tGP__;261*s)isOTgR@lC`RQa^Jb{s%VHtV zA}U|lrCI9P3M4p=!w$D6p)cplbj{*jTPd7w-98bDFfkz8Nmpui!*7mi2Zg#NU!Lxy z!Ujc@pf*=DwkAzne!_`=TMkf3!TNmek~)j1siF+8H0NjU*dn#{i4Juh?P=3J6+XpR z%zt4F{=sYf5Tg4(d9>+5;!_)N{Nd5|@*jlte>MjHwpuCo56KVmdjQ+-K0F z+t?xI-G9k`|B@N9y!n65e-Cjd_<8LVLJ|9m|Na;M{V)FeU;OvK`0xLF{(Fc^^6z%x z|EKuxANc1XcIt;60Q!S7{=v8Hhy35B5Igg~&HKI1f0zGfe)@-FHjaOA?Elbbec-hJ zy^e=t5C_Ds?ZMZL9b(&l@Na|Uu|fLC24scU)giuY4}AK+>jNJ6@&7~nzw-Z|;iLb* zeXss$7j^<07$QL)BX%SR%02K+ydp zgP4{7E`vO3?vwy50mIrLkPcl~KpU0UM0uA_i zOj$ty(BIpDJS%^z5BM+I<$yTh{?sl93&dIXuQE0O2g}cWW&<)m%)tNBXUOnDUUomp zKx`0)-@nQrUYbll>p@(8S$^&d9~1!}ia6#LmP9{P}v>nISjx4?R1uE+j}880q2fmb{6J!Nd2LQO?TB tjs$XZNg#im#4HW1NFbep97E!G+1lxX?SA{Fv$L?XvO Date: Wed, 27 Mar 2024 12:56:56 +0000 Subject: [PATCH 054/118] Add nuget pack calls without the impl (temporarily) --- csharp/BUILD | 36 +++++++++++++++++++++++++++++++++++- csharp/TypeDB.cs | 2 +- csharp/build_opts.bzl | 3 ++- csharp/rules.bzl | 1 + rust/BUILD | 1 - 5 files changed, 39 insertions(+), 4 deletions(-) diff --git a/csharp/BUILD b/csharp/BUILD index 9a3feb2834..47450dc30a 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -18,7 +18,8 @@ load("@rules_dotnet//dotnet:defs.bzl", "csharp_binary", "csharp_library") load("@vaticle_bazel_distribution//docs:doxygen/rules.bzl", "doxygen_docs") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") -load(":build_opts.bzl", "target_frameworks", "targeting_packs", "nullable_context") +load(":build_opts.bzl", "target_framework", "target_frameworks", "targeting_packs", "nullable_context") +load(":nuget_pack.bzl", "nuget_pack") load(":rules.bzl", "swig_native_csharp_library") load("//csharp:docs_structure.bzl", "dir_mapping") load("//tool/docs:csharp/rules.bzl", "doxygen_csharp_to_adoc") @@ -62,6 +63,39 @@ csharp_library( ) +nuget_pack( + name = "driver-csharp-pack", + files = { +# "//common/images:selenium_logo_small.png": "icon.png", + ":typedb_driver_native": "libtypedb_driver.dylib", + "libtypedb_driver.so": "libtypedb_driver.so", + "typedb_driver.dll": "typedb_driver.dll", + }, + id = "TypeDB.Driver", + libs = { + ":driver-csharp": "TypeDB.Driver", + ":typedb_driver_pinvoke": "TypeDB.Driver.Pinvoke", + "//csharp/Api:api": "TypeDB.Driver.Api", + "//csharp/Common:common": "TypeDB.Driver.Common", + "//csharp/Connection:connection": "TypeDB.Driver.Connection", + "//csharp/Concept:concept": "TypeDB.Driver.Concept", + "//csharp/Logic:logic": "TypeDB.Driver.Logic", + "//csharp/Query:query": "TypeDB.Driver.Query", + "//csharp/User:user": "TypeDB.Driver.User", + }, + osx_native_lib = "libtypedb_driver.dylib", + linux_native_lib = "libtypedb_driver.so", + win_native_lib = "typedb_driver.dll", + target_framework = target_framework, + nuspec_template = "TypeDB.Driver.nuspec", + tags = [ +# "block-network", + ], + version = "0.0.1", + visibility = ["//visibility:public"], +) + + filegroup( name = "docs_source_files", srcs = [":TypeDB.cs"], diff --git a/csharp/TypeDB.cs b/csharp/TypeDB.cs index 95190eb068..c4e625b46d 100644 --- a/csharp/TypeDB.cs +++ b/csharp/TypeDB.cs @@ -25,7 +25,7 @@ namespace TypeDB.Driver { - public static class TypeDB + public static class Drivers { public const string DEFAULT_ADDRESS = "localhost:1729"; diff --git a/csharp/build_opts.bzl b/csharp/build_opts.bzl index bcc85e3f5d..da2a29731a 100644 --- a/csharp/build_opts.bzl +++ b/csharp/build_opts.bzl @@ -16,5 +16,6 @@ # under the License. nullable_context = "enable" -target_frameworks = ["net6.0"] +target_framework = "net6.0" +target_frameworks = [target_framework] targeting_packs = ["@paket.rules_dotnet_nuget_packages//microsoft.netcore.app.ref"] diff --git a/csharp/rules.bzl b/csharp/rules.bzl index 393282e792..98cfc96a4c 100644 --- a/csharp/rules.bzl +++ b/csharp/rules.bzl @@ -29,6 +29,7 @@ def swig_native_csharp_library(name, namespace, nullable_context, target_framewo **kwargs, ) + native.alias( name = name, actual = "__" + name, diff --git a/rust/BUILD b/rust/BUILD index d374b457b6..95ef4fc3cf 100644 --- a/rust/BUILD +++ b/rust/BUILD @@ -20,7 +20,6 @@ package(default_visibility = ["//visibility:public"]) load("@rules_rust//rust:defs.bzl", "rust_library", "rust_static_library", "rustfmt_test", "rust_test") load("@vaticle_bazel_distribution//crates:rules.bzl", "assemble_crate", "deploy_crate") load("@vaticle_dependencies//builder/rust:rules.bzl", "rust_cbindgen") -load("@vaticle_dependencies//builder/swig:java.bzl", "swig_java") load("@vaticle_dependencies//distribution:deployment.bzl", "deployment") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") load("//rust:docs_structure.bzl", "dir_mapping") From f6d1e14ecc3b3166953d06d6314235e486a052c2 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 27 Mar 2024 15:12:09 +0000 Subject: [PATCH 055/118] Add first automatic packaging try --- csharp/BUILD | 4 +- csharp/{TypeDB.cs => Drivers.cs} | 6 +- csharp/README.md | 4 +- .../Connection/ConnectionStepsCloud.cs | 2 +- .../Connection/ConnectionStepsCore.cs | 2 +- .../Integration/Examples/CloudExamplesTest.cs | 2 +- .../Integration/Examples/CoreExamplesTest.cs | 6 +- .../Test/Integration/Marshal/MarshalTest.cs | 2 +- csharp/TypeDB.Driver.nuspec | 62 +++++++++++++++++++ .../connection/{TypeDB.adoc => Drivers.adoc} | 16 ++--- csharp/docs_structure.bzl | 2 +- 11 files changed, 85 insertions(+), 23 deletions(-) rename csharp/{TypeDB.cs => Drivers.cs} (94%) create mode 100644 csharp/TypeDB.Driver.nuspec rename csharp/docs/connection/{TypeDB.adoc => Drivers.adoc} (78%) diff --git a/csharp/BUILD b/csharp/BUILD index 47450dc30a..c04dc3f8dd 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -17,9 +17,9 @@ load("@rules_dotnet//dotnet:defs.bzl", "csharp_binary", "csharp_library") load("@vaticle_bazel_distribution//docs:doxygen/rules.bzl", "doxygen_docs") +load("@vaticle_bazel_distribution//nuget:nuget_pack.bzl", "nuget_pack") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") load(":build_opts.bzl", "target_framework", "target_frameworks", "targeting_packs", "nullable_context") -load(":nuget_pack.bzl", "nuget_pack") load(":rules.bzl", "swig_native_csharp_library") load("//csharp:docs_structure.bzl", "dir_mapping") load("//tool/docs:csharp/rules.bzl", "doxygen_csharp_to_adoc") @@ -98,7 +98,7 @@ nuget_pack( filegroup( name = "docs_source_files", - srcs = [":TypeDB.cs"], + srcs = [":Drivers.cs"], ) diff --git a/csharp/TypeDB.cs b/csharp/Drivers.cs similarity index 94% rename from csharp/TypeDB.cs rename to csharp/Drivers.cs index c4e625b46d..eb26c215ff 100644 --- a/csharp/TypeDB.cs +++ b/csharp/Drivers.cs @@ -34,7 +34,7 @@ public static class Drivers * *

Examples

* 
-         * TypeDB.CoreDriver(address);
+         * Drivers.CoreDriver(address);
          *
* * @param address The address of the TypeDB server @@ -50,7 +50,7 @@ public static ITypeDBDriver CoreDriver(string address) * *

Examples

* 
-         * TypeDB.CloudDriver(address, credential);
+         * Drivers.CloudDriver(address, credential);
          *
* * @param address The address of the TypeDB server @@ -67,7 +67,7 @@ public static ITypeDBDriver CloudDriver(string address, TypeDBCredential credent * *

Examples

* 
-         * TypeDB.CloudDriver(addresses, credential);
+         * Drivers.CloudDriver(addresses, credential);
          *
* * @param addresses The address(es) of the TypeDB server(s) diff --git a/csharp/README.md b/csharp/README.md index 25e42acc1a..0c24494df6 100644 --- a/csharp/README.md +++ b/csharp/README.md @@ -2,10 +2,10 @@ The C# driver is based on the cross-platform .NET 6 framework. ## Use TypeDB Driver for C# -The driver will be distributed as a [Nuget](https://www.nuget.org/) package. More information will be provided in the next release! +The driver is distributed as a [Nuget](https://www.nuget.org/) package. Just choose the latest version ## API Reference -Will be added to [the docs](https://typedb.com/docs/drivers/overview) in the next release. The general layout (of classes, their methods and intended usage) resembles the [Java Driver API](https://typedb.com/docs/drivers/java/api-reference). +To learn about the methods available for executing queries and retrieving their answers using Driver Java, refer to the [API Reference](https://typedb.com/docs/drivers/overview) in the next release. The general layout (of classes, their methods and intended usage) resembles the [Java Driver API](https://typedb.com/docs/drivers/java/api-reference). ## Driver Architecture The C# driver is a thin wrapper around the TypeDB Rust driver, introducing classes for a more intuitive interface. Mostly each C# object holds a reference to the corresponding native Rust object, using an FFI ([SWIG for C#](https://www.swig.org/Doc4.2/SWIGDocumentation.html#CSharp)) for the native object wrappers generation and resource management. diff --git a/csharp/Test/Behaviour/Connection/ConnectionStepsCloud.cs b/csharp/Test/Behaviour/Connection/ConnectionStepsCloud.cs index 8a7ca6626e..4e3896d5a3 100644 --- a/csharp/Test/Behaviour/Connection/ConnectionStepsCloud.cs +++ b/csharp/Test/Behaviour/Connection/ConnectionStepsCloud.cs @@ -65,7 +65,7 @@ private ITypeDBDriver CreateTypeDBDriver( string? password = null, string? certificatesPath = null) { - return TypeDB.CloudDriver( + return Drivers.CloudDriver( addresses ?? DEFAULT_ADDRESSES, new TypeDBCredential( username ?? DEFAULT_USERNAME, diff --git a/csharp/Test/Behaviour/Connection/ConnectionStepsCore.cs b/csharp/Test/Behaviour/Connection/ConnectionStepsCore.cs index 3b0691fd92..3334ad4a2d 100644 --- a/csharp/Test/Behaviour/Connection/ConnectionStepsCore.cs +++ b/csharp/Test/Behaviour/Connection/ConnectionStepsCore.cs @@ -35,7 +35,7 @@ public BehaviourSteps() public override ITypeDBDriver CreateTypeDBDriver(string address) { - return TypeDB.CoreDriver(address); + return Drivers.CoreDriver(address); } [Given(@"typedb starts")] diff --git a/csharp/Test/Integration/Examples/CloudExamplesTest.cs b/csharp/Test/Integration/Examples/CloudExamplesTest.cs index d32854198c..b194c89957 100644 --- a/csharp/Test/Integration/Examples/CloudExamplesTest.cs +++ b/csharp/Test/Integration/Examples/CloudExamplesTest.cs @@ -47,7 +47,7 @@ public void DocExample() "password", Environment.GetEnvironmentVariable("ROOT_CA")!); - using (ITypeDBDriver driver = TypeDB.CloudDriver(serverAddrs, connectCredential)) + using (ITypeDBDriver driver = Drivers.CloudDriver(serverAddrs, connectCredential)) { driver.Databases.Create(dbName); IDatabase database = driver.Databases.Get(dbName); diff --git a/csharp/Test/Integration/Examples/CoreExamplesTest.cs b/csharp/Test/Integration/Examples/CoreExamplesTest.cs index 8537672094..962ee33f44 100644 --- a/csharp/Test/Integration/Examples/CoreExamplesTest.cs +++ b/csharp/Test/Integration/Examples/CoreExamplesTest.cs @@ -38,7 +38,7 @@ public void UsingsExample() try { - using (ITypeDBDriver driver = TypeDB.CoreDriver(serverAddr)) + using (ITypeDBDriver driver = Drivers.CoreDriver(serverAddr)) { driver.Databases.Create(dbName); IDatabase database = driver.Databases.Get(dbName); @@ -109,7 +109,7 @@ public void ManualExample() try { - ITypeDBDriver driver = TypeDB.CoreDriver(serverAddr); + ITypeDBDriver driver = Drivers.CoreDriver(serverAddr); driver.Databases.Create(dbName); IDatabase database = driver.Databases.Get(dbName); @@ -171,7 +171,7 @@ public void DocExample() try { - using (ITypeDBDriver driver = TypeDB.CoreDriver(serverAddr)) + using (ITypeDBDriver driver = Drivers.CoreDriver(serverAddr)) { driver.Databases.Create(dbName); IDatabase database = driver.Databases.Get(dbName); diff --git a/csharp/Test/Integration/Marshal/MarshalTest.cs b/csharp/Test/Integration/Marshal/MarshalTest.cs index 4164a0ecf8..1b975e3c4a 100644 --- a/csharp/Test/Integration/Marshal/MarshalTest.cs +++ b/csharp/Test/Integration/Marshal/MarshalTest.cs @@ -34,7 +34,7 @@ public static class Utils { public static ITypeDBDriver OpenConnection() { - ITypeDBDriver driver = TypeDB.CoreDriver(TypeDB.DEFAULT_ADDRESS); + ITypeDBDriver driver = Drivers.CoreDriver(TypeDB.DEFAULT_ADDRESS); Assert.IsNotNull(driver); Assert.True(driver.IsOpen()); diff --git a/csharp/TypeDB.Driver.nuspec b/csharp/TypeDB.Driver.nuspec new file mode 100644 index 0000000000..b004854865 --- /dev/null +++ b/csharp/TypeDB.Driver.nuspec @@ -0,0 +1,62 @@ + + + + $packageid$ + $version$ + TypeDB + Copyright © 2024 Vaticle + TypeDB + TypeDB Driver + false + The TypeDB driver was developed by Vaticle to enable TypeDB support for C# software and developers. + + TypeDB is a polymorphic database with a conceptual data model, a strong subtyping system, a symbolic reasoning engine, and a beautiful and elegant type-theoretic language: TypeQL. + + https://typedb.com + + Apache-2.0 + https://typedb.com/assets/logo/typedb.svg + Database TypeDB TypeQL + + See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver. TODO: Changelog? + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/csharp/docs/connection/TypeDB.adoc b/csharp/docs/connection/Drivers.adoc similarity index 78% rename from csharp/docs/connection/TypeDB.adoc rename to csharp/docs/connection/Drivers.adoc index 306863a43a..954b714579 100644 --- a/csharp/docs/connection/TypeDB.adoc +++ b/csharp/docs/connection/Drivers.adoc @@ -1,10 +1,10 @@ -[#_TypeDB] -=== TypeDB +[#_Drivers] +=== Drivers *Package*: `TypeDB.Driver` // tag::methods[] -[#_static_ITypeDBDriver_TypeDB_Driver_TypeDB_CloudDriver___string_address__TypeDBCredential_credential_] +[#_static_ITypeDBDriver_TypeDB_Driver_Drivers_CloudDriver___string_address__TypeDBCredential_credential_] ==== CloudDriver [source,cs] @@ -35,10 +35,10 @@ a| `credential` a| The credential to connect with a| `TypeDBCredential` .Code examples [source,cs] ---- -TypeDB.CloudDriver(address, credential); +Drivers.CloudDriver(address, credential); ---- -[#_static_ITypeDBDriver_TypeDB_Driver_TypeDB_CloudDriver___ICollection__string___addresses__TypeDBCredential_credential_] +[#_static_ITypeDBDriver_TypeDB_Driver_Drivers_CloudDriver___ICollection__string___addresses__TypeDBCredential_credential_] ==== CloudDriver [source,cs] @@ -69,10 +69,10 @@ a| `credential` a| The credential to connect with a| `TypeDBCredential` .Code examples [source,cs] ---- -TypeDB.CloudDriver(addresses, credential); +Drivers.CloudDriver(addresses, credential); ---- -[#_static_ITypeDBDriver_TypeDB_Driver_TypeDB_CoreDriver___string_address_] +[#_static_ITypeDBDriver_TypeDB_Driver_Drivers_CoreDriver___string_address_] ==== CoreDriver [source,cs] @@ -102,7 +102,7 @@ a| `address` a| The address of the TypeDB server a| `string` .Code examples [source,cs] ---- -TypeDB.CoreDriver(address); +Drivers.CoreDriver(address); ---- // end::methods[] diff --git a/csharp/docs_structure.bzl b/csharp/docs_structure.bzl index ba533773c5..8cec7f38be 100644 --- a/csharp/docs_structure.bzl +++ b/csharp/docs_structure.bzl @@ -31,7 +31,7 @@ dir_mapping = { "IValueGroup.adoc": "answer", "Promise__T__.adoc": "answer", "VoidPromise.adoc": "answer", - "TypeDB.adoc": "connection", + "Drivers.adoc": "connection", "ITypeDBDriver.adoc": "connection", "TypeDBCredential.adoc": "connection", "IUserManager.adoc": "connection", From 3efdfa7a7b53d92665a314cc965540b548db0fb6 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 27 Mar 2024 17:10:00 +0000 Subject: [PATCH 056/118] Start circleci, fix BUILD for non-mac --- .circleci/config.yml | 85 +++++++++++++++++-- .circleci/windows/csharp/deploy_release.bat | 32 +++++++ .circleci/windows/csharp/deploy_snapshot.bat | 33 +++++++ .../windows/csharp/test_deploy_snapshot.bat | 42 +++++++++ csharp/BUILD | 2 +- 5 files changed, 187 insertions(+), 7 deletions(-) create mode 100644 .circleci/windows/csharp/deploy_release.bat create mode 100644 .circleci/windows/csharp/deploy_snapshot.bat create mode 100644 .circleci/windows/csharp/test_deploy_snapshot.bat diff --git a/.circleci/config.yml b/.circleci/config.yml index 46d531acd7..eba8390dd2 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -349,6 +349,55 @@ commands: export DEPLOY_ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD bazel run --jobs=8 --define version=$(cat VERSION) //cpp:deploy-cpp-driver --compilation_mode=opt -- release + ######################### + # C# deployment steps # + ######################### + + install-nuget-mac: + steps: + - run: brew install nuget + + install-nuget-mac-rosetta: + steps: + - install-brew-rosetta + - run: /usr/local/bin/brew install nuget + + install-nuget-linux: + steps: + - run: yum install -y nuget + + deploy-nuget-snapshot-unix: + steps: + - run: | + export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_USERNAME + export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_PASSWORD + bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:deploy-nuget -- snapshot + + test-nuget-snapshot-unix: + steps: + - run: | + tool/test/start-core-server.sh + sed -i -e "s/DRIVER_CSHARP_VERSION_MARKER/0.0.0-$CIRCLE_SHA1/g" csharp/test/deployment/pom.xml + cat csharp/test/deployment/pom.xml + (cd csharp/test/deployment && mvn test) + tool/test/stop-core-server.sh + + test-nuget-snapshot-mac-rosetta: + steps: + - run: | + tool/test/start-core-server.sh + sed -i -e "s/DRIVER_CSHARP_VERSION_MARKER/0.0.0-$CIRCLE_SHA1/g" csharp/test/deployment/pom.xml + cat csharp/test/deployment/pom.xml + (cd csharp/test/deployment && /usr/local/bin/mvn test) + tool/test/stop-core-server.sh + + deploy-nuget-release-unix: + steps: + - run: | + export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_USERNAME + export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_PASSWORD + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:deploy-nuget --compilation_mode=opt -- release + ######################### # Rust deployment steps # ######################### @@ -430,6 +479,10 @@ jobs: - test-cpp-assembly-linux: target-arch: arm64 + - deploy-csharp-snapshot-unix + - test-csharp-assembly-linux: + target-arch: arm64 + deploy-snapshot-linux-x86_64: executor: linux-x86_64-amazonlinux-2 steps: @@ -449,6 +502,10 @@ jobs: - test-cpp-assembly-linux: target-arch: x86_64 + - deploy-csharp-snapshot-unix + - test-csharp-assembly-linux: + target-arch: x86_64 + deploy-snapshot-mac-arm64: executor: mac-arm64 steps: @@ -470,6 +527,10 @@ jobs: - test-cpp-assembly-mac: target-arch: arm64 + - deploy-csharp-snapshot-unix + - test-csharp-assembly-mac: + target-arch: arm64 + deploy-snapshot-mac-x86_64: executor: mac-arm64 steps: @@ -492,6 +553,10 @@ jobs: - test-cpp-assembly-mac: target-arch: x86_64 + - deploy-csharp-snapshot-unix + - test-csharp-assembly-mac: + target-arch: x86_64 + deploy-snapshot-windows-x86_64: executor: name: win/default @@ -512,6 +577,8 @@ jobs: - run: .circleci\windows\cpp\deploy_snapshot.bat - run: .circleci\windows\cpp\test_assembly.bat + - run: .circleci\windows\csharp\deploy_snapshot.bat + deploy-snapshot-any: executor: linux-x86_64-ubuntu-2204 steps: @@ -575,6 +642,7 @@ jobs: - run: .circleci\windows\prepare.bat - run: .circleci\windows\python\test_deploy_snapshot.bat - run: .circleci\windows\java\test_deploy_snapshot.bat + - run: .circleci\windows\csharp\test_deploy_snapshot.bat test-snapshot-any: executor: linux-x86_64-ubuntu-2204 @@ -599,6 +667,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix + - deploy-csharp-release-unix deploy-release-linux-x86_64: executor: linux-x86_64-amazonlinux-2 @@ -610,6 +679,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix + - deploy-csharp-release-unix deploy-release-mac-arm64: executor: mac-arm64 @@ -621,6 +691,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix + - deploy-csharp-release-unix deploy-release-mac-x86_64: executor: mac-arm64 @@ -633,6 +704,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix + - deploy-csharp-release-unix deploy-release-windows-x86_64: executor: @@ -647,6 +719,7 @@ jobs: - run: .circleci\windows\java\deploy_release.bat - run: .circleci\windows\clib\deploy_release.bat - run: .circleci\windows\cpp\deploy_release.bat + - run: .circleci\windows\csharp\deploy_release.bat deploy-release-any: executor: linux-x86_64-ubuntu-2204 @@ -704,28 +777,28 @@ workflows: - deploy-snapshot-linux-arm64: filters: branches: - only: [development, master] + only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment - deploy-snapshot-linux-x86_64: filters: branches: - only: [development, master] + only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment - deploy-snapshot-mac-arm64: filters: branches: - only: [development, master] + only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment - deploy-snapshot-mac-x86_64: filters: branches: - only: [development, master] + only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment - deploy-snapshot-windows-x86_64: filters: branches: - only: [development, master] + only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment - deploy-snapshot-any: filters: branches: - only: [development, master] + only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment requires: - deploy-snapshot-linux-arm64 - deploy-snapshot-linux-x86_64 diff --git a/.circleci/windows/csharp/deploy_release.bat b/.circleci/windows/csharp/deploy_release.bat new file mode 100644 index 0000000000..c225cf2a7c --- /dev/null +++ b/.circleci/windows/csharp/deploy_release.bat @@ -0,0 +1,32 @@ +@echo off +REM Copyright (C) 2022 Vaticle +REM +REM Licensed to the Apache Software Foundation (ASF) under one +REM or more contributor license agreements. See the NOTICE file +REM distributed with this work for additional information +REM regarding copyright ownership. The ASF licenses this file +REM to you under the Apache License, Version 2.0 (the +REM "License"); you may not use this file except in compliance +REM with the License. You may obtain a copy of the License at +REM +REM http://www.apache.org/licenses/LICENSE-2.0 +REM +REM Unless required by applicable law or agreed to in writing, +REM software distributed under the License is distributed on an +REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +REM KIND, either express or implied. See the License for the +REM specific language governing permissions and limitations +REM under the License. +REM + +REM needs to be called such that software installed +REM by Chocolatey in prepare.bat is accessible +CALL refreshenv + +ECHO Building and deploying windows package... +SET DEPLOY_NUGET_USERNAME=%REPO_TYPEDB_USERNAME% +SET DEPLOY_NUGET_PASSWORD=%REPO_TYPEDB_PASSWORD% + +SET /p VER= version_snapshot.txt +set /p VER= Date: Wed, 27 Mar 2024 17:58:16 +0000 Subject: [PATCH 057/118] Make packs special for each os --- csharp/BUILD | 61 +++++++++++++++++++++++++++++++++++-- csharp/TypeDB.Driver.nuspec | 4 +-- 2 files changed, 60 insertions(+), 5 deletions(-) diff --git a/csharp/BUILD b/csharp/BUILD index 4f2e0289ac..cacbed7210 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -64,9 +64,8 @@ csharp_library( nuget_pack( - name = "driver-csharp-pack", + name = "driver-csharp-pack-osx", files = { -# "//common/images:selenium_logo_small.png": "icon.png", "libtypedb_driver.dylib": "libtypedb_driver.dylib", "libtypedb_driver.so": "libtypedb_driver.so", "typedb_driver.dll": "typedb_driver.dll", @@ -84,7 +83,65 @@ nuget_pack( "//csharp/User:user": "TypeDB.Driver.User", }, osx_native_lib = "libtypedb_driver.dylib", + target_framework = target_framework, + nuspec_template = "TypeDB.Driver.nuspec", + tags = [ +# "block-network", + ], + version = "0.0.1", + visibility = ["//visibility:public"], +) + + +nuget_pack( + name = "driver-csharp-pack-linux", + files = { + "libtypedb_driver.dylib": "libtypedb_driver.dylib", + "libtypedb_driver.so": "libtypedb_driver.so", + "typedb_driver.dll": "typedb_driver.dll", + }, + id = "TypeDB.Driver", + libs = { + ":driver-csharp": "TypeDB.Driver", + ":typedb_driver_pinvoke": "TypeDB.Driver.Pinvoke", + "//csharp/Api:api": "TypeDB.Driver.Api", + "//csharp/Common:common": "TypeDB.Driver.Common", + "//csharp/Connection:connection": "TypeDB.Driver.Connection", + "//csharp/Concept:concept": "TypeDB.Driver.Concept", + "//csharp/Logic:logic": "TypeDB.Driver.Logic", + "//csharp/Query:query": "TypeDB.Driver.Query", + "//csharp/User:user": "TypeDB.Driver.User", + }, linux_native_lib = "libtypedb_driver.so", + target_framework = target_framework, + nuspec_template = "TypeDB.Driver.nuspec", + tags = [ +# "block-network", + ], + version = "0.0.1", + visibility = ["//visibility:public"], +) + + +nuget_pack( + name = "driver-csharp-pack-win", + files = { + "libtypedb_driver.dylib": "libtypedb_driver.dylib", + "libtypedb_driver.so": "libtypedb_driver.so", + "typedb_driver.dll": "typedb_driver.dll", + }, + id = "TypeDB.Driver", + libs = { + ":driver-csharp": "TypeDB.Driver", + ":typedb_driver_pinvoke": "TypeDB.Driver.Pinvoke", + "//csharp/Api:api": "TypeDB.Driver.Api", + "//csharp/Common:common": "TypeDB.Driver.Common", + "//csharp/Connection:connection": "TypeDB.Driver.Connection", + "//csharp/Concept:concept": "TypeDB.Driver.Concept", + "//csharp/Logic:logic": "TypeDB.Driver.Logic", + "//csharp/Query:query": "TypeDB.Driver.Query", + "//csharp/User:user": "TypeDB.Driver.User", + }, win_native_lib = "typedb_driver.dll", target_framework = target_framework, nuspec_template = "TypeDB.Driver.nuspec", diff --git a/csharp/TypeDB.Driver.nuspec b/csharp/TypeDB.Driver.nuspec index b004854865..b515d06232 100644 --- a/csharp/TypeDB.Driver.nuspec +++ b/csharp/TypeDB.Driver.nuspec @@ -54,9 +54,7 @@ - - - +$native_lib_files$ From a464ba0b1f65b8edf90aa394b5b3a4a23aa5b5ef Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 28 Mar 2024 10:25:25 +0000 Subject: [PATCH 058/118] Add deployment test --- .../Test/Deployment/NugetApplicationTest.cs | 99 +++++++++++++++++++ .../Deployment/NugetApplicationTest.csproj | 34 +++++++ 2 files changed, 133 insertions(+) create mode 100644 csharp/Test/Deployment/NugetApplicationTest.cs create mode 100644 csharp/Test/Deployment/NugetApplicationTest.csproj diff --git a/csharp/Test/Deployment/NugetApplicationTest.cs b/csharp/Test/Deployment/NugetApplicationTest.cs new file mode 100644 index 0000000000..07a3870d71 --- /dev/null +++ b/csharp/Test/Deployment/NugetApplicationTest.cs @@ -0,0 +1,99 @@ +using System; +using System.Collections.Generic; +using System.Linq; + +using Xunit; +using TypeDB.Driver; +using TypeDB.Driver.Api; +using TypeDB.Driver.Common; + +namespace TypeDB.Driver.Test.Deployment +{ + public class NugetApplicationTest + { + [Fact] + public static void Main() + { + Console.WriteLine("Starting test..."); + + string dbName = "nuget-test-database"; + + using (ITypeDBDriver driver = Drivers.CoreDriver("localhost:1729")) + { + try + { + driver.Databases.Create(dbName); + } + catch (TypeDBDriverException e) + { + if (!e.Message.Contains("already exists")) + { + throw e; + } + + driver.Databases.Get(dbName).Delete(); + driver.Databases.Create(dbName); + } + + IDatabase database = driver.Databases.Get(dbName); + + try + { + using (ITypeDBSession session = driver.Session(dbName, SessionType.Schema)) + { + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Write)) + { + IEntityType root = transaction.Concepts.RootEntityType; + Assert.NotNull(root); + Assert.Single(root.GetSubtypes(transaction)); + + transaction.Query.Define("define person sub entity;").Resolve(); + string longQuery = "define name sub attribute, value string; person owns name;"; + transaction.Query.Define(longQuery).Resolve(); + transaction.Commit(); + } + } + + using (ITypeDBSession session = driver.Session(dbName, SessionType.Data)) + { + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Write)) + { + IEntityType root = transaction.Concepts.RootEntityType; + Assert.NotNull(root); + Assert.Equal(2, root.GetSubtypes(transaction).Count()); + + string query = "insert $p isa person, has name 'Alice';"; + IEnumerable insertResults = transaction.Query.Insert(query); + Assert.NotNull(insertResults); + Assert.Single(insertResults); + + transaction.Commit(); + } + + using (ITypeDBTransaction transaction = session.Transaction(TransactionType.Read)) + { + IConceptMap[] matchResults = + transaction.Query.Get("match $p isa person, has name $n; get $n;").ToArray(); + + var fetchResults = + transaction.Query.Fetch("match $f isa person, has name $n; fetch $n;").ToList(); + Assert.NotNull(fetchResults); + Assert.Single(fetchResults); + + foreach (var result in fetchResults) + { + Console.WriteLine($"JSON result: {result}"); + } + } + } + } + finally + { + database.Delete(); + } + } + + Console.WriteLine("Ending test..."); + } + } +} diff --git a/csharp/Test/Deployment/NugetApplicationTest.csproj b/csharp/Test/Deployment/NugetApplicationTest.csproj new file mode 100644 index 0000000000..25f08b6fde --- /dev/null +++ b/csharp/Test/Deployment/NugetApplicationTest.csproj @@ -0,0 +1,34 @@ + + + + Exe + net6.0 + true + NugetApplicationTest + NugetApplicationTest + + This test checks that our TypeDB Driver Nuget package works correctly will all the transitive dependencies! + + TypeDB + TypeDB + Copyright © 2024 Vaticle + false + + https://typedb.com + Database TypeDB TypeQL Test + false + https://github.com/vaticle/typedb-driver + 1.0.0 + No + false + Apache-2.0 + $(RestoreSources);TestPackages;https://api.nuget.org/v3/index.json + + + + + + + + + From 37e8a83bf557f6e0e763761f8202e2fba8781f61 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 28 Mar 2024 18:03:28 +0000 Subject: [PATCH 059/118] Add nuget push call --- .circleci/config.yml | 62 ++++++++++--------- .../windows/csharp/test_deploy_snapshot.bat | 2 +- csharp/BUILD | 44 +++++-------- ...r.nuspec => TypeDB.Driver.nuspec.template} | 0 4 files changed, 48 insertions(+), 60 deletions(-) rename csharp/{TypeDB.Driver.nuspec => TypeDB.Driver.nuspec.template} (100%) diff --git a/.circleci/config.yml b/.circleci/config.yml index eba8390dd2..e90563dcd6 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -353,49 +353,49 @@ commands: # C# deployment steps # ######################### - install-nuget-mac: + install-dotnet-mac: steps: - - run: brew install nuget + - run: brew install dotnet@6 - install-nuget-mac-rosetta: + install-dotnet-mac-rosetta: steps: - install-brew-rosetta - - run: /usr/local/bin/brew install nuget + - run: /usr/local/bin/brew install dotnet@6 - install-nuget-linux: + install-dotnet-linux: steps: - - run: yum install -y nuget + - run: yum install -y dotnet-sdk-6.0 deploy-nuget-snapshot-unix: steps: - run: | export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_USERNAME - export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_PASSWORD + export DEPLOY_NUGET_PASSWORD=$REPO_TYPEDB_PASSWORD bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:deploy-nuget -- snapshot test-nuget-snapshot-unix: steps: - run: | tool/test/start-core-server.sh - sed -i -e "s/DRIVER_CSHARP_VERSION_MARKER/0.0.0-$CIRCLE_SHA1/g" csharp/test/deployment/pom.xml - cat csharp/test/deployment/pom.xml - (cd csharp/test/deployment && mvn test) + sed -i -e "s/DRIVER_CSHARP_VERSION_MARKER/0.0.0-$CIRCLE_SHA1/g" csharp/Test/Deployment/NugetApplicationTest.csproj + cat csharp/Test/Deployment/NugetApplicationTest.csproj + (cd csharp/Test/Deployment && dotnet run NugetApplicationTest.csproj) tool/test/stop-core-server.sh test-nuget-snapshot-mac-rosetta: steps: - run: | tool/test/start-core-server.sh - sed -i -e "s/DRIVER_CSHARP_VERSION_MARKER/0.0.0-$CIRCLE_SHA1/g" csharp/test/deployment/pom.xml - cat csharp/test/deployment/pom.xml - (cd csharp/test/deployment && /usr/local/bin/mvn test) + sed -i -e "s/DRIVER_CSHARP_VERSION_MARKER/0.0.0-$CIRCLE_SHA1/g" csharp/Test/Deployment/NugetApplicationTest.csproj + cat csharp/Test/Deployment/NugetApplicationTest.csproj + (cd csharp/Test/Deployment && /usr/local/bin/dotnet run NugetApplicationTest.csproj) tool/test/stop-core-server.sh deploy-nuget-release-unix: steps: - run: | export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_USERNAME - export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_PASSWORD + export DEPLOY_NUGET_PASSWORD=$REPO_TYPEDB_PASSWORD bazel run --jobs=8 --define version=$(cat VERSION) //csharp:deploy-nuget --compilation_mode=opt -- release ######################### @@ -479,9 +479,7 @@ jobs: - test-cpp-assembly-linux: target-arch: arm64 - - deploy-csharp-snapshot-unix - - test-csharp-assembly-linux: - target-arch: arm64 + - deploy-nuget-snapshot-unix deploy-snapshot-linux-x86_64: executor: linux-x86_64-amazonlinux-2 @@ -502,9 +500,7 @@ jobs: - test-cpp-assembly-linux: target-arch: x86_64 - - deploy-csharp-snapshot-unix - - test-csharp-assembly-linux: - target-arch: x86_64 + - deploy-nuget-snapshot-unix deploy-snapshot-mac-arm64: executor: mac-arm64 @@ -527,9 +523,7 @@ jobs: - test-cpp-assembly-mac: target-arch: arm64 - - deploy-csharp-snapshot-unix - - test-csharp-assembly-mac: - target-arch: arm64 + - deploy-nuget-snapshot-unix deploy-snapshot-mac-x86_64: executor: mac-arm64 @@ -553,9 +547,7 @@ jobs: - test-cpp-assembly-mac: target-arch: x86_64 - - deploy-csharp-snapshot-unix - - test-csharp-assembly-mac: - target-arch: x86_64 + - deploy-nuget-snapshot-unix deploy-snapshot-windows-x86_64: executor: @@ -589,6 +581,7 @@ jobs: - deploy-maven-snapshot-unix - install-npm-apt - deploy-npm-snapshot-unix + - deploy-nuget-snapshot-unix # TODO: Need here? test-snapshot-linux-arm64: executor: linux-arm64-amazonlinux-2 @@ -599,6 +592,8 @@ jobs: - test-pip-snapshot-unix - install-maven-linux - test-maven-snapshot-unix + - install-dotnet-linux + - test-nuget-snapshot-unix test-snapshot-linux-x86_64: executor: linux-x86_64-amazonlinux-2 @@ -609,6 +604,8 @@ jobs: - test-pip-snapshot-unix - install-maven-linux - test-maven-snapshot-unix + - install-dotnet-linux + - test-nuget-snapshot-unix test-snapshot-mac-arm64: executor: mac-arm64 @@ -619,6 +616,8 @@ jobs: - test-pip-snapshot-unix - install-maven-mac - test-maven-snapshot-unix + - install-dotnet-mac + - test-nuget-snapshot-unix test-snapshot-mac-x86_64: executor: mac-arm64 @@ -630,6 +629,8 @@ jobs: - test-pip-snapshot-mac-rosetta - install-maven-mac-rosetta - test-maven-snapshot-mac-rosetta + - install-dotnet-mac-rosetta + - test-nuget-snapshot-mac-rosetta test-snapshot-windows-x86_64: executor: @@ -667,7 +668,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-csharp-release-unix + - deploy-nuget-release-unix deploy-release-linux-x86_64: executor: linux-x86_64-amazonlinux-2 @@ -679,7 +680,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-csharp-release-unix + - deploy-nuget-release-unix deploy-release-mac-arm64: executor: mac-arm64 @@ -691,7 +692,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-csharp-release-unix + - deploy-nuget-release-unix deploy-release-mac-x86_64: executor: mac-arm64 @@ -704,7 +705,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-csharp-release-unix + - deploy-nuget-release-unix deploy-release-windows-x86_64: executor: @@ -731,6 +732,7 @@ jobs: - deploy-maven-release-unix - install-npm-apt - deploy-npm-release-unix + - deploy-nuget-release-unix # TODO: Need here? deploy-github: executor: linux-x86_64-ubuntu-2204 diff --git a/.circleci/windows/csharp/test_deploy_snapshot.bat b/.circleci/windows/csharp/test_deploy_snapshot.bat index bc11cf5fb3..8983575bff 100644 --- a/.circleci/windows/csharp/test_deploy_snapshot.bat +++ b/.circleci/windows/csharp/test_deploy_snapshot.bat @@ -33,7 +33,7 @@ START /B "" typedb-server-windows\typedb server powershell -Command "(gc csharp\test\deployment\pom.xml) -replace 'DRIVER_CSHARP_VERSION_MARKER', '0.0.0-%CIRCLE_SHA1%' | Out-File -encoding ASCII csharp\test\deployment\pom.xml" type csharp\test\deployment\pom.xml cd csharp\test\deployment -CALL mvn test +CALL dotnet run ... SET IS_ERROR=%ERRORLEVEL% REM kill typedb server diff --git a/csharp/BUILD b/csharp/BUILD index cacbed7210..26fc5d09e2 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -17,7 +17,7 @@ load("@rules_dotnet//dotnet:defs.bzl", "csharp_binary", "csharp_library") load("@vaticle_bazel_distribution//docs:doxygen/rules.bzl", "doxygen_docs") -load("@vaticle_bazel_distribution//nuget:nuget_pack.bzl", "nuget_pack") +load("@vaticle_bazel_distribution//nuget:rules.bzl", "nuget_pack", "nuget_push") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") load(":build_opts.bzl", "target_framework", "target_frameworks", "targeting_packs", "nullable_context") load(":rules.bzl", "swig_native_csharp_library") @@ -36,13 +36,6 @@ swig_native_csharp_library( target_frameworks = target_frameworks, targeting_packs = targeting_packs, visibility = ["//visibility:public"], -# platforms = { # TODO: We'll need to build for different platforms? -# "@vaticle_bazel_distribution//platform:is_linux_arm64": "linux-arm64", -# "@vaticle_bazel_distribution//platform:is_linux_x86_64": "linux-x86_64", -# "@vaticle_bazel_distribution//platform:is_mac_arm64": "macosx-arm64", -# "@vaticle_bazel_distribution//platform:is_mac_x86_64": "macosx-x86_64", -# "@vaticle_bazel_distribution//platform:is_windows_x86_64": "windows-x86_64", -# }, ) @@ -57,18 +50,16 @@ csharp_library( "//csharp:typedb_driver_pinvoke", ], out = "TypeDB.Driver", - visibility = ["//visibility:public"], target_frameworks = target_frameworks, targeting_packs = targeting_packs, + visibility = ["//visibility:public"], ) nuget_pack( - name = "driver-csharp-pack-osx", + name = "driver-csharp-pack", files = { "libtypedb_driver.dylib": "libtypedb_driver.dylib", - "libtypedb_driver.so": "libtypedb_driver.so", - "typedb_driver.dll": "typedb_driver.dll", }, id = "TypeDB.Driver", libs = { @@ -82,12 +73,9 @@ nuget_pack( "//csharp/Query:query": "TypeDB.Driver.Query", "//csharp/User:user": "TypeDB.Driver.User", }, - osx_native_lib = "libtypedb_driver.dylib", + mac_native_lib = "libtypedb_driver.dylib", target_framework = target_framework, - nuspec_template = "TypeDB.Driver.nuspec", - tags = [ -# "block-network", - ], + nuspec_template = "TypeDB.Driver.nuspec.template", version = "0.0.1", visibility = ["//visibility:public"], ) @@ -96,9 +84,7 @@ nuget_pack( nuget_pack( name = "driver-csharp-pack-linux", files = { - "libtypedb_driver.dylib": "libtypedb_driver.dylib", "libtypedb_driver.so": "libtypedb_driver.so", - "typedb_driver.dll": "typedb_driver.dll", }, id = "TypeDB.Driver", libs = { @@ -114,10 +100,7 @@ nuget_pack( }, linux_native_lib = "libtypedb_driver.so", target_framework = target_framework, - nuspec_template = "TypeDB.Driver.nuspec", - tags = [ -# "block-network", - ], + nuspec_template = "TypeDB.Driver.nuspec.template", version = "0.0.1", visibility = ["//visibility:public"], ) @@ -126,8 +109,6 @@ nuget_pack( nuget_pack( name = "driver-csharp-pack-win", files = { - "libtypedb_driver.dylib": "libtypedb_driver.dylib", - "libtypedb_driver.so": "libtypedb_driver.so", "typedb_driver.dll": "typedb_driver.dll", }, id = "TypeDB.Driver", @@ -144,15 +125,20 @@ nuget_pack( }, win_native_lib = "typedb_driver.dll", target_framework = target_framework, - nuspec_template = "TypeDB.Driver.nuspec", - tags = [ -# "block-network", - ], + nuspec_template = "TypeDB.Driver.nuspec.template", version = "0.0.1", visibility = ["//visibility:public"], ) +nuget_push( + name = "driver-csharp-push-mac", + src = ":driver-csharp-pack-mac", +# package_repository_url = "https://api.nuget.org/v3/index.json", + package_repository_url = "https://nuget.cloudsmith.io/typedb/public-snapshot/v3/index.json", +) + + filegroup( name = "docs_source_files", srcs = [":Drivers.cs"], diff --git a/csharp/TypeDB.Driver.nuspec b/csharp/TypeDB.Driver.nuspec.template similarity index 100% rename from csharp/TypeDB.Driver.nuspec rename to csharp/TypeDB.Driver.nuspec.template From 903ace45475dae454801988a03b21c8f1ed5350a Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 1 Apr 2024 00:12:28 +0100 Subject: [PATCH 060/118] Sync with updated bazel distr repo --- csharp/BUILD | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/csharp/BUILD b/csharp/BUILD index 26fc5d09e2..d31338aae7 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -57,7 +57,7 @@ csharp_library( nuget_pack( - name = "driver-csharp-pack", + name = "driver-csharp-pack-mac", files = { "libtypedb_driver.dylib": "libtypedb_driver.dylib", }, @@ -134,8 +134,8 @@ nuget_pack( nuget_push( name = "driver-csharp-push-mac", src = ":driver-csharp-pack-mac", -# package_repository_url = "https://api.nuget.org/v3/index.json", - package_repository_url = "https://nuget.cloudsmith.io/typedb/public-snapshot/v3/index.json", +# repository_url = "https://api.nuget.org/v3/index.json", + repository_url = "https://nuget.cloudsmith.io/typedb/public-snapshot/v3/index.json", ) From e11b7128d8418b6c92b2e7446c0277113ed79103 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 1 Apr 2024 19:47:15 +0100 Subject: [PATCH 061/118] Add two options to build packages: separate and merged ones --- csharp/BUILD | 50 ++++++++++++++++ .../Test/Deployment/NugetApplicationTest.cs | 2 +- .../Deployment/NugetApplicationTest.csproj | 7 ++- .../TypeDB.Driver.NoRuntime.nuspec.template | 57 +++++++++++++++++++ csharp/TypeDB.Driver.Pinvoke.nuspec.template | 31 ++++++++++ 5 files changed, 144 insertions(+), 3 deletions(-) create mode 100644 csharp/TypeDB.Driver.NoRuntime.nuspec.template create mode 100644 csharp/TypeDB.Driver.Pinvoke.nuspec.template diff --git a/csharp/BUILD b/csharp/BUILD index d31338aae7..640b309dd5 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -56,6 +56,22 @@ csharp_library( ) +nuget_pack( + name = "driver-csharp-pinvoke-pack-mac", + files = { + "libtypedb_driver.dylib": "libtypedb_driver.dylib", + }, + id = "TypeDB.Driver.Pinvoke", + libs = { + ":typedb_driver_pinvoke": "TypeDB.Driver.Pinvoke", + }, + mac_native_lib = "libtypedb_driver.dylib", + target_framework = target_framework, + nuspec_template = "TypeDB.Driver.Pinvoke.nuspec.template", + version = "0.0.1", + visibility = ["//visibility:public"], +) + nuget_pack( name = "driver-csharp-pack-mac", files = { @@ -81,6 +97,26 @@ nuget_pack( ) +nuget_pack( + name = "driver-csharp-pack-noruntime", + id = "TypeDB.Driver.NoRuntime", + libs = { + ":driver-csharp": "TypeDB.Driver", + "//csharp/Api:api": "TypeDB.Driver.Api", + "//csharp/Common:common": "TypeDB.Driver.Common", + "//csharp/Connection:connection": "TypeDB.Driver.Connection", + "//csharp/Concept:concept": "TypeDB.Driver.Concept", + "//csharp/Logic:logic": "TypeDB.Driver.Logic", + "//csharp/Query:query": "TypeDB.Driver.Query", + "//csharp/User:user": "TypeDB.Driver.User", + }, + target_framework = target_framework, + nuspec_template = "TypeDB.Driver.NoRuntime.nuspec.template", + version = "0.0.1", + visibility = ["//visibility:public"], +) + + nuget_pack( name = "driver-csharp-pack-linux", files = { @@ -131,6 +167,13 @@ nuget_pack( ) +nuget_push( + name = "driver-csharp-pinvoke-push-mac", + src = ":driver-csharp-pinvoke-pack-mac", +# repository_url = "https://api.nuget.org/v3/index.json", + repository_url = "https://nuget.cloudsmith.io/typedb/public-snapshot/v3/index.json", +) + nuget_push( name = "driver-csharp-push-mac", src = ":driver-csharp-pack-mac", @@ -138,6 +181,13 @@ nuget_push( repository_url = "https://nuget.cloudsmith.io/typedb/public-snapshot/v3/index.json", ) +nuget_push( + name = "driver-csharp-push-noruntime", + src = ":driver-csharp-pack-noruntime", +# repository_url = "https://api.nuget.org/v3/index.json", + repository_url = "https://nuget.cloudsmith.io/typedb/public-snapshot/v3/index.json", +) + filegroup( name = "docs_source_files", diff --git a/csharp/Test/Deployment/NugetApplicationTest.cs b/csharp/Test/Deployment/NugetApplicationTest.cs index 07a3870d71..fdd111761e 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.cs +++ b/csharp/Test/Deployment/NugetApplicationTest.cs @@ -93,7 +93,7 @@ public static void Main() } } - Console.WriteLine("Ending test..."); + Console.WriteLine("Success!"); } } } diff --git a/csharp/Test/Deployment/NugetApplicationTest.csproj b/csharp/Test/Deployment/NugetApplicationTest.csproj index 25f08b6fde..1df7491f65 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.csproj +++ b/csharp/Test/Deployment/NugetApplicationTest.csproj @@ -22,11 +22,14 @@ No false Apache-2.0 - $(RestoreSources);TestPackages;https://api.nuget.org/v3/index.json + $(RestoreSources);https://nuget.cloudsmith.io/typedb/public-snapshot/v3/index.json;https://api.nuget.org/v3/index.json - + + + + diff --git a/csharp/TypeDB.Driver.NoRuntime.nuspec.template b/csharp/TypeDB.Driver.NoRuntime.nuspec.template new file mode 100644 index 0000000000..803335e852 --- /dev/null +++ b/csharp/TypeDB.Driver.NoRuntime.nuspec.template @@ -0,0 +1,57 @@ + + + + $packageid$ + $version$ + TypeDB + Copyright © 2024 Vaticle + TypeDB + TypeDB Driver + false + The TypeDB driver was developed by Vaticle to enable TypeDB support for C# software and developers. + + TypeDB is a polymorphic database with a conceptual data model, a strong subtyping system, a symbolic reasoning engine, and a beautiful and elegant type-theoretic language: TypeQL. + + https://typedb.com + + Apache-2.0 + https://typedb.com/assets/logo/typedb.svg + Database TypeDB TypeQL + + See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver. TODO: Changelog? + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +$native_lib_files$ + + + diff --git a/csharp/TypeDB.Driver.Pinvoke.nuspec.template b/csharp/TypeDB.Driver.Pinvoke.nuspec.template new file mode 100644 index 0000000000..8bbea7f955 --- /dev/null +++ b/csharp/TypeDB.Driver.Pinvoke.nuspec.template @@ -0,0 +1,31 @@ + + + + $packageid$ + $version$ + TypeDB + Copyright © 2024 Vaticle + TypeDB + TypeDB Driver Runtime + false + The TypeDB driver was developed by Vaticle to enable TypeDB support for C# software and developers. + + TypeDB is a polymorphic database with a conceptual data model, a strong subtyping system, a symbolic reasoning engine, and a beautiful and elegant type-theoretic language: TypeQL. + + https://typedb.com + + Apache-2.0 + https://typedb.com/assets/logo/typedb.svg + Database TypeDB TypeQL Runtime + + See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver. TODO: Changelog? + + + + + + +$native_lib_files$ + + + From f34ff880b1dfb092fdd0e7258b0b84c520112e83 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Mon, 1 Apr 2024 20:48:04 +0100 Subject: [PATCH 062/118] Refactor rules, added steps to the circleci scripts --- .circleci/config.yml | 17 +++++++++++------ .circleci/windows/csharp/deploy_release.bat | 7 ++++--- .circleci/windows/csharp/deploy_snapshot.bat | 7 ++++--- csharp/BUILD | 16 ++++++++++------ 4 files changed, 29 insertions(+), 18 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index e90563dcd6..fde919fad4 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -369,9 +369,11 @@ commands: deploy-nuget-snapshot-unix: steps: - run: | - export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_USERNAME - export DEPLOY_NUGET_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:deploy-nuget -- snapshot + export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_USERNAME +# export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_USERNAME +# export DEPLOY_NUGET_PASSWORD=$REPO_TYPEDB_PASSWORD + bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push-mac -- snapshot +# bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push-linux -- snapshot test-nuget-snapshot-unix: steps: @@ -394,9 +396,12 @@ commands: deploy-nuget-release-unix: steps: - run: | - export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_USERNAME - export DEPLOY_NUGET_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=$(cat VERSION) //csharp:deploy-nuget --compilation_mode=opt -- release + export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_USERNAME +# export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_USERNAME +# export DEPLOY_NUGET_PASSWORD=$REPO_TYPEDB_PASSWORD + + bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push-mac -- release +# bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push-linux -- release ######################### # Rust deployment steps # diff --git a/.circleci/windows/csharp/deploy_release.bat b/.circleci/windows/csharp/deploy_release.bat index c225cf2a7c..5fa39f8d8d 100644 --- a/.circleci/windows/csharp/deploy_release.bat +++ b/.circleci/windows/csharp/deploy_release.bat @@ -24,9 +24,10 @@ REM by Chocolatey in prepare.bat is accessible CALL refreshenv ECHO Building and deploying windows package... -SET DEPLOY_NUGET_USERNAME=%REPO_TYPEDB_USERNAME% -SET DEPLOY_NUGET_PASSWORD=%REPO_TYPEDB_PASSWORD% +SET DEPLOY_NUGET_API_KEY=%REPO_TYPEDB_USERNAME% +@REM SET DEPLOY_NUGET_USERNAME=%REPO_TYPEDB_USERNAME% +@REM SET DEPLOY_NUGET_PASSWORD=%REPO_TYPEDB_PASSWORD% SET /p VER= version_snapshot.txt set /p VER= Date: Tue, 2 Apr 2024 10:45:04 +0100 Subject: [PATCH 063/118] Fix builds and docs after merges --- .circleci/config.yml | 12 +- c/docs/answer/conceptmap.adoc | 287 ++++++++++ c/docs/answer/explanation.adoc | 386 +++++++++++++ c/docs/answer/primitives.adoc | 195 +++++++ c/docs/answer/valuegroup.adoc | 129 +++++ c/docs/concept/attribute.adoc | 51 ++ c/docs/concept/concept.adoc | 472 ++++++++++++++++ c/docs/concept/entity.adoc | 19 + c/docs/concept/relation.adoc | 109 ++++ c/docs/concept/roleplayer.adoc | 97 ++++ c/docs/concept/thing.adoc | 466 +++++++++++++++ c/docs/concept/value.adoc | 243 ++++++++ c/docs/connection/connection.adoc | 130 +++++ c/docs/connection/credential.adoc | 55 ++ c/docs/connection/database.adoc | 296 ++++++++++ c/docs/connection/replica.adoc | 129 +++++ c/docs/connection/user.adoc | 289 ++++++++++ c/docs/errors/error.adoc | 96 ++++ c/docs/errors/schemaexception.adoc | 97 ++++ c/docs/logic/logic.adoc | 63 +++ c/docs/logic/rule.adoc | 200 +++++++ c/docs/schema/annotation.adoc | 122 ++++ c/docs/schema/attributetype.adoc | 223 ++++++++ c/docs/schema/entitytype.adoc | 99 ++++ c/docs/schema/relationtype.adoc | 179 ++++++ c/docs/schema/roletype.adoc | 243 ++++++++ c/docs/schema/transitivity.adoc | 31 + c/docs/schema/valuetype.adoc | 51 ++ c/docs/session/options.adoc | 533 ++++++++++++++++++ c/docs/session/session.adoc | 189 +++++++ c/docs/transaction/query.adoc | 190 +++++++ c/docs/transaction/transaction.adoc | 173 ++++++ cpp/docs/answer/ConceptMap.adoc | 35 -- cpp/docs/answer/ConceptMapGroup.adoc | 14 - cpp/docs/answer/Explainable.adoc | 14 - cpp/docs/answer/Explainables.adoc | 42 -- cpp/docs/answer/Explanation.adoc | 35 -- cpp/docs/answer/ValueGroup.adoc | 14 - cpp/docs/concept/Concept.adoc | 147 ----- cpp/docs/concept/ConceptManager.adoc | 91 --- cpp/docs/connection/Database.adoc | 49 -- cpp/docs/connection/DatabaseManager.adoc | 28 - cpp/docs/connection/Driver.adoc | 49 -- cpp/docs/connection/UserManager.adoc | 42 -- cpp/docs/data/Attribute.adoc | 28 - cpp/docs/data/Entity.adoc | 7 - cpp/docs/data/Relation.adoc | 42 -- cpp/docs/data/Thing.adoc | 79 --- cpp/docs/data/Value.adoc | 126 ----- cpp/docs/errors/DriverException.adoc | 21 - cpp/docs/logic/LogicManager.adoc | 21 - cpp/docs/logic/Rule.adoc | 21 - cpp/docs/schema/Annotation.adoc | 28 - cpp/docs/schema/AttributeType.adoc | 182 ------ cpp/docs/schema/EntityType.adoc | 28 - cpp/docs/schema/RelationType.adoc | 71 --- cpp/docs/schema/RoleType.adoc | 112 ---- cpp/docs/schema/ThingType.adoc | 145 ----- cpp/docs/schema/Type.adoc | 57 -- cpp/docs/session/Options.adoc | 147 ----- cpp/docs/session/Session.adoc | 42 -- cpp/docs/transaction/QueryManager.adoc | 77 --- cpp/docs/transaction/Transaction.adoc | 42 -- .../Connection/ConnectionStepsCore.cs | 2 +- .../Integration/Examples/CloudExamplesTest.cs | 2 - .../Test/Integration/Marshal/MarshalTest.cs | 2 +- 66 files changed, 5850 insertions(+), 1846 deletions(-) create mode 100644 c/docs/answer/conceptmap.adoc create mode 100644 c/docs/answer/explanation.adoc create mode 100644 c/docs/answer/primitives.adoc create mode 100644 c/docs/answer/valuegroup.adoc create mode 100644 c/docs/concept/attribute.adoc create mode 100644 c/docs/concept/concept.adoc create mode 100644 c/docs/concept/entity.adoc create mode 100644 c/docs/concept/relation.adoc create mode 100644 c/docs/concept/roleplayer.adoc create mode 100644 c/docs/concept/thing.adoc create mode 100644 c/docs/concept/value.adoc create mode 100644 c/docs/connection/connection.adoc create mode 100644 c/docs/connection/credential.adoc create mode 100644 c/docs/connection/database.adoc create mode 100644 c/docs/connection/replica.adoc create mode 100644 c/docs/connection/user.adoc create mode 100644 c/docs/errors/error.adoc create mode 100644 c/docs/errors/schemaexception.adoc create mode 100644 c/docs/logic/logic.adoc create mode 100644 c/docs/logic/rule.adoc create mode 100644 c/docs/schema/annotation.adoc create mode 100644 c/docs/schema/attributetype.adoc create mode 100644 c/docs/schema/entitytype.adoc create mode 100644 c/docs/schema/relationtype.adoc create mode 100644 c/docs/schema/roletype.adoc create mode 100644 c/docs/schema/transitivity.adoc create mode 100644 c/docs/schema/valuetype.adoc create mode 100644 c/docs/session/options.adoc create mode 100644 c/docs/session/session.adoc create mode 100644 c/docs/transaction/query.adoc create mode 100644 c/docs/transaction/transaction.adoc diff --git a/.circleci/config.yml b/.circleci/config.yml index fde919fad4..8e541d241e 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -784,28 +784,28 @@ workflows: - deploy-snapshot-linux-arm64: filters: branches: - only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment + only: [development, master] # TODO: Remove csharp-docs-deployment - deploy-snapshot-linux-x86_64: filters: branches: - only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment + only: [development, master] # TODO: Remove csharp-docs-deployment - deploy-snapshot-mac-arm64: filters: branches: - only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment + only: [development, master] # TODO: Remove csharp-docs-deployment - deploy-snapshot-mac-x86_64: filters: branches: - only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment + only: [development, master] # TODO: Remove csharp-docs-deployment - deploy-snapshot-windows-x86_64: filters: branches: - only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment + only: [development, master] # TODO: Remove csharp-docs-deployment - deploy-snapshot-any: filters: branches: - only: [csharp-docs-deployment, development, master] # TODO: Remove csharp-docs-deployment + only: [development, master] # TODO: Remove csharp-docs-deployment requires: - deploy-snapshot-linux-arm64 - deploy-snapshot-linux-x86_64 diff --git a/c/docs/answer/conceptmap.adoc b/c/docs/answer/conceptmap.adoc new file mode 100644 index 0000000000..d4b85d78a5 --- /dev/null +++ b/c/docs/answer/conceptmap.adoc @@ -0,0 +1,287 @@ +[#_methods__answer__conceptmap] +=== conceptmap + +[#_Struct_ConceptMap] +==== Struct ConceptMap + + + +Contains a mapping of variables to concepts. + +[#_Struct_ConceptMapGroup] +==== Struct ConceptMapGroup + + + +Contains an element of the TypeQL Get Group query result. + +[#_Struct_ConceptMapGroupIterator] +==== Struct ConceptMapGroupIterator + + + +Iterator over the ``ConceptMapGroup``s in the result of the TypeQL Get Group query. + +[#_Struct_ConceptMapIterator] +==== Struct ConceptMapIterator + + + +Iterator over the ``ConceptMap``s in the result of a TypeQL Get query. + +[#_concept_map_drop] +==== concept_map_drop + +[source,cpp] +---- +void concept_map_drop(struct ConceptMap* concept_map) +---- + + + +Frees the native rust ``ConceptMap`` object + +[caption=""] +.Returns +`void` + +[#_concept_map_equals] +==== concept_map_equals + +[source,cpp] +---- +bool concept_map_equals(const struct ConceptMap* lhs, const struct ConceptMap* rhs) +---- + + + +Checks whether the provided ``ConceptMap`` objects are equal + +[caption=""] +.Returns +`bool` + +[#_concept_map_get] +==== concept_map_get + +[source,cpp] +---- +struct Concept* concept_map_get(const struct ConceptMap* concept_map, const char* var) +---- + + + +Retrieves a concept for a given variable name. + +[caption=""] +.Returns +`struct Concept*` + +[#_concept_map_get_explainables] +==== concept_map_get_explainables + +[source,cpp] +---- +struct Explainables* concept_map_get_explainables(const struct ConceptMap* concept_map) +---- + + + +Gets the ``Explainables`` object for this ``ConceptMap``, exposing which of the concepts in this ``ConceptMap`` are explainable. + +[caption=""] +.Returns +`struct Explainables*` + +[#_concept_map_get_values] +==== concept_map_get_values + +[source,cpp] +---- +struct ConceptIterator* concept_map_get_values(const struct ConceptMap* concept_map) +---- + + + +Produces an ``Iterator`` over all ``Concepts`` in this ``ConceptMap``. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_concept_map_get_variables] +==== concept_map_get_variables + +[source,cpp] +---- +struct StringIterator* concept_map_get_variables(const struct ConceptMap* concept_map) +---- + + + +Produces an ``Iterator`` over all variables in this ``ConceptMap``. + +[caption=""] +.Returns +`struct StringIterator*` + +[#_concept_map_group_drop] +==== concept_map_group_drop + +[source,cpp] +---- +void concept_map_group_drop(struct ConceptMapGroup* concept_map_group) +---- + + + +Frees the native rust ``ConceptMapGroup`` object + +[caption=""] +.Returns +`void` + +[#_concept_map_group_equals] +==== concept_map_group_equals + +[source,cpp] +---- +bool concept_map_group_equals(const struct ConceptMapGroup* lhs, const struct ConceptMapGroup* rhs) +---- + + + +Checks whether the provided ``ConceptMapGroup`` objects are equal + +[caption=""] +.Returns +`bool` + +[#_concept_map_group_get_concept_maps] +==== concept_map_group_get_concept_maps + +[source,cpp] +---- +struct ConceptMapIterator* concept_map_group_get_concept_maps(const struct ConceptMapGroup* concept_map_group) +---- + + + +Retrieves the ``ConceptMap``s of the group. + +[caption=""] +.Returns +`struct ConceptMapIterator*` + +[#_concept_map_group_get_owner] +==== concept_map_group_get_owner + +[source,cpp] +---- +struct Concept* concept_map_group_get_owner(const struct ConceptMapGroup* concept_map_group) +---- + + + +Retrieves the concept that is the group owner. + +[caption=""] +.Returns +`struct Concept*` + +[#_concept_map_group_iterator_drop] +==== concept_map_group_iterator_drop + +[source,cpp] +---- +void concept_map_group_iterator_drop(struct ConceptMapGroupIterator* it) +---- + + + +Frees the native rust ``ConceptMapGroupIterator`` object + +[caption=""] +.Returns +`void` + +[#_concept_map_group_iterator_next] +==== concept_map_group_iterator_next + +[source,cpp] +---- +struct ConceptMapGroup* concept_map_group_iterator_next(struct ConceptMapGroupIterator* it) +---- + + + +Forwards the ``ConceptMapGroupIterator`` and returns the next ``ConceptMapGroup`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct ConceptMapGroup*` + +[#_concept_map_group_to_string] +==== concept_map_group_to_string + +[source,cpp] +---- +char* concept_map_group_to_string(const struct ConceptMapGroup* concept_map_group) +---- + + + +A string representation of this ``ConceptMapGroup`` object + +[caption=""] +.Returns +`char*` + +[#_concept_map_iterator_drop] +==== concept_map_iterator_drop + +[source,cpp] +---- +void concept_map_iterator_drop(struct ConceptMapIterator* it) +---- + + + +Frees the native rust ``ConceptMapIterator`` object + +[caption=""] +.Returns +`void` + +[#_concept_map_iterator_next] +==== concept_map_iterator_next + +[source,cpp] +---- +struct ConceptMap* concept_map_iterator_next(struct ConceptMapIterator* it) +---- + + + +Forwards the ``ConceptMapIterator`` and returns the next ``ConceptMap`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct ConceptMap*` + +[#_concept_map_to_string] +==== concept_map_to_string + +[source,cpp] +---- +char* concept_map_to_string(const struct ConceptMap* concept_map) +---- + + + +A string representation of this ConceptMap. + +[caption=""] +.Returns +`char*` + diff --git a/c/docs/answer/explanation.adoc b/c/docs/answer/explanation.adoc new file mode 100644 index 0000000000..808daff67f --- /dev/null +++ b/c/docs/answer/explanation.adoc @@ -0,0 +1,386 @@ +[#_methods__answer__explanation] +=== explanation + +[#_Struct_Explainable] +==== Struct Explainable + + + +Contains an explainable object. + +[#_Struct_Explainables] +==== Struct Explainables + + + +Contains explainable objects. + +[#_explainable_drop] +==== explainable_drop + +[source,cpp] +---- +void explainable_drop(struct Explainable* explainable) +---- + + + +Frees the native rust ``Explainable`` object + +[caption=""] +.Returns +`void` + +[#_explainable_get_conjunction] +==== explainable_get_conjunction + +[source,cpp] +---- +char* explainable_get_conjunction(const struct Explainable* explainable) +---- + + + +Retrieves the subquery of the original query that is actually being explained. + +[caption=""] +.Returns +`char*` + +[#_explainable_get_id] +==== explainable_get_id + +[source,cpp] +---- +int64_t explainable_get_id(const struct Explainable* explainable) +---- + + + +Retrieves the unique ID that identifies this ``Explainable``. + +[caption=""] +.Returns +`int64_t` + +[#_explainables_drop] +==== explainables_drop + +[source,cpp] +---- +void explainables_drop(struct Explainables* explainables) +---- + + + +Frees the native rust ``Explainables`` object + +[caption=""] +.Returns +`void` + +[#_explainables_equals] +==== explainables_equals + +[source,cpp] +---- +bool explainables_equals(const struct Explainables* lhs, const struct Explainables* rhs) +---- + + + +Checks whether the provided ``Explainables`` objects are equal + +[caption=""] +.Returns +`bool` + +[#_explainables_get_attribute] +==== explainables_get_attribute + +[source,cpp] +---- +struct Explainable* explainables_get_attribute(const struct Explainables* explainables, const char* var) +---- + + + +Retrieves the explainable attribute with the given variable name. + +[caption=""] +.Returns +`struct Explainable*` + +[#_explainables_get_attributes_keys] +==== explainables_get_attributes_keys + +[source,cpp] +---- +struct StringIterator* explainables_get_attributes_keys(const struct Explainables* explainables) +---- + + + +Retrieves all variables corresponding to this ``ConceptMap``’s explainable attributes. + +[caption=""] +.Returns +`struct StringIterator*` + +[#_explainables_get_ownership] +==== explainables_get_ownership + +[source,cpp] +---- +struct Explainable* explainables_get_ownership(const struct Explainables* explainables, const char* owner, const char* attribute) +---- + + + +Retrieves the explainable attribute ownership with the pair of (owner, attribute) variable names. + +[caption=""] +.Returns +`struct Explainable*` + +[#_explainables_get_ownerships_keys] +==== explainables_get_ownerships_keys + +[source,cpp] +---- +struct StringPairIterator* explainables_get_ownerships_keys(const struct Explainables* explainables) +---- + + + +Retrieves all variables corresponding to this ``ConceptMap``’s explainable ownerships. + +[caption=""] +.Returns +`struct StringPairIterator*` + +[#_explainables_get_relation] +==== explainables_get_relation + +[source,cpp] +---- +struct Explainable* explainables_get_relation(const struct Explainables* explainables, const char* var) +---- + + + +Retrieves the explainable relation with the given variable name. + +[caption=""] +.Returns +`struct Explainable*` + +[#_explainables_get_relations_keys] +==== explainables_get_relations_keys + +[source,cpp] +---- +struct StringIterator* explainables_get_relations_keys(const struct Explainables* explainables) +---- + + + +Retrieves all variables corresponding to this ``ConceptMap``’s explainable relations. + +[caption=""] +.Returns +`struct StringIterator*` + +[#_explainables_to_string] +==== explainables_to_string + +[source,cpp] +---- +char* explainables_to_string(const struct Explainables* explainables) +---- + + + +A string representation of this ``Explainables`` object + +[caption=""] +.Returns +`char*` + +[#_methods__answer__explanation] +=== explanation + +[#_Struct_Explanation] +==== Struct Explanation + + + +An explanation of which rule was used for inferring the explained concept, the condition of the rule, the conclusion of the rule, and the mapping of variables between the query and the rule’s conclusion. + +[#_Struct_ExplanationIterator] +==== Struct ExplanationIterator + + + +Iterator over the ``Explanation``s in the result of the explain query. + +[#_explanation_drop] +==== explanation_drop + +[source,cpp] +---- +void explanation_drop(struct Explanation* explanation) +---- + + + +Frees the native rust ``Explanation`` object + +[caption=""] +.Returns +`void` + +[#_explanation_equals] +==== explanation_equals + +[source,cpp] +---- +bool explanation_equals(const struct Explanation* lhs, const struct Explanation* rhs) +---- + + + +Checks whether the provided ``Explanation`` objects are equal + +[caption=""] +.Returns +`bool` + +[#_explanation_get_conclusion] +==== explanation_get_conclusion + +[source,cpp] +---- +struct ConceptMap* explanation_get_conclusion(const struct Explanation* explanation) +---- + + + +Retrieves the Conclusion for this Explanation. + +[caption=""] +.Returns +`struct ConceptMap*` + +[#_explanation_get_condition] +==== explanation_get_condition + +[source,cpp] +---- +struct ConceptMap* explanation_get_condition(const struct Explanation* explanation) +---- + + + +Retrieves the Condition for this Explanation. + +[caption=""] +.Returns +`struct ConceptMap*` + +[#_explanation_get_mapped_variables] +==== explanation_get_mapped_variables + +[source,cpp] +---- +struct StringIterator* explanation_get_mapped_variables(const struct Explanation* explanation) +---- + + + +Retrieves the query variables for this ``Explanation``. + +[caption=""] +.Returns +`struct StringIterator*` + +[#_explanation_get_mapping] +==== explanation_get_mapping + +[source,cpp] +---- +struct StringIterator* explanation_get_mapping(const struct Explanation* explanation, const char* var) +---- + + + +Retrieves the rule variables corresponding to the query variable var for this ``Explanation``. + +[caption=""] +.Returns +`struct StringIterator*` + +[#_explanation_get_rule] +==== explanation_get_rule + +[source,cpp] +---- +struct Rule* explanation_get_rule(const struct Explanation* explanation) +---- + + + +Retrieves the Rule for this Explanation. + +[caption=""] +.Returns +`struct Rule*` + +[#_explanation_iterator_drop] +==== explanation_iterator_drop + +[source,cpp] +---- +void explanation_iterator_drop(struct ExplanationIterator* it) +---- + + + +Frees the native rust ``ExplanationIterator`` object + +[caption=""] +.Returns +`void` + +[#_explanation_iterator_next] +==== explanation_iterator_next + +[source,cpp] +---- +struct Explanation* explanation_iterator_next(struct ExplanationIterator* it) +---- + + + +Forwards the ``Explanation`` and returns the next ``Explanation`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct Explanation*` + +[#_explanation_to_string] +==== explanation_to_string + +[source,cpp] +---- +char* explanation_to_string(const struct Explanation* explanation) +---- + + + +A string representation of this ``Explanation`` object + +[caption=""] +.Returns +`char*` + diff --git a/c/docs/answer/primitives.adoc b/c/docs/answer/primitives.adoc new file mode 100644 index 0000000000..8ee02bd7f2 --- /dev/null +++ b/c/docs/answer/primitives.adoc @@ -0,0 +1,195 @@ +[#_methods__answer__primitives] +=== primitives + +[#_Struct_StringIterator] +==== Struct StringIterator + + + +Iterator over the strings in the result of a request or a TypeQL Fetch query. + +[#_Struct_StringPair] +==== Struct StringPair + + + +A ``StringPair`` used to represent the pair of variables involved in an ownership. ``_0`` and ``_1`` are the owner and attribute variables respectively. + +[#_Struct_StringPairIterator] +==== Struct StringPairIterator + + + +Iterator over the ``StringPair``s representing explainable owner-attribute variable pairs + +[#_Struct_StringPromise] +==== Struct StringPromise + + + +Promise object representing the result of an asynchronous operation. Use string_promise_resolve(StringPromise*) to wait for and retrieve the resulting string. + +[#_string_free] +==== string_free + +[source,cpp] +---- +void string_free(char* str) +---- + + + +Frees a native rust string. _WARNING: Always use this function to free strings returned by the driver. Using the standard C free function will create a dangling reference on the rust side._ + +[caption=""] +.Returns +`void` + +[#_string_iterator_drop] +==== string_iterator_drop + +[source,cpp] +---- +void string_iterator_drop(struct StringIterator* it) +---- + + + +Frees the native rust ``StringIterator`` object + +[caption=""] +.Returns +`void` + +[#_string_iterator_next] +==== string_iterator_next + +[source,cpp] +---- +char* string_iterator_next(struct StringIterator* it) +---- + + + +Forwards the ``StringIterator`` and returns the next string if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`char*` + +[#_string_pair_drop] +==== string_pair_drop + +[source,cpp] +---- +void string_pair_drop(struct StringPair* string_pair) +---- + + + +Frees the native rust ``StringPair`` object + +[caption=""] +.Returns +`void` + +[#_string_pair_iterator_drop] +==== string_pair_iterator_drop + +[source,cpp] +---- +void string_pair_iterator_drop(struct StringPairIterator* it) +---- + + + +Frees the native rust ``StringPairIterator`` object + +[caption=""] +.Returns +`void` + +[#_string_pair_iterator_next] +==== string_pair_iterator_next + +[source,cpp] +---- +struct StringPair* string_pair_iterator_next(struct StringPairIterator* it) +---- + + + +Forwards the ``StringIterator`` and returns the next ``StringPair`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct StringPair*` + +[#_string_promise_resolve] +==== string_promise_resolve + +[source,cpp] +---- +char* string_promise_resolve(struct StringPromise* promise) +---- + + + +Waits for and returns the result of the operation represented by the ``BoolPromise`` object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved. + +[caption=""] +.Returns +`char*` + +[#_methods__answer__primitives] +=== primitives + +[#_Struct_BoolPromise] +==== Struct BoolPromise + + + +Promise object representing the result of an asynchronous operation. Use bool_promise_resolve(BoolPromise*) to wait for and retrieve the resulting boolean value. + +[#_bool_promise_resolve] +==== bool_promise_resolve + +[source,cpp] +---- +bool bool_promise_resolve(struct BoolPromise* promise) +---- + + + +Waits for and returns the result of the operation represented by the ``BoolPromise`` object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved. + +[caption=""] +.Returns +`bool` + +[#_methods__answer__primitives] +=== primitives + +[#_Struct_VoidPromise] +==== Struct VoidPromise + + + +Promise object representing the result of an asynchronous operation. A VoidPromise does not return a value, but must be resolved using void_promise_resolve(VoidPromise*) to ensure the operation has completed, or for a failed operation to set the error. + +[#_void_promise_resolve] +==== void_promise_resolve + +[source,cpp] +---- +void void_promise_resolve(struct VoidPromise* promise) +---- + + + +Waits for the operation represented by the ``VoidPromise`` to complete. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved. + +[caption=""] +.Returns +`void` + diff --git a/c/docs/answer/valuegroup.adoc b/c/docs/answer/valuegroup.adoc new file mode 100644 index 0000000000..4a06fe5c91 --- /dev/null +++ b/c/docs/answer/valuegroup.adoc @@ -0,0 +1,129 @@ +[#_methods__answer__valuegroup] +=== valuegroup + +[#_Struct_ValueGroup] +==== Struct ValueGroup + + + +Contains an element of a TypeQL Get Group Aggregate query result. + +[#_Struct_ValueGroupIterator] +==== Struct ValueGroupIterator + + + +Iterator over the ``ValueGroup``s in the result of the Get Group Aggregate query. + +[#_value_group_drop] +==== value_group_drop + +[source,cpp] +---- +void value_group_drop(struct ValueGroup* value_group) +---- + + + +Frees the native rust ``ValueGroup`` object + +[caption=""] +.Returns +`void` + +[#_value_group_equals] +==== value_group_equals + +[source,cpp] +---- +bool value_group_equals(const struct ValueGroup* lhs, const struct ValueGroup* rhs) +---- + + + +Checks whether the provided ``ValueGroup`` objects are equal + +[caption=""] +.Returns +`bool` + +[#_value_group_get_owner] +==== value_group_get_owner + +[source,cpp] +---- +struct Concept* value_group_get_owner(struct ValueGroup* value_group) +---- + + + +Retrieves the concept that is the group owner. + +[caption=""] +.Returns +`struct Concept*` + +[#_value_group_get_value] +==== value_group_get_value + +[source,cpp] +---- +struct Concept* value_group_get_value(struct ValueGroup* value_group) +---- + + + +Retrieves the ``Value`` answer of the group. + +[caption=""] +.Returns +`struct Concept*` + +[#_value_group_iterator_drop] +==== value_group_iterator_drop + +[source,cpp] +---- +void value_group_iterator_drop(struct ValueGroupIterator* it) +---- + + + +Frees the native rust ``ValueGroupIterator`` object + +[caption=""] +.Returns +`void` + +[#_value_group_iterator_next] +==== value_group_iterator_next + +[source,cpp] +---- +struct ValueGroup* value_group_iterator_next(struct ValueGroupIterator* it) +---- + + + +Forwards the ``ValueGroupIterator`` and returns the next ``ValueGroup`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct ValueGroup*` + +[#_value_group_to_string] +==== value_group_to_string + +[source,cpp] +---- +char* value_group_to_string(const struct ValueGroup* value_group) +---- + + + +A string representation of this ``ValueGroup`` object + +[caption=""] +.Returns +`char*` + diff --git a/c/docs/concept/attribute.adoc b/c/docs/concept/attribute.adoc new file mode 100644 index 0000000000..ee1c0e181b --- /dev/null +++ b/c/docs/concept/attribute.adoc @@ -0,0 +1,51 @@ +[#_methods__concept__attribute] +=== attribute + +[#_attribute_get_owners] +==== attribute_get_owners + +[source,cpp] +---- +struct ConceptIterator* attribute_get_owners(struct Transaction* transaction, const struct Concept* attribute, const struct Concept* thing_type) +---- + + + +Retrieves the instances that own this ``Attribute``. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_attribute_get_type] +==== attribute_get_type + +[source,cpp] +---- +struct Concept* attribute_get_type(const struct Concept* attribute) +---- + + + +Retrieves the type which this ``Attribute`` belongs to. + +[caption=""] +.Returns +`struct Concept*` + +[#_attribute_get_value] +==== attribute_get_value + +[source,cpp] +---- +struct Concept* attribute_get_value(const struct Concept* attribute) +---- + + + +Retrieves the type which this ``Relation`` belongs to. + +[caption=""] +.Returns +`struct Concept*` + diff --git a/c/docs/concept/concept.adoc b/c/docs/concept/concept.adoc new file mode 100644 index 0000000000..4b78d05a35 --- /dev/null +++ b/c/docs/concept/concept.adoc @@ -0,0 +1,472 @@ +[#_methods__concept__concept] +=== concept + +[#_Struct_Concept] +==== Struct Concept + + + +The fundamental TypeQL object. A Concept is either a Type, Thing, or Value. To use subtype specific methods, the Concept must be of the expected subtype. + +[#_Struct_ConceptIterator] +==== Struct ConceptIterator + + + +Iterator over the ``Concepts``s returned by an API method or query. + +[#_Struct_ConceptPromise] +==== Struct ConceptPromise + + + +Promise object representing the result of an asynchronous operation. Use concept_promise_resolve(ConceptPromise*) to wait for and retrieve the resulting boolean value. + +[#_concept_drop] +==== concept_drop + +[source,cpp] +---- +void concept_drop(struct Concept* concept) +---- + + + +Frees the native rust ``Concept`` object + +[caption=""] +.Returns +`void` + +[#_concept_equals] +==== concept_equals + +[source,cpp] +---- +bool concept_equals(const struct Concept* lhs, const struct Concept* rhs) +---- + + + +Checks whether the provided ``Concept`` objects are equal + +[caption=""] +.Returns +`bool` + +[#_concept_is_attribute] +==== concept_is_attribute + +[source,cpp] +---- +bool concept_is_attribute(const struct Concept* concept) +---- + + + +Checks if the concept is an ``Attribute``. + +[caption=""] +.Returns +`bool` + +[#_concept_is_attribute_type] +==== concept_is_attribute_type + +[source,cpp] +---- +bool concept_is_attribute_type(const struct Concept* concept) +---- + + + +Checks if the concept is an ``AttributeType``. + +[caption=""] +.Returns +`bool` + +[#_concept_is_entity] +==== concept_is_entity + +[source,cpp] +---- +bool concept_is_entity(const struct Concept* concept) +---- + + + +Checks if the concept is an ``Entity``. + +[caption=""] +.Returns +`bool` + +[#_concept_is_entity_type] +==== concept_is_entity_type + +[source,cpp] +---- +bool concept_is_entity_type(const struct Concept* concept) +---- + + + +Checks if the concept is an ``EntityType``. + +[caption=""] +.Returns +`bool` + +[#_concept_is_relation] +==== concept_is_relation + +[source,cpp] +---- +bool concept_is_relation(const struct Concept* concept) +---- + + + +Checks if the concept is a ``Relation``. + +[caption=""] +.Returns +`bool` + +[#_concept_is_relation_type] +==== concept_is_relation_type + +[source,cpp] +---- +bool concept_is_relation_type(const struct Concept* concept) +---- + + + +Checks if the concept is a ``RelationType``. + +[caption=""] +.Returns +`bool` + +[#_concept_is_role_type] +==== concept_is_role_type + +[source,cpp] +---- +bool concept_is_role_type(const struct Concept* concept) +---- + + + +Checks if the concept is a ``RoleType``. + +[caption=""] +.Returns +`bool` + +[#_concept_is_root_thing_type] +==== concept_is_root_thing_type + +[source,cpp] +---- +bool concept_is_root_thing_type(const struct Concept* concept) +---- + + + +Checks if the concept is the root ``thing`` type. + +[caption=""] +.Returns +`bool` + +[#_concept_is_value] +==== concept_is_value + +[source,cpp] +---- +bool concept_is_value(const struct Concept* concept) +---- + + + +Checks if the concept is a ``Value``. + +[caption=""] +.Returns +`bool` + +[#_concept_iterator_drop] +==== concept_iterator_drop + +[source,cpp] +---- +void concept_iterator_drop(struct ConceptIterator* it) +---- + + + +Frees the native rust ``ConceptIterator`` object + +[caption=""] +.Returns +`void` + +[#_concept_iterator_next] +==== concept_iterator_next + +[source,cpp] +---- +struct Concept* concept_iterator_next(struct ConceptIterator* it) +---- + + + +Forwards the ``ConceptIterator`` and returns the next ``Concept`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct Concept*` + +[#_concept_promise_resolve] +==== concept_promise_resolve + +[source,cpp] +---- +struct Concept* concept_promise_resolve(struct ConceptPromise* promise) +---- + + + +Waits for and returns the result of the operation represented by the ``ConceptPromise`` object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved. + +[caption=""] +.Returns +`struct Concept*` + +[#_concept_to_string] +==== concept_to_string + +[source,cpp] +---- +char* concept_to_string(const struct Concept* concept) +---- + + + +A string representation of this ``Concept`` object + +[caption=""] +.Returns +`char*` + +[#_concepts_get_attribute] +==== concepts_get_attribute + +[source,cpp] +---- +struct ConceptPromise* concepts_get_attribute(const struct Transaction* transaction, const char* iid) +---- + + + +Retrieves an ``Attribute`` instance by its iid. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_concepts_get_attribute_type] +==== concepts_get_attribute_type + +[source,cpp] +---- +struct ConceptPromise* concepts_get_attribute_type(const struct Transaction* transaction, const char* label) +---- + + + +Retrieves an ``AttributeType`` by its label. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_concepts_get_entity] +==== concepts_get_entity + +[source,cpp] +---- +struct ConceptPromise* concepts_get_entity(const struct Transaction* transaction, const char* iid) +---- + + + +Retrieves an ``Entity`` instance by its iid. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_concepts_get_entity_type] +==== concepts_get_entity_type + +[source,cpp] +---- +struct ConceptPromise* concepts_get_entity_type(const struct Transaction* transaction, const char* label) +---- + + + +Retrieves an ``EntityType`` by its label. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_concepts_get_relation] +==== concepts_get_relation + +[source,cpp] +---- +struct ConceptPromise* concepts_get_relation(const struct Transaction* transaction, const char* iid) +---- + + + +Retrieves a ``relation`` instance by its iid. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_concepts_get_relation_type] +==== concepts_get_relation_type + +[source,cpp] +---- +struct ConceptPromise* concepts_get_relation_type(const struct Transaction* transaction, const char* label) +---- + + + +Retrieves a ``RelationType`` by its label. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_concepts_get_root_attribute_type] +==== concepts_get_root_attribute_type + +[source,cpp] +---- +struct Concept* concepts_get_root_attribute_type(void) +---- + + + +Retrieves the root ``AttributeType``, “attribute”. + +[caption=""] +.Returns +`struct Concept*` + +[#_concepts_get_root_entity_type] +==== concepts_get_root_entity_type + +[source,cpp] +---- +struct Concept* concepts_get_root_entity_type(void) +---- + + + +Retrieves the root ``EntityType``, “entity”. + +[caption=""] +.Returns +`struct Concept*` + +[#_concepts_get_root_relation_type] +==== concepts_get_root_relation_type + +[source,cpp] +---- +struct Concept* concepts_get_root_relation_type(void) +---- + + + +Retrieves the root ``RelationType``, “relation”. + +[caption=""] +.Returns +`struct Concept*` + +[#_concepts_get_schema_exceptions] +==== concepts_get_schema_exceptions + +[source,cpp] +---- +struct SchemaExceptionIterator* concepts_get_schema_exceptions(const struct Transaction* transaction) +---- + + + +Retrieves a list of all schema exceptions for the current transaction. + +[caption=""] +.Returns +`struct SchemaExceptionIterator*` + +[#_concepts_put_attribute_type] +==== concepts_put_attribute_type + +[source,cpp] +---- +struct ConceptPromise* concepts_put_attribute_type(const struct Transaction* transaction, const char* label, enum ValueType value_type) +---- + + + +Creates a new ``AttributeType`` if none exists with the given label, otherwise retrieves the existing one. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_concepts_put_entity_type] +==== concepts_put_entity_type + +[source,cpp] +---- +struct ConceptPromise* concepts_put_entity_type(const struct Transaction* transaction, const char* label) +---- + + + +Creates a new ``EntityType`` if none exists with the given label, otherwise retrieves the existing one. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_concepts_put_relation_type] +==== concepts_put_relation_type + +[source,cpp] +---- +struct ConceptPromise* concepts_put_relation_type(const struct Transaction* transaction, const char* label) +---- + + + +Creates a new ``RelationType`` if none exists with the given label, otherwise retrieves the existing one. + +[caption=""] +.Returns +`struct ConceptPromise*` + diff --git a/c/docs/concept/entity.adoc b/c/docs/concept/entity.adoc new file mode 100644 index 0000000000..459987d90c --- /dev/null +++ b/c/docs/concept/entity.adoc @@ -0,0 +1,19 @@ +[#_methods__concept__entity] +=== entity + +[#_entity_get_type] +==== entity_get_type + +[source,cpp] +---- +struct Concept* entity_get_type(const struct Concept* entity) +---- + + + +Retrieves the type which this ``Entity`` belongs to. + +[caption=""] +.Returns +`struct Concept*` + diff --git a/c/docs/concept/relation.adoc b/c/docs/concept/relation.adoc new file mode 100644 index 0000000000..c040ecc73c --- /dev/null +++ b/c/docs/concept/relation.adoc @@ -0,0 +1,109 @@ +[#_methods__concept__relation] +=== relation + +[#_relation_add_role_player] +==== relation_add_role_player + +[source,cpp] +---- +struct VoidPromise* relation_add_role_player(struct Transaction* transaction, struct Concept* relation, const struct Concept* role_type, const struct Concept* player) +---- + + + +Adds a new role player to play the given role in this ``Relation``. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_relation_get_players_by_role_type] +==== relation_get_players_by_role_type + +[source,cpp] +---- +struct ConceptIterator* relation_get_players_by_role_type(struct Transaction* transaction, const struct Concept* relation, const struct Concept*const* role_types) +---- + + + +Retrieves all role players of this ``Relation``, optionally filtered by given role types. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `role_types` a| a null-terminated array of ``RoleType``s to include. a| `const struct Concept*const*` +|=== + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_relation_get_relating] +==== relation_get_relating + +[source,cpp] +---- +struct ConceptIterator* relation_get_relating(struct Transaction* transaction, const struct Concept* relation) +---- + + + +Retrieves all role types currently played in this ``Relation``. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_relation_get_role_players] +==== relation_get_role_players + +[source,cpp] +---- +struct RolePlayerIterator* relation_get_role_players(struct Transaction* transaction, const struct Concept* relation) +---- + + + +Retrieves all instance involved in the ``Relation``, each paired with the role it plays. + +[caption=""] +.Returns +`struct RolePlayerIterator*` + +[#_relation_get_type] +==== relation_get_type + +[source,cpp] +---- +struct Concept* relation_get_type(const struct Concept* relation) +---- + + + +Retrieves the type which this ``Relation`` belongs to. + +[caption=""] +.Returns +`struct Concept*` + +[#_relation_remove_role_player] +==== relation_remove_role_player + +[source,cpp] +---- +struct VoidPromise* relation_remove_role_player(struct Transaction* transaction, struct Concept* relation, const struct Concept* role_type, const struct Concept* player) +---- + + + +Removes the association of the given instance that plays the given role in this ``Relation``. + +[caption=""] +.Returns +`struct VoidPromise*` + diff --git a/c/docs/concept/roleplayer.adoc b/c/docs/concept/roleplayer.adoc new file mode 100644 index 0000000000..a0347b9eb7 --- /dev/null +++ b/c/docs/concept/roleplayer.adoc @@ -0,0 +1,97 @@ +[#_methods__concept__roleplayer] +=== roleplayer + +[#_Struct_RolePlayer] +==== Struct RolePlayer + + + +A pair representing the concept and the role it plays in a relation. The result of relation_get_role_players(Transaction*, Concept*) + +[#_Struct_RolePlayerIterator] +==== Struct RolePlayerIterator + + + +An iterator over ``RolePlayer`` pairs returned by relation_get_role_players(Transaction*, Concept*) + +[#_role_player_drop] +==== role_player_drop + +[source,cpp] +---- +void role_player_drop(struct RolePlayer* role_player) +---- + + + +Frees the native rust ``RolePlayer`` object + +[caption=""] +.Returns +`void` + +[#_role_player_get_player] +==== role_player_get_player + +[source,cpp] +---- +struct Concept* role_player_get_player(const struct RolePlayer* role_player) +---- + + + +Returns the ``Concept`` which plays the role in the ``RolePlayer`` + +[caption=""] +.Returns +`struct Concept*` + +[#_role_player_get_role_type] +==== role_player_get_role_type + +[source,cpp] +---- +struct Concept* role_player_get_role_type(const struct RolePlayer* role_player) +---- + + + +Returns the role-type played by the ``RolePlayer`` + +[caption=""] +.Returns +`struct Concept*` + +[#_role_player_iterator_drop] +==== role_player_iterator_drop + +[source,cpp] +---- +void role_player_iterator_drop(struct RolePlayerIterator* it) +---- + + + +Frees the native rust ``RolePlayerIterator`` object + +[caption=""] +.Returns +`void` + +[#_role_player_iterator_next] +==== role_player_iterator_next + +[source,cpp] +---- +struct RolePlayer* role_player_iterator_next(struct RolePlayerIterator* it) +---- + + + +Forwards the ``RolePlayerIterator`` and returns the next ``RolePlayer`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct RolePlayer*` + diff --git a/c/docs/concept/thing.adoc b/c/docs/concept/thing.adoc new file mode 100644 index 0000000000..8164aac173 --- /dev/null +++ b/c/docs/concept/thing.adoc @@ -0,0 +1,466 @@ +[#_methods__concept__thing] +=== thing + +[#_thing_delete] +==== thing_delete + +[source,cpp] +---- +struct VoidPromise* thing_delete(struct Transaction* transaction, struct Concept* thing) +---- + + + +Deletes this ``Thing``. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_thing_get_has] +==== thing_get_has + +[source,cpp] +---- +struct ConceptIterator* thing_get_has(struct Transaction* transaction, const struct Concept* thing, const struct Concept*const* attribute_types, const struct Annotation*const* annotations) +---- + + + +Retrieves the ``Attribute``s that this ``Thing`` owns, optionally filtered by ``AttributeType``s. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| `struct Transaction*` +a| `thing` a| The thing to get owned attributes of a| `const struct Concept*` +a| `attribute_types` a| a null-terminated array holding the attribute-types to include a| `const struct Concept*const*` +a| `annotations` a| a null-terminated array of annotations - If non-empty, Only retrieves attributes with all given ``Annotation``s a| `const struct Annotation*const*` +|=== + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_thing_get_iid] +==== thing_get_iid + +[source,cpp] +---- +char* thing_get_iid(struct Concept* thing) +---- + + + +Retrieves the unique id of the ``Thing``. + +[caption=""] +.Returns +`char*` + +[#_thing_get_is_inferred] +==== thing_get_is_inferred + +[source,cpp] +---- +bool thing_get_is_inferred(struct Concept* thing) +---- + + + +Checks if this ``Thing`` is inferred by a [Reasoning Rule]. + +[caption=""] +.Returns +`bool` + +[#_thing_get_playing] +==== thing_get_playing + +[source,cpp] +---- +struct ConceptIterator* thing_get_playing(struct Transaction* transaction, const struct Concept* thing) +---- + + + +Retrieves the roles that this ``Thing`` is currently playing. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_thing_get_relations] +==== thing_get_relations + +[source,cpp] +---- +struct ConceptIterator* thing_get_relations(struct Transaction* transaction, const struct Concept* thing, const struct Concept*const* role_types) +---- + + + +Retrieves all the ``Relations`` which this ``Thing`` plays a role in, optionally filtered by one or more given roles. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `role_types` a| a null-terminated array of ``RoleType``s to include. a| `const struct Concept*const*` +|=== + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_thing_is_deleted] +==== thing_is_deleted + +[source,cpp] +---- +struct BoolPromise* thing_is_deleted(struct Transaction* transaction, const struct Concept* thing) +---- + + + +Checks if this ``Thing`` is deleted. + +[caption=""] +.Returns +`struct BoolPromise*` + +[#_thing_set_has] +==== thing_set_has + +[source,cpp] +---- +struct VoidPromise* thing_set_has(struct Transaction* transaction, struct Concept* thing, const struct Concept* attribute) +---- + + + +Assigns an ``Attribute`` to be owned by this ``Thing``. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_thing_type_delete] +==== thing_type_delete + +[source,cpp] +---- +struct VoidPromise* thing_type_delete(const struct Transaction* transaction, struct Concept* thing_type) +---- + + + +Deletes this thing type from the database. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_thing_type_get_label] +==== thing_type_get_label + +[source,cpp] +---- +char* thing_type_get_label(const struct Concept* thing_type) +---- + + + +Retrieves the unique label of the thing type. + +[caption=""] +.Returns +`char*` + +[#_thing_type_get_owns] +==== thing_type_get_owns + +[source,cpp] +---- +struct ConceptIterator* thing_type_get_owns(const struct Transaction* transaction, const struct Concept* thing_type, const enum ValueType* value_type, enum Transitivity transitivity, const struct Annotation*const* annotations) +---- + + + +Retrieves ``AttributeType`` that the instances of this ``ThingType`` are allowed to own directly or via inheritance. Specify ``Explicit`` to only include directly owned types, or ``Transitive`` to include inherited + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `annotations` a| a null-terminated array of ``Annotation``s - If non-empty, Only retrieves attribute types owned with all specified annotations. a| `const struct Annotation*const*` +|=== + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_thing_type_get_owns_overridden] +==== thing_type_get_owns_overridden + +[source,cpp] +---- +struct ConceptPromise* thing_type_get_owns_overridden(const struct Transaction* transaction, const struct Concept* thing_type, const struct Concept* overridden_attribute_type) +---- + + + +Retrieves the ``AttributeType``, ownership of which is overridden for this ``ThingType`` by the specified ``AttributeType``. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_thing_type_get_plays] +==== thing_type_get_plays + +[source,cpp] +---- +struct ConceptIterator* thing_type_get_plays(const struct Transaction* transaction, const struct Concept* thing_type, enum Transitivity transitivity) +---- + + + +Retrieves all direct and inherited (or direct only) roles that are allowed to be played by the instances of this ``ThingType``. Specify ``Transitive`` for direct and inherited roles, Or ``Explicit`` for directly played roles only. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_thing_type_get_plays_overridden] +==== thing_type_get_plays_overridden + +[source,cpp] +---- +struct ConceptPromise* thing_type_get_plays_overridden(const struct Transaction* transaction, const struct Concept* thing_type, const struct Concept* overridden_role_type) +---- + + + +Retrieves the ``RoleType`` that is overridden by the given ``RoleType`` for this ``ThingType``. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_thing_type_get_syntax] +==== thing_type_get_syntax + +[source,cpp] +---- +struct StringPromise* thing_type_get_syntax(const struct Transaction* transaction, const struct Concept* thing_type) +---- + + + +Produces a TypeQL pattern for creating this ``ThingType`` in a ``define`` query. + +[caption=""] +.Returns +`struct StringPromise*` + +[#_thing_type_is_abstract] +==== thing_type_is_abstract + +[source,cpp] +---- +bool thing_type_is_abstract(const struct Concept* thing_type) +---- + + + +Checks if this thing type is prevented from having data instances (i.e., abstract). + +[caption=""] +.Returns +`bool` + +[#_thing_type_is_deleted] +==== thing_type_is_deleted + +[source,cpp] +---- +struct BoolPromise* thing_type_is_deleted(const struct Transaction* transaction, const struct Concept* thing_type) +---- + + + +Checks if the thing type has been deleted + +[caption=""] +.Returns +`struct BoolPromise*` + +[#_thing_type_is_root] +==== thing_type_is_root + +[source,cpp] +---- +bool thing_type_is_root(const struct Concept* thing_type) +---- + + + +Checks if this type is a root type (""entity"", ""relation"", ""attribute"") + +[caption=""] +.Returns +`bool` + +[#_thing_type_set_abstract] +==== thing_type_set_abstract + +[source,cpp] +---- +struct VoidPromise* thing_type_set_abstract(const struct Transaction* transaction, struct Concept* thing_type) +---- + + + +Set a ``ThingType`` to be abstract, meaning it cannot have instances. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_thing_type_set_label] +==== thing_type_set_label + +[source,cpp] +---- +struct VoidPromise* thing_type_set_label(const struct Transaction* transaction, struct Concept* thing_type, const char* new_label) +---- + + + +Renames the label of the type. The new label must remain unique. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_thing_type_set_owns] +==== thing_type_set_owns + +[source,cpp] +---- +struct VoidPromise* thing_type_set_owns(const struct Transaction* transaction, struct Concept* thing_type, const struct Concept* attribute_type, const struct Concept* overridden_attribute_type, const struct Annotation*const* annotations) +---- + + + +Allows the instances of this ``ThingType`` to own the given ``AttributeType``. Optionally, overriding a previously declared ownership. With the specified annotations to the ownership. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `transaction` a| The current transaction a| `const struct Transaction*` +a| `thing_type` a| The thing type which is to own the specified attribute a| `struct Concept*` +a| `attribute_type` a| The attribute type which is to be owned by the specified thing type a| `const struct Concept*` +a| `overridden_attribute_type` a| Optional, The attribute whose ownership must be overridden a| `const struct Concept*` +a| `annotations` a| A null-terminated array of ``Annotation``s to be added to the ownership a| `const struct Annotation*const*` +|=== + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_thing_type_set_plays] +==== thing_type_set_plays + +[source,cpp] +---- +struct VoidPromise* thing_type_set_plays(struct Transaction* transaction, struct Concept* thing_type, const struct Concept* role_type, const struct Concept* overridden_role_type) +---- + + + +Allows the instances of this ``ThingType`` to play the given role. Optionally, overriding the existing ability to play a role. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_thing_type_unset_abstract] +==== thing_type_unset_abstract + +[source,cpp] +---- +struct VoidPromise* thing_type_unset_abstract(const struct Transaction* transaction, struct Concept* thing_type) +---- + + + +Set a ``ThingType`` to be non-abstract, meaning it can have instances. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_thing_type_unset_owns] +==== thing_type_unset_owns + +[source,cpp] +---- +struct VoidPromise* thing_type_unset_owns(const struct Transaction* transaction, struct Concept* thing_type, const struct Concept* attribute_type) +---- + + + +Disallows the instances of this ``ThingType`` from owning the given ``AttributeType``. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_thing_type_unset_plays] +==== thing_type_unset_plays + +[source,cpp] +---- +struct VoidPromise* thing_type_unset_plays(const struct Transaction* transaction, struct Concept* thing_type, const struct Concept* role_type) +---- + + + +Disallows the instances of this ``ThingType`` from playing the given role. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_thing_unset_has] +==== thing_unset_has + +[source,cpp] +---- +struct VoidPromise* thing_unset_has(struct Transaction* transaction, struct Concept* thing, const struct Concept* attribute) +---- + + + +Unassigns an ``Attribute`` from this ``Thing``. + +[caption=""] +.Returns +`struct VoidPromise*` + diff --git a/c/docs/concept/value.adoc b/c/docs/concept/value.adoc new file mode 100644 index 0000000000..d7144cfe4e --- /dev/null +++ b/c/docs/concept/value.adoc @@ -0,0 +1,243 @@ +[#_methods__concept__value] +=== value + +[#_value_get_boolean] +==== value_get_boolean + +[source,cpp] +---- +bool value_get_boolean(const struct Concept* value) +---- + + + +Returns a ``boolean`` value of this value concept. If the value has another type, the error is set. + +[caption=""] +.Returns +`bool` + +[#_value_get_date_time_as_millis] +==== value_get_date_time_as_millis + +[source,cpp] +---- +int64_t value_get_date_time_as_millis(const struct Concept* value) +---- + + + +Returns the value of this datetime value concept as milliseconds since the start of the UNIX epoch. If the value has another type, the error is set. + +[caption=""] +.Returns +`int64_t` + +[#_value_get_double] +==== value_get_double + +[source,cpp] +---- +double value_get_double(const struct Concept* value) +---- + + + +Returns the ``double`` value of this value concept. If the value has another type, the error is set. + +[caption=""] +.Returns +`double` + +[#_value_get_long] +==== value_get_long + +[source,cpp] +---- +int64_t value_get_long(const struct Concept* value) +---- + + + +Returns the ``long`` value of this value concept. If the value has another type, the error is set. + +[caption=""] +.Returns +`int64_t` + +[#_value_get_string] +==== value_get_string + +[source,cpp] +---- +char* value_get_string(const struct Concept* value) +---- + + + +Returns the ``string`` value of this value concept. If the value has another type, the error is set. + +[caption=""] +.Returns +`char*` + +[#_value_is_boolean] +==== value_is_boolean + +[source,cpp] +---- +bool value_is_boolean(const struct Concept* value) +---- + + + +Returns ``true`` if the value which this ``Value`` concept holds is of type ``boolean``. Otherwise, returns ``false``. + +[caption=""] +.Returns +`bool` + +[#_value_is_date_time] +==== value_is_date_time + +[source,cpp] +---- +bool value_is_date_time(const struct Concept* value) +---- + + + +Returns ``true`` if the value which this ``Value`` concept holds is of type ``datetime``. Otherwise, returns ``false``. + +[caption=""] +.Returns +`bool` + +[#_value_is_double] +==== value_is_double + +[source,cpp] +---- +bool value_is_double(const struct Concept* value) +---- + + + +Returns ``true`` if the value which this ``Value`` concept holds is of type ``double``. Otherwise, returns ``false``. + +[caption=""] +.Returns +`bool` + +[#_value_is_long] +==== value_is_long + +[source,cpp] +---- +bool value_is_long(const struct Concept* value) +---- + + + +Returns ``true`` if the value which this ``Value`` concept holds is of type ``long``. Otherwise, returns ``false``. + +[caption=""] +.Returns +`bool` + +[#_value_is_string] +==== value_is_string + +[source,cpp] +---- +bool value_is_string(const struct Concept* value) +---- + + + +Returns ``true`` if the value which this ``Value`` concept holds is of type ``string``. Otherwise, returns ``false``. + +[caption=""] +.Returns +`bool` + +[#_value_new_boolean] +==== value_new_boolean + +[source,cpp] +---- +struct Concept* value_new_boolean(bool bool_) +---- + + + +Creates a new ``Value`` object of the specified boolean value. + +[caption=""] +.Returns +`struct Concept*` + +[#_value_new_date_time_from_millis] +==== value_new_date_time_from_millis + +[source,cpp] +---- +struct Concept* value_new_date_time_from_millis(int64_t millis) +---- + + + +Creates a new ``Value`` object of the specified datetime value. + +[caption=""] +.Returns +`struct Concept*` + +[#_value_new_double] +==== value_new_double + +[source,cpp] +---- +struct Concept* value_new_double(double double_) +---- + + + +Creates a new ``Value`` object of the specified double value. + +[caption=""] +.Returns +`struct Concept*` + +[#_value_new_long] +==== value_new_long + +[source,cpp] +---- +struct Concept* value_new_long(int64_t long_) +---- + + + +Creates a new ``Value`` object of the specified long value. + +[caption=""] +.Returns +`struct Concept*` + +[#_value_new_string] +==== value_new_string + +[source,cpp] +---- +struct Concept* value_new_string(const char* string) +---- + + + +Creates a new ``Value`` object of the specified string value. + +[caption=""] +.Returns +`struct Concept*` + diff --git a/c/docs/connection/connection.adoc b/c/docs/connection/connection.adoc new file mode 100644 index 0000000000..4536233ae9 --- /dev/null +++ b/c/docs/connection/connection.adoc @@ -0,0 +1,130 @@ +[#_methods__connection__connection] +=== connection + +[#_init_logging] +==== init_logging + +[source,cpp] +---- +void init_logging(void) +---- + + + +Enables logging in the TypeDB driver. + +[caption=""] +.Returns +`void` + +[#_methods__connection__connection] +=== connection + +[#_Struct_Connection] +==== Struct Connection + + + +A connection to a TypeDB server which serves as the starting point for all interaction. + +[#_connection_close] +==== connection_close + +[source,cpp] +---- +void connection_close(struct Connection* connection) +---- + + + +Closes the driver. Before instantiating a new driver, the driver that’s currently open should first be closed. Closing a connction frees the underlying rust object. + +[caption=""] +.Returns +`void` + +[#_connection_force_close] +==== connection_force_close + +[source,cpp] +---- +void connection_force_close(struct Connection* connection) +---- + + + +Forcibly closes the driver. To be used in exceptional cases. + +[caption=""] +.Returns +`void` + +[#_connection_is_open] +==== connection_is_open + +[source,cpp] +---- +bool connection_is_open(const struct Connection* connection) +---- + + + +Checks whether this connection is presently open. + +[caption=""] +.Returns +`bool` + +[#_connection_open_cloud] +==== connection_open_cloud + +[source,cpp] +---- +struct Connection* connection_open_cloud(const char*const* addresses, const struct Credential* credential) +---- + + + +Open a TypeDB Driver to TypeDB Cloud server(s) available at the provided addresses, using the provided credential. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `addresses` a| a null-terminated array holding the address(es) of the TypeDB server(s) a| `const char*const*` +a| `credential` a| The ``Credential`` to connect with a| `const struct Credential*` +|=== + +[caption=""] +.Returns +`struct Connection*` + +[#_connection_open_core] +==== connection_open_core + +[source,cpp] +---- +struct Connection* connection_open_core(const char* address) +---- + + + +Open a TypeDB Driver to a TypeDB Core server available at the provided address. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `address` a| The address of the TypeDB server a| `const char*` +|=== + +[caption=""] +.Returns +`struct Connection*` + diff --git a/c/docs/connection/credential.adoc b/c/docs/connection/credential.adoc new file mode 100644 index 0000000000..a3dfd08123 --- /dev/null +++ b/c/docs/connection/credential.adoc @@ -0,0 +1,55 @@ +[#_methods__connection__credential] +=== credential + +[#_Struct_Credential] +==== Struct Credential + + + +User credentials and TLS encryption settings for connecting to TypeDB Cloud. + +[#_credential_drop] +==== credential_drop + +[source,cpp] +---- +void credential_drop(struct Credential* credential) +---- + + + +Frees the native rust ``Credential`` object + +[caption=""] +.Returns +`void` + +[#_credential_new] +==== credential_new + +[source,cpp] +---- +struct Credential* credential_new(const char* username, const char* password, const char* tls_root_ca, bool with_tls) +---- + + + +Creates a new ``Credential`` for connecting to TypeDB Cloud. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `username` a| The name of the user to connect as a| `const char*` +a| `password` a| The password for the user a| `const char*` +a| `tls_root_ca` a| Path to the CA certificate to use for authenticating server certificates. a| `const char*` +a| `with_tls` a| Specify whether the connection to TypeDB Cloud must be done over TLS a| `bool` +|=== + +[caption=""] +.Returns +`struct Credential*` + diff --git a/c/docs/connection/database.adoc b/c/docs/connection/database.adoc new file mode 100644 index 0000000000..e8ef2b9f6e --- /dev/null +++ b/c/docs/connection/database.adoc @@ -0,0 +1,296 @@ +[#_methods__connection__database] +=== database + +[#_Struct_Database] +==== Struct Database + + + +A TypeDB database + +[#_Struct_DatabaseIterator] +==== Struct DatabaseIterator + + + +An ``Iterator`` over databases present on the TypeDB server + +[#_Struct_DatabaseManager] +==== Struct DatabaseManager + + + +Provides access to all database management methods. + +[#_database_close] +==== database_close + +[source,cpp] +---- +void database_close(struct Database* database) +---- + + + +Frees the native rust ``Database`` object + +[caption=""] +.Returns +`void` + +[#_database_delete] +==== database_delete + +[source,cpp] +---- +void database_delete(struct Database* database) +---- + + + +Deletes this database. + +[caption=""] +.Returns +`void` + +[#_database_get_name] +==== database_get_name + +[source,cpp] +---- +char* database_get_name(const struct Database* database) +---- + + + +The database name as a string. + +[caption=""] +.Returns +`char*` + +[#_database_get_preferred_replica_info] +==== database_get_preferred_replica_info + +[source,cpp] +---- +struct ReplicaInfo* database_get_preferred_replica_info(const struct Database* database) +---- + + + +Returns the preferred replica for this database. Operations which can be run on any replica will prefer to use this replica. _Only works in TypeDB Cloud_ + +[caption=""] +.Returns +`struct ReplicaInfo*` + +[#_database_get_primary_replica_info] +==== database_get_primary_replica_info + +[source,cpp] +---- +struct ReplicaInfo* database_get_primary_replica_info(const struct Database* database) +---- + + + +Returns the primary replica for this database. _Only works in TypeDB Cloud_ + +[caption=""] +.Returns +`struct ReplicaInfo*` + +[#_database_get_replicas_info] +==== database_get_replicas_info + +[source,cpp] +---- +struct ReplicaInfoIterator* database_get_replicas_info(const struct Database* database) +---- + + + +Set of ``Replica`` instances for this database. Only works in TypeDB Cloud + +[caption=""] +.Returns +`struct ReplicaInfoIterator*` + +[#_database_iterator_drop] +==== database_iterator_drop + +[source,cpp] +---- +void database_iterator_drop(struct DatabaseIterator* it) +---- + + + +Frees the native rust ``DatabaseIterator`` object + +[caption=""] +.Returns +`void` + +[#_database_iterator_next] +==== database_iterator_next + +[source,cpp] +---- +struct Database* database_iterator_next(struct DatabaseIterator* it) +---- + + + +Forwards the ``DatabaseIterator`` and returns the next ``Database`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct Database*` + +[#_database_manager_drop] +==== database_manager_drop + +[source,cpp] +---- +void database_manager_drop(struct DatabaseManager* databases) +---- + + + +Frees the native rust ``DatabaseManager`` object + +[caption=""] +.Returns +`void` + +[#_database_manager_new] +==== database_manager_new + +[source,cpp] +---- +struct DatabaseManager* database_manager_new(const struct Connection* connection) +---- + + + +Creates and returns a native ``DatabaseManager`` for the connection + +[caption=""] +.Returns +`struct DatabaseManager*` + +[#_database_rule_schema] +==== database_rule_schema + +[source,cpp] +---- +char* database_rule_schema(struct Database* database) +---- + + + +The rules in the schema as a valid TypeQL define query string. + +[caption=""] +.Returns +`char*` + +[#_database_schema] +==== database_schema + +[source,cpp] +---- +char* database_schema(struct Database* database) +---- + + + +A full schema text as a valid TypeQL define query string. + +[caption=""] +.Returns +`char*` + +[#_database_type_schema] +==== database_type_schema + +[source,cpp] +---- +char* database_type_schema(struct Database* database) +---- + + + +The types in the schema as a valid TypeQL define query string. + +[caption=""] +.Returns +`char*` + +[#_databases_all] +==== databases_all + +[source,cpp] +---- +struct DatabaseIterator* databases_all(struct DatabaseManager* databases) +---- + + + +Returns a ``DatabaseIterator`` over all databases present on the TypeDB server + +[caption=""] +.Returns +`struct DatabaseIterator*` + +[#_databases_contains] +==== databases_contains + +[source,cpp] +---- +bool databases_contains(struct DatabaseManager* databases, const char* name) +---- + + + +Checks if a database with the given name exists + +[caption=""] +.Returns +`bool` + +[#_databases_create] +==== databases_create + +[source,cpp] +---- +void databases_create(struct DatabaseManager* databases, const char* name) +---- + + + +Create a database with the given name + +[caption=""] +.Returns +`void` + +[#_databases_get] +==== databases_get + +[source,cpp] +---- +struct Database* databases_get(struct DatabaseManager* databases, const char* name) +---- + + + +Retrieve the database with the given name. + +[caption=""] +.Returns +`struct Database*` + diff --git a/c/docs/connection/replica.adoc b/c/docs/connection/replica.adoc new file mode 100644 index 0000000000..77cedf593f --- /dev/null +++ b/c/docs/connection/replica.adoc @@ -0,0 +1,129 @@ +[#_methods__connection__replica] +=== replica + +[#_Struct_ReplicaInfo] +==== Struct ReplicaInfo + + + +The metadata and state of an individual raft replica of a database. + +[#_Struct_ReplicaInfoIterator] +==== Struct ReplicaInfoIterator + + + +Iterator over the ``ReplicaInfo`` corresponding to each replica of a TypeDB cloud database. + +[#_replica_info_drop] +==== replica_info_drop + +[source,cpp] +---- +void replica_info_drop(struct ReplicaInfo* replica_info) +---- + + + +Frees the native rust ``ReplicaInfo`` object + +[caption=""] +.Returns +`void` + +[#_replica_info_get_address] +==== replica_info_get_address + +[source,cpp] +---- +char* replica_info_get_address(const struct ReplicaInfo* replica_info) +---- + + + +Retrieves the address of the server hosting this replica + +[caption=""] +.Returns +`char*` + +[#_replica_info_get_term] +==== replica_info_get_term + +[source,cpp] +---- +int64_t replica_info_get_term(const struct ReplicaInfo* replica_info) +---- + + + +The raft protocol ‘term’ of this replica. + +[caption=""] +.Returns +`int64_t` + +[#_replica_info_is_preferred] +==== replica_info_is_preferred + +[source,cpp] +---- +bool replica_info_is_preferred(const struct ReplicaInfo* replica_info) +---- + + + +Checks whether this is the preferred replica of the raft cluster. If true, Operations which can be run on any replica will prefer to use this replica. + +[caption=""] +.Returns +`bool` + +[#_replica_info_is_primary] +==== replica_info_is_primary + +[source,cpp] +---- +bool replica_info_is_primary(const struct ReplicaInfo* replica_info) +---- + + + +Checks whether this is the primary replica of the raft cluster. + +[caption=""] +.Returns +`bool` + +[#_replica_info_iterator_drop] +==== replica_info_iterator_drop + +[source,cpp] +---- +void replica_info_iterator_drop(struct ReplicaInfoIterator* it) +---- + + + +Frees the native rust ``ReplicaInfoIterator`` object + +[caption=""] +.Returns +`void` + +[#_replica_info_iterator_next] +==== replica_info_iterator_next + +[source,cpp] +---- +struct ReplicaInfo* replica_info_iterator_next(struct ReplicaInfoIterator* it) +---- + + + +Forwards the ``ReplicaInfoIterator`` and returns the next ``ReplicaInfo`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct ReplicaInfo*` + diff --git a/c/docs/connection/user.adoc b/c/docs/connection/user.adoc new file mode 100644 index 0000000000..a295fb0546 --- /dev/null +++ b/c/docs/connection/user.adoc @@ -0,0 +1,289 @@ +[#_methods__connection__user] +=== user + +[#_Struct_User] +==== Struct User + + + +User information + +[#_Struct_UserIterator] +==== Struct UserIterator + + + +Iterator over a set of ``User``s + +[#_Struct_UserManager] +==== Struct UserManager + + + +Provides access to all user management methods. + +[#_user_drop] +==== user_drop + +[source,cpp] +---- +void user_drop(struct User* user) +---- + + + +Frees the native rust ``User`` object. + +[caption=""] +.Returns +`void` + +[#_user_get_password_expiry_seconds] +==== user_get_password_expiry_seconds + +[source,cpp] +---- +int64_t user_get_password_expiry_seconds(struct User* user) +---- + + + +Returns the number of seconds remaining till this user’s current password expires. + +[caption=""] +.Returns +`int64_t` + +[#_user_get_username] +==== user_get_username + +[source,cpp] +---- +char* user_get_username(struct User* user) +---- + + + +Returns the name of this user. + +[caption=""] +.Returns +`char*` + +[#_user_iterator_drop] +==== user_iterator_drop + +[source,cpp] +---- +void user_iterator_drop(struct UserIterator* it) +---- + + + +Frees the native rust ``UserIterator`` object + +[caption=""] +.Returns +`void` + +[#_user_iterator_next] +==== user_iterator_next + +[source,cpp] +---- +struct User* user_iterator_next(struct UserIterator* it) +---- + + + +Forwards the ``UserIterator`` and returns the next ``User`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct User*` + +[#_user_manager_drop] +==== user_manager_drop + +[source,cpp] +---- +void user_manager_drop(struct UserManager* user_manager) +---- + + + +Frees the native rust ``UserManager`` object + +[caption=""] +.Returns +`void` + +[#_user_manager_new] +==== user_manager_new + +[source,cpp] +---- +struct UserManager* user_manager_new(const struct Connection* connection) +---- + + + +Creates a ``UserManager`` on the specified connection + +[caption=""] +.Returns +`struct UserManager*` + +[#_user_password_update] +==== user_password_update + +[source,cpp] +---- +void user_password_update(struct User* user, const struct UserManager* user_manager, const char* password_old, const char* password_new) +---- + + + +Updates the password for the current authenticated user. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `user` a| The user to update the password of - must be the current user. a| `struct User*` +a| `user_manager` a| The ``UserManager`` object on this connection. a| `const struct UserManager*` +a| `password_old` a| The current password of this user a| `const char*` +a| `password_new` a| The new password a| `const char*` +|=== + +[caption=""] +.Returns +`void` + +[#_users_all] +==== users_all + +[source,cpp] +---- +struct UserIterator* users_all(const struct UserManager* user_manager) +---- + + + +Retrieves all users which exist on the TypeDB server. + +[caption=""] +.Returns +`struct UserIterator*` + +[#_users_contains] +==== users_contains + +[source,cpp] +---- +bool users_contains(const struct UserManager* user_manager, const char* username) +---- + + + +Checks if a user with the given name exists. + +[caption=""] +.Returns +`bool` + +[#_users_create] +==== users_create + +[source,cpp] +---- +void users_create(const struct UserManager* user_manager, const char* username, const char* password) +---- + + + +Creates a user with the given name & password. + +[caption=""] +.Returns +`void` + +[#_users_current_user] +==== users_current_user + +[source,cpp] +---- +struct User* users_current_user(const struct UserManager* user_manager) +---- + + + +Retrieves the user who opened this connection + +[caption=""] +.Returns +`struct User*` + +[#_users_delete] +==== users_delete + +[source,cpp] +---- +void users_delete(const struct UserManager* user_manager, const char* username) +---- + + + +Deletes the user with the given username. + +[caption=""] +.Returns +`void` + +[#_users_get] +==== users_get + +[source,cpp] +---- +struct User* users_get(const struct UserManager* user_manager, const char* username) +---- + + + +Retrieves a user with the given name. + +[caption=""] +.Returns +`struct User*` + +[#_users_set_password] +==== users_set_password + +[source,cpp] +---- +void users_set_password(const struct UserManager* user_manager, const char* username, const char* password) +---- + + + +Sets a new password for a user. This operation can only be performed by administrators. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `user_manager` a| The UserManager object to be used. This must be on a connection opened by an administrator. a| `const struct UserManager*` +a| `username` a| The name of the user to set the password of a| `const char*` +a| `password` a| The new password a| `const char*` +|=== + +[caption=""] +.Returns +`void` + diff --git a/c/docs/errors/error.adoc b/c/docs/errors/error.adoc new file mode 100644 index 0000000000..52932bb9d9 --- /dev/null +++ b/c/docs/errors/error.adoc @@ -0,0 +1,96 @@ +[#_methods__errors__error] +=== error + +[#_Struct_Error] +==== Struct Error + + + +Represents errors encountered during operation. + +[#_error_code] +==== error_code + +[source,cpp] +---- +char* error_code(const struct Error* error) +---- + + + +Returns the error code of the ``Error`` object + +[caption=""] +.Returns +`char*` + +[#_error_drop] +==== error_drop + +[source,cpp] +---- +void error_drop(struct Error* error) +---- + + + +Frees the native rust ``Error`` object + +[caption=""] +.Returns +`void` + +[#_error_message] +==== error_message + +[source,cpp] +---- +char* error_message(const struct Error* error) +---- + + + +Returns the error message of the ``Error`` object + +[caption=""] +.Returns +`char*` + +[#_methods__errors__error] +=== error + +[#_get_last_error] +==== get_last_error + +[source,cpp] +---- +struct Error* get_last_error(void) +---- + + + +Returns the error which set the error flag. + +[caption=""] +.Returns +`struct Error*` + +[#_methods__errors__error] +=== error + +[#_check_error] +==== check_error + +[source,cpp] +---- +bool check_error(void) +---- + + + +Checks if the error flag was set by the last operation. If true, the error can be retrieved using get_last_error(void) + +[caption=""] +.Returns +`bool` + diff --git a/c/docs/errors/schemaexception.adoc b/c/docs/errors/schemaexception.adoc new file mode 100644 index 0000000000..d831d4c30a --- /dev/null +++ b/c/docs/errors/schemaexception.adoc @@ -0,0 +1,97 @@ +[#_methods__errors__schemaexception] +=== schemaexception + +[#_Struct_SchemaException] +==== Struct SchemaException + + + +Represents invalid schema constructs discovered during schema validation. + +[#_Struct_SchemaExceptionIterator] +==== Struct SchemaExceptionIterator + + + +Iterator over the ``SchemaException``s in the result of concepts_get_schema_exceptions(Transaction*). + +[#_schema_exception_code] +==== schema_exception_code + +[source,cpp] +---- +char* schema_exception_code(const struct SchemaException* schema_exception) +---- + + + +Returns the error code of the ``SchemaException`` object + +[caption=""] +.Returns +`char*` + +[#_schema_exception_drop] +==== schema_exception_drop + +[source,cpp] +---- +void schema_exception_drop(struct SchemaException* schema_exception) +---- + + + +Frees the native rust ``SchemaException`` object + +[caption=""] +.Returns +`void` + +[#_schema_exception_iterator_drop] +==== schema_exception_iterator_drop + +[source,cpp] +---- +void schema_exception_iterator_drop(struct SchemaExceptionIterator* it) +---- + + + +Frees the native rust ``SchemaExceptionIterator`` object + +[caption=""] +.Returns +`void` + +[#_schema_exception_iterator_next] +==== schema_exception_iterator_next + +[source,cpp] +---- +struct SchemaException* schema_exception_iterator_next(struct SchemaExceptionIterator* it) +---- + + + +Forwards the ``SchemaExceptionIterator`` and returns the next ``SchemaException`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct SchemaException*` + +[#_schema_exception_message] +==== schema_exception_message + +[source,cpp] +---- +char* schema_exception_message(const struct SchemaException* schema_exception) +---- + + + +Returns the error message of the ``SchemaException`` object + +[caption=""] +.Returns +`char*` + diff --git a/c/docs/logic/logic.adoc b/c/docs/logic/logic.adoc new file mode 100644 index 0000000000..ac6ef7600b --- /dev/null +++ b/c/docs/logic/logic.adoc @@ -0,0 +1,63 @@ +[#_methods__logic__logic] +=== logic + +[#_logic_manager_get_rule] +==== logic_manager_get_rule + +[source,cpp] +---- +struct RulePromise* logic_manager_get_rule(struct Transaction* transaction, const char* label) +---- + + + +Retrieves the Rule that has the given label. + +[caption=""] +.Returns +`struct RulePromise*` + +[#_logic_manager_get_rules] +==== logic_manager_get_rules + +[source,cpp] +---- +struct RuleIterator* logic_manager_get_rules(struct Transaction* transaction) +---- + + + +Returns a ``RuleIterator`` over all rules in the database for the transaction. + +[caption=""] +.Returns +`struct RuleIterator*` + +[#_logic_manager_put_rule] +==== logic_manager_put_rule + +[source,cpp] +---- +struct RulePromise* logic_manager_put_rule(struct Transaction* transaction, const char* label, const char* when, const char* then) +---- + + + +Creates a new Rule if none exists with the given label, or replaces the existing one. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `label` a| The label of the Rule to create or replace a| `const char*` +a| `when` a| The when body of the rule to create a| `const char*` +a| `then` a| The then body of the rule to create a| `const char*` +|=== + +[caption=""] +.Returns +`struct RulePromise*` + diff --git a/c/docs/logic/rule.adoc b/c/docs/logic/rule.adoc new file mode 100644 index 0000000000..b5cb6fadc1 --- /dev/null +++ b/c/docs/logic/rule.adoc @@ -0,0 +1,200 @@ +[#_methods__logic__rule] +=== rule + +[#_Struct_Rule] +==== Struct Rule + + + +Rules are a part of schema and define embedded logic. The reasoning engine uses rules as a set of logic to infer new data. A rule consists of a condition and a conclusion, and is uniquely identified by a label. + +[#_Struct_RuleIterator] +==== Struct RuleIterator + + + +An iterator over ``Rule``s in the database + +[#_Struct_RulePromise] +==== Struct RulePromise + + + +Promise object representing the result of an asynchronous operation. Use rule_promise_resolve(RulePromise*) to wait for and retrieve the resulting ``Rule``. + +[#_rule_delete] +==== rule_delete + +[source,cpp] +---- +struct VoidPromise* rule_delete(const struct Transaction* transaction, struct Rule* rule) +---- + + + +Deletes this rule. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_rule_drop] +==== rule_drop + +[source,cpp] +---- +void rule_drop(struct Rule* rule) +---- + + + +Frees the native rust ``ReplicaInfoIterator`` object. + +[caption=""] +.Returns +`void` + +[#_rule_get_label] +==== rule_get_label + +[source,cpp] +---- +char* rule_get_label(const struct Rule* rule) +---- + + + +Retrieves the unique label of the rule. + +[caption=""] +.Returns +`char*` + +[#_rule_get_then] +==== rule_get_then + +[source,cpp] +---- +char* rule_get_then(const struct Rule* rule) +---- + + + +The single statement that constitutes the ‘then’ of the rule. + +[caption=""] +.Returns +`char*` + +[#_rule_get_when] +==== rule_get_when + +[source,cpp] +---- +char* rule_get_when(const struct Rule* rule) +---- + + + +The statements that constitute the ‘when’ of the rule. + +[caption=""] +.Returns +`char*` + +[#_rule_is_deleted] +==== rule_is_deleted + +[source,cpp] +---- +struct BoolPromise* rule_is_deleted(const struct Transaction* transaction, struct Rule* rule) +---- + + + +Check if this rule has been deleted. + +[caption=""] +.Returns +`struct BoolPromise*` + +[#_rule_iterator_drop] +==== rule_iterator_drop + +[source,cpp] +---- +void rule_iterator_drop(struct RuleIterator* it) +---- + + + +Frees the native rust ``RuleIterator`` object. + +[caption=""] +.Returns +`void` + +[#_rule_iterator_next] +==== rule_iterator_next + +[source,cpp] +---- +struct Rule* rule_iterator_next(struct RuleIterator* it) +---- + + + +Forwards the ``RuleIterator`` and returns the next ``Rule`` if it exists, or null if there are no more elements. + +[caption=""] +.Returns +`struct Rule*` + +[#_rule_promise_resolve] +==== rule_promise_resolve + +[source,cpp] +---- +struct Rule* rule_promise_resolve(struct RulePromise* promise) +---- + + + +Waits for and returns the result of the operation represented by the ``RulePromise`` object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved. + +[caption=""] +.Returns +`struct Rule*` + +[#_rule_set_label] +==== rule_set_label + +[source,cpp] +---- +struct VoidPromise* rule_set_label(const struct Transaction* transaction, struct Rule* rule, const char* new_label) +---- + + + +Renames the label of the rule. The new label must remain unique. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_rule_to_string] +==== rule_to_string + +[source,cpp] +---- +char* rule_to_string(const struct Rule* rule) +---- + + + +A string representation of this ``Rule`` object + +[caption=""] +.Returns +`char*` + diff --git a/c/docs/schema/annotation.adoc b/c/docs/schema/annotation.adoc new file mode 100644 index 0000000000..e1f53b897e --- /dev/null +++ b/c/docs/schema/annotation.adoc @@ -0,0 +1,122 @@ +[#_methods__schema__annotation] +=== annotation + +[#_Struct_Annotation] +==== Struct Annotation + + + +Annotations are used to specify extra schema constraints. + +[#_annotation_drop] +==== annotation_drop + +[source,cpp] +---- +void annotation_drop(struct Annotation* annotation) +---- + + + +Frees the native rust ``Annotation`` object + +[caption=""] +.Returns +`void` + +[#_annotation_equals] +==== annotation_equals + +[source,cpp] +---- +bool annotation_equals(const struct Annotation* lhs, const struct Annotation* rhs) +---- + + + +Checks whether the provided ``Annotation`` objects are equal + +[caption=""] +.Returns +`bool` + +[#_annotation_is_key] +==== annotation_is_key + +[source,cpp] +---- +bool annotation_is_key(const struct Annotation* annotation) +---- + + + +Checks whether the provided ``Annotation`` is ``@key`` + +[caption=""] +.Returns +`bool` + +[#_annotation_is_unique] +==== annotation_is_unique + +[source,cpp] +---- +bool annotation_is_unique(const struct Annotation* annotation) +---- + + + +Checks whether the provided ``Annotation`` is ``@unique`` + +[caption=""] +.Returns +`bool` + +[#_annotation_new_key] +==== annotation_new_key + +[source,cpp] +---- +struct Annotation* annotation_new_key(void) +---- + + + +Produces a ``@key`` annotation. + +[caption=""] +.Returns +`struct Annotation*` + +[#_annotation_new_unique] +==== annotation_new_unique + +[source,cpp] +---- +struct Annotation* annotation_new_unique(void) +---- + + + +Produces a ``@unique`` annotation. + +[caption=""] +.Returns +`struct Annotation*` + +[#_annotation_to_string] +==== annotation_to_string + +[source,cpp] +---- +char* annotation_to_string(const struct Annotation* annotation) +---- + + + +A string representation of this ``Annotation`` object + +[caption=""] +.Returns +`char*` + diff --git a/c/docs/schema/attributetype.adoc b/c/docs/schema/attributetype.adoc new file mode 100644 index 0000000000..618c585564 --- /dev/null +++ b/c/docs/schema/attributetype.adoc @@ -0,0 +1,223 @@ +[#_methods__schema__attributetype] +=== attributetype + +[#_attribute_type_get] +==== attribute_type_get + +[source,cpp] +---- +struct ConceptPromise* attribute_type_get(struct Transaction* transaction, const struct Concept* attribute_type, const struct Concept* value) +---- + + + +Retrieves an ``Attribute`` of this ``AttributeType`` with the given ``Value`` if such ``Attribute`` exists. Otherwise, returns ``null``. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_attribute_type_get_instances] +==== attribute_type_get_instances + +[source,cpp] +---- +struct ConceptIterator* attribute_type_get_instances(struct Transaction* transaction, const struct Concept* attribute_type, enum Transitivity transitivity) +---- + + + +Retrieves all ``Attribute`` objects that are instances of this ``AttributeType`` or its subtypes. Specify ``Transitive`` for instances of this AttributeType and subtypes, Or ``Explicit`` of this AttributeType only + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_attribute_type_get_owners] +==== attribute_type_get_owners + +[source,cpp] +---- +struct ConceptIterator* attribute_type_get_owners(struct Transaction* transaction, const struct Concept* attribute_type, enum Transitivity transitivity, const struct Annotation*const* annotations) +---- + + + +Retrieve all ``Things`` that own an attribute of this ``AttributeType`` directly or through inheritance. Specify ``Transitive`` for direct and inherited ownership, or ``Explicit`` for direct ownership only + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `annotations` a| a null-terminated array of ``Annotation``s - If non-empty, Only retrieves thing types of ownerships with all specified annotations. a| `const struct Annotation*const*` +|=== + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_attribute_type_get_regex] +==== attribute_type_get_regex + +[source,cpp] +---- +struct StringPromise* attribute_type_get_regex(struct Transaction* transaction, const struct Concept* attribute_type) +---- + + + +Retrieves the regular expression that is defined for this ``AttributeType``. + +[caption=""] +.Returns +`struct StringPromise*` + +[#_attribute_type_get_subtypes] +==== attribute_type_get_subtypes + +[source,cpp] +---- +struct ConceptIterator* attribute_type_get_subtypes(struct Transaction* transaction, const struct Concept* attribute_type, enum Transitivity transitivity) +---- + + + +Retrieves all direct and indirect (or direct only) subtypes of the given ``AttributeType``. Specify ``Transitive`` for direct and indirect subtypes, Or ``Explicit`` for directly subtypes only. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_attribute_type_get_subtypes_with_value_type] +==== attribute_type_get_subtypes_with_value_type + +[source,cpp] +---- +struct ConceptIterator* attribute_type_get_subtypes_with_value_type(struct Transaction* transaction, const struct Concept* attribute_type, enum ValueType value_type, enum Transitivity transitivity) +---- + + + +Retrieves subtypes of this ``AttributeType`` with given ``ValueType``. Specify ``Transitive`` for direct and indirect subtypes, Or ``Explicit`` for directly subtypes only. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_attribute_type_get_supertype] +==== attribute_type_get_supertype + +[source,cpp] +---- +struct ConceptPromise* attribute_type_get_supertype(struct Transaction* transaction, const struct Concept* attribute_type) +---- + + + +Retrieves the most immediate supertype of the given ``AttributeType``. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_attribute_type_get_supertypes] +==== attribute_type_get_supertypes + +[source,cpp] +---- +struct ConceptIterator* attribute_type_get_supertypes(struct Transaction* transaction, const struct Concept* attribute_type) +---- + + + +Retrieves all supertypes of the given ``AttributeType``. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_attribute_type_get_value_type] +==== attribute_type_get_value_type + +[source,cpp] +---- +enum ValueType attribute_type_get_value_type(const struct Concept* attribute_type) +---- + + + +Retrieves the ``ValueType`` of this ``AttributeType``. + +[caption=""] +.Returns +`enum ValueType` + +[#_attribute_type_put] +==== attribute_type_put + +[source,cpp] +---- +struct ConceptPromise* attribute_type_put(struct Transaction* transaction, const struct Concept* attribute_type, const struct Concept* value) +---- + + + +Creates and returns a new instance of this ``AttributeType``, with the specified ``Value``. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_attribute_type_set_regex] +==== attribute_type_set_regex + +[source,cpp] +---- +struct VoidPromise* attribute_type_set_regex(struct Transaction* transaction, const struct Concept* attribute_type, const char* regex) +---- + + + +Sets a regular expression as a constraint for this ``AttributeType``. ``Value``s of all ``Attribute``s of this type (inserted earlier or later) should match this regex. + +Can only be applied for ``AttributeType``s with a ``string`` value type. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_attribute_type_set_supertype] +==== attribute_type_set_supertype + +[source,cpp] +---- +struct VoidPromise* attribute_type_set_supertype(struct Transaction* transaction, struct Concept* attribute_type, const struct Concept* supertype) +---- + + + +Sets the supplied ``AttributeType`` as the supertype of the current ``AttributeType``. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_attribute_type_unset_regex] +==== attribute_type_unset_regex + +[source,cpp] +---- +struct VoidPromise* attribute_type_unset_regex(struct Transaction* transaction, const struct Concept* attribute_type) +---- + + + +Removes the regular expression that is defined for this ``AttributeType``. + +[caption=""] +.Returns +`struct VoidPromise*` + diff --git a/c/docs/schema/entitytype.adoc b/c/docs/schema/entitytype.adoc new file mode 100644 index 0000000000..b1c6687653 --- /dev/null +++ b/c/docs/schema/entitytype.adoc @@ -0,0 +1,99 @@ +[#_methods__schema__entitytype] +=== entitytype + +[#_entity_type_create] +==== entity_type_create + +[source,cpp] +---- +struct ConceptPromise* entity_type_create(struct Transaction* transaction, const struct Concept* entity_type) +---- + + + +Creates and returns a new instance of this ``EntityType``. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_entity_type_get_instances] +==== entity_type_get_instances + +[source,cpp] +---- +struct ConceptIterator* entity_type_get_instances(struct Transaction* transaction, const struct Concept* entity_type, enum Transitivity transitivity) +---- + + + +Retrieves all ``Entity`` objects that are instances of this ``EntityType`` or its subtypes. Specify ``Transitive`` for instances of this EntityType and subtypes, Or ``Explicit`` of this EntityType only + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_entity_type_get_subtypes] +==== entity_type_get_subtypes + +[source,cpp] +---- +struct ConceptIterator* entity_type_get_subtypes(struct Transaction* transaction, const struct Concept* entity_type, enum Transitivity transitivity) +---- + + + +Retrieves all direct and indirect (or direct only) subtypes of the given EntityType. Specify ``Transitive`` for direct and indirect subtypes, Or ``Explicit`` for directly subtypes only. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_entity_type_get_supertype] +==== entity_type_get_supertype + +[source,cpp] +---- +struct ConceptPromise* entity_type_get_supertype(struct Transaction* transaction, const struct Concept* entity_type) +---- + + + +Retrieves the most immediate supertype of the given ``EntityType``. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_entity_type_get_supertypes] +==== entity_type_get_supertypes + +[source,cpp] +---- +struct ConceptIterator* entity_type_get_supertypes(struct Transaction* transaction, const struct Concept* entity_type) +---- + + + +Retrieves all supertypes of the given EntityType. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_entity_type_set_supertype] +==== entity_type_set_supertype + +[source,cpp] +---- +struct VoidPromise* entity_type_set_supertype(struct Transaction* transaction, struct Concept* entity_type, const struct Concept* supertype) +---- + + + +Sets the supplied ``EntityType`` as the supertype of the current ``EntityType``. + +[caption=""] +.Returns +`struct VoidPromise*` + diff --git a/c/docs/schema/relationtype.adoc b/c/docs/schema/relationtype.adoc new file mode 100644 index 0000000000..53db5c5f81 --- /dev/null +++ b/c/docs/schema/relationtype.adoc @@ -0,0 +1,179 @@ +[#_methods__schema__relationtype] +=== relationtype + +[#_relation_type_create] +==== relation_type_create + +[source,cpp] +---- +struct ConceptPromise* relation_type_create(struct Transaction* transaction, const struct Concept* relation_type) +---- + + + +Creates and returns a new instance of this ``RelationType``. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_relation_type_get_instances] +==== relation_type_get_instances + +[source,cpp] +---- +struct ConceptIterator* relation_type_get_instances(struct Transaction* transaction, const struct Concept* relation_type, enum Transitivity transitivity) +---- + + + +Retrieves all ``Relation`` objects that are instances of this ``RelationType`` or its subtypes. Specify ``Transitive`` for instances of this RelationType and subtypes, Or ``Explicit`` of this RelationType only + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_relation_type_get_relates] +==== relation_type_get_relates + +[source,cpp] +---- +struct ConceptIterator* relation_type_get_relates(struct Transaction* transaction, const struct Concept* relation_type, enum Transitivity transitivity) +---- + + + +Retrieves roles that this ``RelationType`` relates to directly or via inheritance. Specify ``Transitive`` for direct and inherited relates Or ``Explicit`` for direct relates only + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_relation_type_get_relates_for_role_label] +==== relation_type_get_relates_for_role_label + +[source,cpp] +---- +struct ConceptPromise* relation_type_get_relates_for_role_label(struct Transaction* transaction, const struct Concept* relation_type, const char* role_label) +---- + + + +Retrieves the role with the specified label that this ``RelationType`` relates to, directly or via inheritance. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_relation_type_get_relates_overridden] +==== relation_type_get_relates_overridden + +[source,cpp] +---- +struct ConceptPromise* relation_type_get_relates_overridden(struct Transaction* transaction, const struct Concept* relation_type, const char* overridden_role_label) +---- + + + +Retrieves the ``RoleType`` that is overridden by the role with the ``role_label``. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_relation_type_get_subtypes] +==== relation_type_get_subtypes + +[source,cpp] +---- +struct ConceptIterator* relation_type_get_subtypes(struct Transaction* transaction, const struct Concept* relation_type, enum Transitivity transitivity) +---- + + + +Retrieves all direct and indirect (or direct only) subtypes of the given RelationType. Specify ``Transitive`` for direct and indirect subtypes, Or ``Explicit`` for directly subtypes only. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_relation_type_get_supertype] +==== relation_type_get_supertype + +[source,cpp] +---- +struct ConceptPromise* relation_type_get_supertype(struct Transaction* transaction, const struct Concept* relation_type) +---- + + + +Retrieves the most immediate supertype of the given ``RelationType``. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_relation_type_get_supertypes] +==== relation_type_get_supertypes + +[source,cpp] +---- +struct ConceptIterator* relation_type_get_supertypes(struct Transaction* transaction, const struct Concept* relation_type) +---- + + + +Retrieves all supertypes of the given RelationType. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_relation_type_set_relates] +==== relation_type_set_relates + +[source,cpp] +---- +struct VoidPromise* relation_type_set_relates(struct Transaction* transaction, struct Concept* relation_type, const char* role_label, const char* overridden_role_label) +---- + + + +Sets the new role that this ``RelationType`` relates to. If we are setting an overriding type this way, we have to also pass overridden_role_label. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_relation_type_set_supertype] +==== relation_type_set_supertype + +[source,cpp] +---- +struct VoidPromise* relation_type_set_supertype(struct Transaction* transaction, struct Concept* relation_type, const struct Concept* supertype) +---- + + + +Sets the supplied ``RelationType`` as the supertype of the current ``RelationType``. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_relation_type_unset_relates] +==== relation_type_unset_relates + +[source,cpp] +---- +struct VoidPromise* relation_type_unset_relates(struct Transaction* transaction, struct Concept* relation_type, const char* role_label) +---- + + + +Disallows this ``RelationType`` from relating to the given role. + +[caption=""] +.Returns +`struct VoidPromise*` + diff --git a/c/docs/schema/roletype.adoc b/c/docs/schema/roletype.adoc new file mode 100644 index 0000000000..154d3941b7 --- /dev/null +++ b/c/docs/schema/roletype.adoc @@ -0,0 +1,243 @@ +[#_methods__schema__roletype] +=== roletype + +[#_role_type_delete] +==== role_type_delete + +[source,cpp] +---- +struct VoidPromise* role_type_delete(struct Transaction* transaction, const struct Concept* role_type) +---- + + + +Deletes this role type from the database. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_role_type_get_name] +==== role_type_get_name + +[source,cpp] +---- +char* role_type_get_name(const struct Concept* role_type) +---- + + + +Gets the name of this role type. + +[caption=""] +.Returns +`char*` + +[#_role_type_get_player_instances] +==== role_type_get_player_instances + +[source,cpp] +---- +struct ConceptIterator* role_type_get_player_instances(struct Transaction* transaction, const struct Concept* role_type, enum Transitivity transitivity) +---- + + + +Retrieves the ``Thing`` instances that play this role. Specify ``Transitive`` for direct and indirect playing, or ``Explicit`` for direct playing only + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_role_type_get_player_types] +==== role_type_get_player_types + +[source,cpp] +---- +struct ConceptIterator* role_type_get_player_types(struct Transaction* transaction, const struct Concept* role_type, enum Transitivity transitivity) +---- + + + +Retrieves the ``ThingType``s whose instances play this role. Specify ``Transitive`` for direct and indirect playing, or ``Explicit`` for direct playing only + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_role_type_get_relation_instances] +==== role_type_get_relation_instances + +[source,cpp] +---- +struct ConceptIterator* role_type_get_relation_instances(struct Transaction* transaction, const struct Concept* role_type, enum Transitivity transitivity) +---- + + + +Retrieves the ``Relation`` instances that this role is related to. Specify ``Transitive`` for direct and indirect relation, or ``Explicit`` for direct relation only + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_role_type_get_relation_type] +==== role_type_get_relation_type + +[source,cpp] +---- +struct ConceptPromise* role_type_get_relation_type(struct Transaction* transaction, const struct Concept* role_type) +---- + + + +Retrieves the ``RelationType`` that this role is directly related to. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_role_type_get_relation_types] +==== role_type_get_relation_types + +[source,cpp] +---- +struct ConceptIterator* role_type_get_relation_types(struct Transaction* transaction, const struct Concept* role_type) +---- + + + +Retrieves ``RelationType``s that this role is related to (directly or indirectly). + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_role_type_get_scope] +==== role_type_get_scope + +[source,cpp] +---- +char* role_type_get_scope(const struct Concept* role_type) +---- + + + +Gets the 'scope' of this role type. This corresponds to the label of the ``RelationType`` it is directly related to. + +[caption=""] +.Returns +`char*` + +[#_role_type_get_subtypes] +==== role_type_get_subtypes + +[source,cpp] +---- +struct ConceptIterator* role_type_get_subtypes(struct Transaction* transaction, const struct Concept* role_type, enum Transitivity transitivity) +---- + + + +Retrieves all direct and indirect (or direct only) subtypes of the given ``RoleType``. Specify ``Transitive`` for direct and indirect subtypes, Or ``Explicit`` for directly subtypes only. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_role_type_get_supertype] +==== role_type_get_supertype + +[source,cpp] +---- +struct ConceptPromise* role_type_get_supertype(struct Transaction* transaction, const struct Concept* role_type) +---- + + + +Retrieves the most immediate supertype of the given ``RoleType``. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_role_type_get_supertypes] +==== role_type_get_supertypes + +[source,cpp] +---- +struct ConceptIterator* role_type_get_supertypes(struct Transaction* transaction, const struct Concept* role_type) +---- + + + +Retrieves all supertypes of the given ``RoleType``. + +[caption=""] +.Returns +`struct ConceptIterator*` + +[#_role_type_is_abstract] +==== role_type_is_abstract + +[source,cpp] +---- +bool role_type_is_abstract(const struct Concept* role_type) +---- + + + +Checks if the role type is prevented from having data instances (i.e., ``abstract``). + +[caption=""] +.Returns +`bool` + +[#_role_type_is_deleted] +==== role_type_is_deleted + +[source,cpp] +---- +struct BoolPromise* role_type_is_deleted(const struct Transaction* transaction, const struct Concept* role_type) +---- + + + +Check if the role type has been deleted + +[caption=""] +.Returns +`struct BoolPromise*` + +[#_role_type_is_root] +==== role_type_is_root + +[source,cpp] +---- +bool role_type_is_root(const struct Concept* role_type) +---- + + + +Checks if the role type is the root role type, ""relation:role"" + +[caption=""] +.Returns +`bool` + +[#_role_type_set_label] +==== role_type_set_label + +[source,cpp] +---- +struct VoidPromise* role_type_set_label(struct Transaction* transaction, const struct Concept* role_type, const char* new_label) +---- + + + +Renames the label of the type. The new label must remain unique in the hierarchy of a relation type. + +[caption=""] +.Returns +`struct VoidPromise*` + diff --git a/c/docs/schema/transitivity.adoc b/c/docs/schema/transitivity.adoc new file mode 100644 index 0000000000..4eb18a8e14 --- /dev/null +++ b/c/docs/schema/transitivity.adoc @@ -0,0 +1,31 @@ +[#_methods__schema__transitivity] +=== transitivity + +[#_Struct_Transitivity] +==== Struct Transitivity + + + +Used for specifying whether we need explicit or transitive subtyping, instances, etc. + + +[#_Enum_Transitivity] +==== Enum Transitivity + + + +Used for specifying whether we need explicit or transitive subtyping, instances, etc. + + +[caption=""] +.Enum constants +// tag::enum_constants[] +[cols=""] +[options="header"] +|=== +|Name +a| `Explicit` +a| `Transitive` +|=== +// end::enum_constants[] + diff --git a/c/docs/schema/valuetype.adoc b/c/docs/schema/valuetype.adoc new file mode 100644 index 0000000000..cb6ebfe27f --- /dev/null +++ b/c/docs/schema/valuetype.adoc @@ -0,0 +1,51 @@ +[#_methods__schema__valuetype] +=== valuetype + +[#_Struct_ValueType] +==== Struct ValueType + + + +Represents the type of primitive value is held by a Value or Attribute. + +[#_Enum_ValueType] +==== Enum ValueType + + + +Represents the type of primitive value is held by a Value or Attribute. + +[caption=""] +.Enum constants +// tag::enum_constants[] +[cols=""] +[options="header"] +|=== +|Name +a| `Boolean` +a| `DateTime` +a| `Double` +a| `Long` +a| `Object` +a| `String` +|=== +// end::enum_constants[] + +[#_Enum_ValueType] +==== Enum ValueType + + + +Retrieves the ``ValueType`` of this ``AttributeType``. + +[caption=""] +.Enum constants +// tag::enum_constants[] +[cols=""] +[options="header"] +|=== +|Name +a| `attribute_type_get_value_type (const struct Concept *attribute_type)` +|=== +// end::enum_constants[] + diff --git a/c/docs/session/options.adoc b/c/docs/session/options.adoc new file mode 100644 index 0000000000..e3d961d7ec --- /dev/null +++ b/c/docs/session/options.adoc @@ -0,0 +1,533 @@ +[#_methods__session__options] +=== options + +[#_Struct_Options] +==== Struct Options + + + +TypeDB session and transaction options. ``TypeDBOptions`` object can be used to override the default server behaviour. Options are specified using properties assignment. + + +[#_options_drop] +==== options_drop + +[source,cpp] +---- +void options_drop(struct Options* options) +---- + + + +Frees the native rust ``Options`` object. + +[caption=""] +.Returns +`void` + +[#_options_get_explain] +==== options_get_explain + +[source,cpp] +---- +bool options_get_explain(const struct Options* options) +---- + + + +Returns the value set for the explanation in this ``TypeDBOptions`` object. If set to ``true``, explanations for queries are enabled. + +[caption=""] +.Returns +`bool` + +[#_options_get_infer] +==== options_get_infer + +[source,cpp] +---- +bool options_get_infer(const struct Options* options) +---- + + + +Returns the value set for the inference in this ``TypeDBOptions`` object. + +[caption=""] +.Returns +`bool` + +[#_options_get_parallel] +==== options_get_parallel + +[source,cpp] +---- +bool options_get_parallel(const struct Options* options) +---- + + + +Returns the value set for the parallel execution in this ``TypeDBOptions`` object. If set to ``true``, the server uses parallel instead of single-threaded execution. + +[caption=""] +.Returns +`bool` + +[#_options_get_prefetch] +==== options_get_prefetch + +[source,cpp] +---- +bool options_get_prefetch(const struct Options* options) +---- + + + +Returns the value set for the prefetching in this ``TypeDBOptions`` object. If set to ``true``, the first batch of answers is streamed to the driver even without an explicit request for it. + +[caption=""] +.Returns +`bool` + +[#_options_get_prefetch_size] +==== options_get_prefetch_size + +[source,cpp] +---- +int32_t options_get_prefetch_size(const struct Options* options) +---- + + + +Returns the value set for the prefetch size in this ``TypeDBOptions`` object. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request. + +[caption=""] +.Returns +`int32_t` + +[#_options_get_read_any_replica] +==== options_get_read_any_replica + +[source,cpp] +---- +bool options_get_read_any_replica(const struct Options* options) +---- + + + +Returns the value set for reading data from any replica in this ``TypeDBOptions`` object. If set to ``True``, enables reading data from any replica, potentially boosting read throughput. + +[caption=""] +.Returns +`bool` + +[#_options_get_schema_lock_acquire_timeout_millis] +==== options_get_schema_lock_acquire_timeout_millis + +[source,cpp] +---- +int64_t options_get_schema_lock_acquire_timeout_millis(const struct Options* options) +---- + + + +Returns the value set for the schema lock acquire timeout in this ``TypeDBOptions`` object. If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock. + +[caption=""] +.Returns +`int64_t` + +[#_options_get_session_idle_timeout_millis] +==== options_get_session_idle_timeout_millis + +[source,cpp] +---- +int64_t options_get_session_idle_timeout_millis(const struct Options* options) +---- + + + +Returns the value set for the session idle timeout in this ``TypeDBOptions`` object. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. + +[caption=""] +.Returns +`int64_t` + +[#_options_get_trace_inference] +==== options_get_trace_inference + +[source,cpp] +---- +bool options_get_trace_inference(const struct Options* options) +---- + + + +Returns the value set for reasoning tracing in this ``TypeDBOptions`` object. If set to ``true``, reasoning tracing graphs are output in the logging directory. + +[caption=""] +.Returns +`bool` + +[#_options_get_transaction_timeout_millis] +==== options_get_transaction_timeout_millis + +[source,cpp] +---- +int64_t options_get_transaction_timeout_millis(const struct Options* options) +---- + + + +Returns the value set for the transaction timeout in this ``TypeDBOptions`` object. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions. + +[caption=""] +.Returns +`int64_t` + +[#_options_has_explain] +==== options_has_explain + +[source,cpp] +---- +bool options_has_explain(const struct Options* options) +---- + + + +Checks whether the option for explanation was explicitly set for this ``TypeDBOptions`` object. + +[caption=""] +.Returns +`bool` + +[#_options_has_infer] +==== options_has_infer + +[source,cpp] +---- +bool options_has_infer(const struct Options* options) +---- + + + +Checks whether the option for inference was explicitly set for this ``TypeDBOptions`` object. + +[caption=""] +.Returns +`bool` + +[#_options_has_parallel] +==== options_has_parallel + +[source,cpp] +---- +bool options_has_parallel(const struct Options* options) +---- + + + +Checks whether the option for parallel execution was explicitly set for this ``TypeDBOptions`` object. + +[caption=""] +.Returns +`bool` + +[#_options_has_prefetch] +==== options_has_prefetch + +[source,cpp] +---- +bool options_has_prefetch(const struct Options* options) +---- + + + +Checks whether the option for prefetching was explicitly set for this ``TypeDBOptions`` object. + +[caption=""] +.Returns +`bool` + +[#_options_has_prefetch_size] +==== options_has_prefetch_size + +[source,cpp] +---- +bool options_has_prefetch_size(const struct Options* options) +---- + + + +Checks whether the option for prefetch size was explicitly set for this ``TypeDBOptions`` object. + +[caption=""] +.Returns +`bool` + +[#_options_has_read_any_replica] +==== options_has_read_any_replica + +[source,cpp] +---- +bool options_has_read_any_replica(const struct Options* options) +---- + + + +Checks whether the option for reading data from any replica was explicitly set for this ``TypeDBOptions`` object. + +[caption=""] +.Returns +`bool` + +[#_options_has_schema_lock_acquire_timeout_millis] +==== options_has_schema_lock_acquire_timeout_millis + +[source,cpp] +---- +bool options_has_schema_lock_acquire_timeout_millis(const struct Options* options) +---- + + + +Checks whether the option for schema lock acquire timeout was explicitly set for this ``TypeDBOptions`` object. + +[caption=""] +.Returns +`bool` + +[#_options_has_session_idle_timeout_millis] +==== options_has_session_idle_timeout_millis + +[source,cpp] +---- +bool options_has_session_idle_timeout_millis(const struct Options* options) +---- + + + +Checks whether the option for the session idle timeout was explicitly set for this ``TypeDBOptions`` object. + +[caption=""] +.Returns +`bool` + +[#_options_has_trace_inference] +==== options_has_trace_inference + +[source,cpp] +---- +bool options_has_trace_inference(const struct Options* options) +---- + + + +Checks whether the option for reasoning tracing was explicitly set for this ``TypeDBOptions`` object. + +[caption=""] +.Returns +`bool` + +[#_options_has_transaction_timeout_millis] +==== options_has_transaction_timeout_millis + +[source,cpp] +---- +bool options_has_transaction_timeout_millis(const struct Options* options) +---- + + + +Checks whether the option for transaction timeout was explicitly set for this ``TypeDBOptions`` object. + +[caption=""] +.Returns +`bool` + +[#_options_new] +==== options_new + +[source,cpp] +---- +struct Options* options_new(void) +---- + + + +Produces a new ``TypeDBOptions`` object. + +[caption=""] +.Returns +`struct Options*` + +[#_options_set_explain] +==== options_set_explain + +[source,cpp] +---- +void options_set_explain(struct Options* options, bool explain) +---- + + + +Explicitly enables or disables explanations. If set to ``true``, enables explanations for queries. Only affects read transactions. + +[caption=""] +.Returns +`void` + +[#_options_set_infer] +==== options_set_infer + +[source,cpp] +---- +void options_set_infer(struct Options* options, bool infer) +---- + + + +Explicitly enables or disables inference. Only settable at transaction level and above. Only affects read transactions. + +[caption=""] +.Returns +`void` + +[#_options_set_parallel] +==== options_set_parallel + +[source,cpp] +---- +void options_set_parallel(struct Options* options, bool parallel) +---- + + + +Explicitly enables or disables parallel execution. If set to ``true``, the server uses parallel instead of single-threaded execution. + +[caption=""] +.Returns +`void` + +[#_options_set_prefetch] +==== options_set_prefetch + +[source,cpp] +---- +void options_set_prefetch(struct Options* options, bool prefetch) +---- + + + +Explicitly enables or disables prefetching. If set to ``true``, the first batch of answers is streamed to the driver even without an explicit request for it. + +[caption=""] +.Returns +`void` + +[#_options_set_prefetch_size] +==== options_set_prefetch_size + +[source,cpp] +---- +void options_set_prefetch_size(struct Options* options, int32_t prefetch_size) +---- + + + +Explicitly sets a prefetch size. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `prefetchSize` a| Number of answers that the server should send before the driver issues a fresh request a| +|=== + +[caption=""] +.Returns +`void` + +[#_options_set_read_any_replica] +==== options_set_read_any_replica + +[source,cpp] +---- +void options_set_read_any_replica(struct Options* options, bool read_any_replica) +---- + + + +Explicitly enables or disables reading data from any replica. If set to ``True``, enables reading data from any replica, potentially boosting read throughput. Only settable in TypeDB Cloud. + +[caption=""] +.Returns +`void` + +[#_options_set_schema_lock_acquire_timeout_millis] +==== options_set_schema_lock_acquire_timeout_millis + +[source,cpp] +---- +void options_set_schema_lock_acquire_timeout_millis(struct Options* options, int64_t timeout_millis) +---- + + + +Explicitly sets schema lock acquire timeout. If set, specifies how long the driver should wait if opening a session or transaction is blocked by a schema write lock. + +[caption=""] +.Returns +`void` + +[#_options_set_session_idle_timeout_millis] +==== options_set_session_idle_timeout_millis + +[source,cpp] +---- +void options_set_session_idle_timeout_millis(struct Options* options, int64_t timeout_millis) +---- + + + +Explicitly sets a session idle timeout. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive. + +[caption=""] +.Returns +`void` + +[#_options_set_trace_inference] +==== options_set_trace_inference + +[source,cpp] +---- +void options_set_trace_inference(struct Options* options, bool trace_inference) +---- + + + +Explicitly enables or disables reasoning tracing. If set to ``true``, reasoning tracing graphs are output in the logging directory. Should be used with ``parallel = False``. + +[caption=""] +.Returns +`void` + +[#_options_set_transaction_timeout_millis] +==== options_set_transaction_timeout_millis + +[source,cpp] +---- +void options_set_transaction_timeout_millis(struct Options* options, int64_t timeout_millis) +---- + + + +Explicitly set a transaction timeout. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions. + +[caption=""] +.Returns +`void` + diff --git a/c/docs/session/session.adoc b/c/docs/session/session.adoc new file mode 100644 index 0000000000..eff3db292c --- /dev/null +++ b/c/docs/session/session.adoc @@ -0,0 +1,189 @@ +[#_methods__session__session] +=== session + +[#_Struct_Session] +==== Struct Session + + + +A session with a TypeDB database. + +[#_Struct_SessionType] +==== Struct SessionType + + + +This enum is used to specify the type of the session. + + +[#_Enum_SessionType] +==== Enum SessionType + + + +This enum is used to specify the type of the session. + + +[caption=""] +.Enum constants +// tag::enum_constants[] +[cols=""] +[options="header"] +|=== +|Name +a| `Data = 0` +a| `Schema = 1` +|=== +// end::enum_constants[] + +[#_session_close] +==== session_close + +[source,cpp] +---- +void session_close(struct Session* session) +---- + + + +Closes the session. Before opening a new session, the session currently open should first be closed. The native rust object is freed on close. + +[caption=""] +.Returns +`void` + +[#_session_force_close] +==== session_force_close + +[source,cpp] +---- +void session_force_close(struct Session* session) +---- + + + +Forcibly closes the session. To be used in exceptional cases. + +[caption=""] +.Returns +`void` + +[#_session_get_database_name] +==== session_get_database_name + +[source,cpp] +---- +char* session_get_database_name(const struct Session* session) +---- + + + +Returns the name of the database of the session. + +[caption=""] +.Returns +`char*` + +[#_session_is_open] +==== session_is_open + +[source,cpp] +---- +bool session_is_open(const struct Session* session) +---- + + + +Checks whether this session is open. + +[caption=""] +.Returns +`bool` + +[#_session_new] +==== session_new + +[source,cpp] +---- +struct Session* session_new(struct DatabaseManager* databases, const char* database_name, enum SessionType session_type, const struct Options* options) +---- + + + +Opens a session to the given database. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `databases` a| The ``DatabaseManager`` object on this connection. a| `struct DatabaseManager*` +a| `database_name` a| The name of the database with which the session connects a| `const char*` +a| `session_type` a| The type of session to be created (Schema or Data) a| `enum SessionType` +a| `options` a| ``Options`` for this session a| `const struct Options*` +|=== + +[caption=""] +.Returns +`struct Session*` + +[#_session_on_close] +==== session_on_close + +[source,cpp] +---- +void session_on_close(const struct Session* session, void* data, void(*)(void*) callback, void(*)(void*) finished) +---- + + + +Registers a callback function which will be executed when this session is closed. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `session` a| The session on which to register the callback a| `const struct Session*` +a| `data` a| The argument to be passed to the callback function when it is executed a| `void*` +a| `callback` a| The function to be called a| +a| `finished` a| A function which will be executed when the session is destroyed, allowing cleanup a| +|=== + +[caption=""] +.Returns +`void` + +[#_session_on_reopen] +==== session_on_reopen + +[source,cpp] +---- +void session_on_reopen(const struct Session* session, void* data, void(*)(void*) callback, void(*)(void*) finished) +---- + + + +Registers a callback function which will be executed when this session is reopened. A session may be closed if it times out, or loses the connection to the database. In such situations, the session is reopened automatically when opening a new transaction. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `session` a| The session on which to register the callback a| `const struct Session*` +a| `data` a| The argument to be passed to the callback function when it is executed a| `void*` +a| `callback` a| The function to be called a| +a| `finished` a| A function which will be executed when the session is destroyed, allowing cleanup a| +|=== + +[caption=""] +.Returns +`void` + diff --git a/c/docs/transaction/query.adoc b/c/docs/transaction/query.adoc new file mode 100644 index 0000000000..463d5dd937 --- /dev/null +++ b/c/docs/transaction/query.adoc @@ -0,0 +1,190 @@ +[#_methods__transaction__query] +=== query + +[#_query_define] +==== query_define + +[source,cpp] +---- +struct VoidPromise* query_define(struct Transaction* transaction, const char* query, const struct Options* options) +---- + + + +Performs a TypeQL Define query in the transaction. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_query_delete] +==== query_delete + +[source,cpp] +---- +struct VoidPromise* query_delete(struct Transaction* transaction, const char* query, const struct Options* options) +---- + + + +Performs a TypeQL Delete query in the transaction. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_query_explain] +==== query_explain + +[source,cpp] +---- +struct ExplanationIterator* query_explain(struct Transaction* transaction, const struct Explainable* explainable, const struct Options* options) +---- + + + +Performs a TypeQL Explain query in the transaction. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `explainable` a| The Explainable to be explained a| `const struct Explainable*` +a| `options` a| Specify query options a| `const struct Options*` +|=== + +[caption=""] +.Returns +`struct ExplanationIterator*` + +[#_query_fetch] +==== query_fetch + +[source,cpp] +---- +struct StringIterator* query_fetch(struct Transaction* transaction, const char* query, const struct Options* options) +---- + + + +Performs a TypeQL Fetch query in the transaction. + +[caption=""] +.Returns +`struct StringIterator*` + +[#_query_get] +==== query_get + +[source,cpp] +---- +struct ConceptMapIterator* query_get(struct Transaction* transaction, const char* query, const struct Options* options) +---- + + + +Performs a TypeQL Get (Get) query in the transaction. + +[caption=""] +.Returns +`struct ConceptMapIterator*` + +[#_query_get_aggregate] +==== query_get_aggregate + +[source,cpp] +---- +struct ConceptPromise* query_get_aggregate(struct Transaction* transaction, const char* query, const struct Options* options) +---- + + + +Performs a TypeQL Get Aggregate query in the transaction. + +[caption=""] +.Returns +`struct ConceptPromise*` + +[#_query_get_group] +==== query_get_group + +[source,cpp] +---- +struct ConceptMapGroupIterator* query_get_group(struct Transaction* transaction, const char* query, const struct Options* options) +---- + + + +Performs a TypeQL Get Group query in the transaction. + +[caption=""] +.Returns +`struct ConceptMapGroupIterator*` + +[#_query_get_group_aggregate] +==== query_get_group_aggregate + +[source,cpp] +---- +struct ValueGroupIterator* query_get_group_aggregate(struct Transaction* transaction, const char* query, const struct Options* options) +---- + + + +Performs a TypeQL Get Group Aggregate query in the transaction. + +[caption=""] +.Returns +`struct ValueGroupIterator*` + +[#_query_insert] +==== query_insert + +[source,cpp] +---- +struct ConceptMapIterator* query_insert(struct Transaction* transaction, const char* query, const struct Options* options) +---- + + + +Performs a TypeQL Insert query in the transaction. + +[caption=""] +.Returns +`struct ConceptMapIterator*` + +[#_query_undefine] +==== query_undefine + +[source,cpp] +---- +struct VoidPromise* query_undefine(struct Transaction* transaction, const char* query, const struct Options* options) +---- + + + +Performs a TypeQL Undefine query in the transaction. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_query_update] +==== query_update + +[source,cpp] +---- +struct ConceptMapIterator* query_update(struct Transaction* transaction, const char* query, const struct Options* options) +---- + + + +Performs a TypeQL Update query in the transaction. + +[caption=""] +.Returns +`struct ConceptMapIterator*` + diff --git a/c/docs/transaction/transaction.adoc b/c/docs/transaction/transaction.adoc new file mode 100644 index 0000000000..fbb3e29604 --- /dev/null +++ b/c/docs/transaction/transaction.adoc @@ -0,0 +1,173 @@ +[#_methods__transaction__transaction] +=== transaction + +[#_Struct_Transaction] +==== Struct Transaction + + + +A transaction with a TypeDB database. + +[#_Struct_TransactionType] +==== Struct TransactionType + + + +This enum is used to specify the type of transaction. + + +[#_Enum_TransactionType] +==== Enum TransactionType + + + +This enum is used to specify the type of transaction. + + +[caption=""] +.Enum constants +// tag::enum_constants[] +[cols=""] +[options="header"] +|=== +|Name +a| `Read = 0` +a| `Write = 1` +|=== +// end::enum_constants[] + +[#_transaction_close] +==== transaction_close + +[source,cpp] +---- +void transaction_close(struct Transaction* txn) +---- + + + +Closes the transaction and frees the native rust object. + +[caption=""] +.Returns +`void` + +[#_transaction_commit] +==== transaction_commit + +[source,cpp] +---- +struct VoidPromise* transaction_commit(struct Transaction* txn) +---- + + + +Commits the changes made via this transaction to the TypeDB database. Whether or not the transaction is commited successfully, the transaction is closed after the commit call and the native rust object is freed. + +[caption=""] +.Returns +`struct VoidPromise*` + +[#_transaction_force_close] +==== transaction_force_close + +[source,cpp] +---- +void transaction_force_close(struct Transaction* txn) +---- + + + +Forcibly closes this transaction. To be used in exceptional cases. + +[caption=""] +.Returns +`void` + +[#_transaction_is_open] +==== transaction_is_open + +[source,cpp] +---- +bool transaction_is_open(const struct Transaction* txn) +---- + + + +Checks whether this transaction is open. + +[caption=""] +.Returns +`bool` + +[#_transaction_new] +==== transaction_new + +[source,cpp] +---- +struct Transaction* transaction_new(const struct Session* session, enum TransactionType type_, const struct Options* options) +---- + + + +Opens a transaction to perform read or write queries on the database connected to the session. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `type_` a| The type of transaction to be created (Write or Read). a| `enum TransactionType` +a| `options` a| Options for the transaction a| `const struct Options*` +|=== + +[caption=""] +.Returns +`struct Transaction*` + +[#_transaction_on_close] +==== transaction_on_close + +[source,cpp] +---- +void transaction_on_close(const struct Transaction* txn, uintptr_t callback_id, void(*)(uintptr_t, struct Error*) callback) +---- + + + +Registers a callback function which will be executed when this transaction is closed. + + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `txn` a| The transaction on which to register the callback a| `const struct Transaction*` +a| `callback_id` a| The argument to be passed to the callback function when it is executed. a| `uintptr_t` +a| `callback` a| The function to be called a| +|=== + +[caption=""] +.Returns +`void` + +[#_transaction_rollback] +==== transaction_rollback + +[source,cpp] +---- +struct VoidPromise* transaction_rollback(const struct Transaction* txn) +---- + + + +Rolls back the uncommitted changes made via this transaction. + +[caption=""] +.Returns +`struct VoidPromise*` + diff --git a/cpp/docs/answer/ConceptMap.adoc b/cpp/docs/answer/ConceptMap.adoc index 56c7b1a1e0..46f014e436 100644 --- a/cpp/docs/answer/ConceptMap.adoc +++ b/cpp/docs/answer/ConceptMap.adoc @@ -25,13 +25,6 @@ Produces an ``Iterator`` over all concepts in this ``ConceptMap``. .Returns `ConceptIterable< Concept >` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMap.concepts(); ----- - [#_Explainables_TypeDBConceptMapexplainables___] ==== explainables @@ -49,13 +42,6 @@ Gets the ``Explainables`` object for this ``ConceptMap``, exposing which of the .Returns `Explainables` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMap.explainables(); ----- - [#_stdunique_ptr__Concept___TypeDBConceptMapget___const_stdstring__variableName_] ==== get @@ -82,13 +68,6 @@ a| `variable` a| The string representation of a variable a| .Returns `std::unique_ptr< Concept >` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMap.get(variable); ----- - [#_stdmap__stdstring__stdunique_ptr__Concept_____TypeDBConceptMapmap___] ==== map @@ -106,13 +85,6 @@ Returns the inner ``Map`` where keys are query variables, and values are concept .Returns `std::map< std::string, std::unique_ptr< Concept > >` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMap.map(); ----- - [#_stdstring_TypeDBConceptMaptoString___] ==== toString @@ -146,12 +118,5 @@ Produces an ``Iterator`` stream over all variables in this ``ConceptMap``. .Returns `StringIterable` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMap.variables(); ----- - // end::methods[] diff --git a/cpp/docs/answer/ConceptMapGroup.adoc b/cpp/docs/answer/ConceptMapGroup.adoc index e440dda03a..390ff214d6 100644 --- a/cpp/docs/answer/ConceptMapGroup.adoc +++ b/cpp/docs/answer/ConceptMapGroup.adoc @@ -25,13 +25,6 @@ Retrieves the ``ConceptMap``s of the group. .Returns `ConceptMapIterable` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMapGroup.conceptMaps(); ----- - [#_stdunique_ptr__Concept___TypeDBConceptMapGroupowner___] ==== owner @@ -49,13 +42,6 @@ Retrieves the concept that is the group owner. .Returns `std::unique_ptr< Concept >` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMapGroup.owner(); ----- - [#_stdstring_TypeDBConceptMapGrouptoString___] ==== toString diff --git a/cpp/docs/answer/Explainable.adoc b/cpp/docs/answer/Explainable.adoc index e41c187473..75c94347df 100644 --- a/cpp/docs/answer/Explainable.adoc +++ b/cpp/docs/answer/Explainable.adoc @@ -25,13 +25,6 @@ Retrieves the subquery of the original query that is actually being explained. .Returns `std::string` -[caption=""] -.Code examples -[source,cpp] ----- -explainable.conjunction(); ----- - [#_int64_t_TypeDBExplainableexplainableId___] ==== explainableId @@ -49,12 +42,5 @@ Retrieves the unique ID that identifies this ``Explainable``. .Returns `int64_t` -[caption=""] -.Code examples -[source,cpp] ----- -explainable.id(); ----- - // end::methods[] diff --git a/cpp/docs/answer/Explainables.adoc b/cpp/docs/answer/Explainables.adoc index eeac15a813..413954d7f0 100644 --- a/cpp/docs/answer/Explainables.adoc +++ b/cpp/docs/answer/Explainables.adoc @@ -34,13 +34,6 @@ a| `variable` a| The string representation of a variable a| `std::string&` .Returns `Explainable` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMap.explainables().attribute(variable); ----- - [#_StringIterable_TypeDBExplainablesattributes___] ==== attributes @@ -58,13 +51,6 @@ Retrieves all of this ``ConceptMap``’s explainable attributes. .Returns `StringIterable` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMap.explainables().attributes(); ----- - [#_Explainable_TypeDBExplainablesownership___stdstring__owner__stdstring__attribute_] ==== ownership @@ -92,13 +78,6 @@ a| `attribute` a| The string representation of the attribute variable a| `std::s .Returns `Explainable` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMap.explainables().ownership(owner, attribute); ----- - [#_OwnerAttributePairIterable_TypeDBExplainablesownerships___] ==== ownerships @@ -116,13 +95,6 @@ Retrieves all of this ``ConceptMap``’s explainable ownerships. .Returns `OwnerAttributePairIterable` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMap.explainables().ownerships(); ----- - [#_Explainable_TypeDBExplainablesrelation___stdstring__variable_] ==== relation @@ -149,13 +121,6 @@ a| `variable` a| The string representation of a variable a| `std::string&` .Returns `Explainable` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMap.explainables().relation(variable); ----- - [#_StringIterable_TypeDBExplainablesrelations___] ==== relations @@ -173,13 +138,6 @@ Retrieves all of this ``ConceptMap``’s explainable relations. .Returns `StringIterable` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMap.explainables().relations(); ----- - [#_stdstring_TypeDBExplainablestoString___] ==== toString diff --git a/cpp/docs/answer/Explanation.adoc b/cpp/docs/answer/Explanation.adoc index 035a3aeef8..50bfceaf0c 100644 --- a/cpp/docs/answer/Explanation.adoc +++ b/cpp/docs/answer/Explanation.adoc @@ -27,13 +27,6 @@ Retrieves the Conclusion for this Explanation. .Returns `ConceptMap` -[caption=""] -.Code examples -[source,cpp] ----- -explanation.conclusion() ----- - [#_ConceptMap_TypeDBExplanationcondition___] ==== condition @@ -51,13 +44,6 @@ Retrieves the Condition for this Explanation. .Returns `ConceptMap` -[caption=""] -.Code examples -[source,cpp] ----- -explanation.condition() ----- - [#_stdvector__stdstring___TypeDBExplanationqueryVariableMapping___const_stdstring__var_] ==== queryVariableMapping @@ -84,13 +70,6 @@ a| `var` a| The query variable to map to rule variables. a| `const std::string&` .Returns `std::vector< std::string >` -[caption=""] -.Code examples -[source,cpp] ----- -explanation.variableMapping(var) ----- - [#_stdvector__stdstring___TypeDBExplanationqueryVariables___] ==== queryVariables @@ -108,13 +87,6 @@ Retrieves the query variables for this ``Explanation``. .Returns `std::vector< std::string >` -[caption=""] -.Code examples -[source,cpp] ----- -explanation.queryVariables() ----- - [#_Rule_TypeDBExplanationrule___] ==== rule @@ -132,13 +104,6 @@ Retrieves the Rule for this Explanation. .Returns `Rule` -[caption=""] -.Code examples -[source,cpp] ----- -explanation.rule() ----- - [#_stdstring_TypeDBExplanationtoString___] ==== toString diff --git a/cpp/docs/answer/ValueGroup.adoc b/cpp/docs/answer/ValueGroup.adoc index bd8829b44f..bb89e98cf5 100644 --- a/cpp/docs/answer/ValueGroup.adoc +++ b/cpp/docs/answer/ValueGroup.adoc @@ -25,13 +25,6 @@ Retrieves the concept that is the group owner. .Returns `std::unique_ptr< Concept >` -[caption=""] -.Code examples -[source,cpp] ----- -conceptMapGroup.owner() ----- - [#_stdstring_TypeDBValueGrouptoString___] ==== toString @@ -65,12 +58,5 @@ Retrieves the ``Value`` answer of the group. .Returns `AggregateResult` -[caption=""] -.Code examples -[source,cpp] ----- -valueGroup.value(); ----- - // end::methods[] diff --git a/cpp/docs/concept/Concept.adoc b/cpp/docs/concept/Concept.adoc index f6454c7925..f6c5db56ae 100644 --- a/cpp/docs/concept/Concept.adoc +++ b/cpp/docs/concept/Concept.adoc @@ -25,13 +25,6 @@ Casts the concept to ``Attribute``. .Returns `Attribute*` -[caption=""] -.Code examples -[source,cpp] ----- -concept.asAttribute(); ----- - [#_AttributeType__ptr__TypeDBConceptasAttributeType___] ==== asAttributeType @@ -49,13 +42,6 @@ Casts the concept to ``EntityType``. .Returns `AttributeType*` -[caption=""] -.Code examples -[source,cpp] ----- -concept.asEntityType(); ----- - [#_Entity__ptr__TypeDBConceptasEntity___] ==== asEntity @@ -73,13 +59,6 @@ Casts the concept to ``Entity``. .Returns `Entity*` -[caption=""] -.Code examples -[source,cpp] ----- -concept.asEntity(); ----- - [#_EntityType__ptr__TypeDBConceptasEntityType___] ==== asEntityType @@ -97,13 +76,6 @@ Casts the concept to ``EntityType``. .Returns `EntityType*` -[caption=""] -.Code examples -[source,cpp] ----- -concept.asEntityType(); ----- - [#_Relation__ptr__TypeDBConceptasRelation___] ==== asRelation @@ -121,13 +93,6 @@ Casts the concept to ``Relation``. .Returns `Relation*` -[caption=""] -.Code examples -[source,cpp] ----- -concept.asRelation(); ----- - [#_RelationType__ptr__TypeDBConceptasRelationType___] ==== asRelationType @@ -145,13 +110,6 @@ Casts the concept to ``RelationType``. .Returns `RelationType*` -[caption=""] -.Code examples -[source,cpp] ----- -concept.asRelationType(); ----- - [#_RoleType__ptr__TypeDBConceptasRoleType___] ==== asRoleType @@ -169,13 +127,6 @@ Casts the concept to ``RoleType``. .Returns `RoleType*` -[caption=""] -.Code examples -[source,cpp] ----- -concept.asRoleType(); ----- - [#_Thing__ptr__TypeDBConceptasThing___] ==== asThing @@ -193,13 +144,6 @@ Casts the concept to ``Thing``. .Returns `Thing*` -[caption=""] -.Code examples -[source,cpp] ----- -concept.asThing(); ----- - [#_ThingType__ptr__TypeDBConceptasThingType___] ==== asThingType @@ -217,13 +161,6 @@ Casts the concept to ``ThingType``. .Returns `ThingType*` -[caption=""] -.Code examples -[source,cpp] ----- -concept.asThingType(); ----- - [#_Value__ptr__TypeDBConceptasValue___] ==== asValue @@ -241,13 +178,6 @@ Casts the concept to ``Value``. .Returns `Value*` -[caption=""] -.Code examples -[source,cpp] ----- -concept.asValue(); ----- - [#_static_bool_TypeDBConceptequals___Concept__ptr__first__Concept__ptr__second_] ==== equals @@ -281,13 +211,6 @@ Returns the ConceptType of this concept. .Returns `ConceptType` -[caption=""] -.Code examples -[source,cpp] ----- -switch(concept.getConceptType()) { ... } ----- - [#_bool_TypeDBConceptisAttribute___] ==== isAttribute @@ -305,13 +228,6 @@ Checks if the concept is a ``Relation``. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -concept.isRelation(); ----- - [#_bool_TypeDBConceptisAttributeType___] ==== isAttributeType @@ -329,13 +245,6 @@ Checks if the concept is an ``AttributeType``. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -concept.isAttributeType(); ----- - [#_bool_TypeDBConceptisEntity___] ==== isEntity @@ -353,13 +262,6 @@ Checks if the concept is an ``Entity``. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -concept.isEntity(); ----- - [#_bool_TypeDBConceptisEntityType___] ==== isEntityType @@ -377,13 +279,6 @@ Checks if the concept is an ``EntityType``. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -concept.isEntityType(); ----- - [#_bool_TypeDBConceptisRelation___] ==== isRelation @@ -401,13 +296,6 @@ Checks if the concept is a ``Value``. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -concept.isValue(); ----- - [#_bool_TypeDBConceptisRelationType___] ==== isRelationType @@ -425,13 +313,6 @@ Checks if the concept is a ``RelationType``. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -concept.isRelationType(); ----- - [#_bool_TypeDBConceptisRoleType___] ==== isRoleType @@ -449,13 +330,6 @@ Checks if the concept is a ``RoleType``. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -concept.isRoleType(); ----- - [#_bool_TypeDBConceptisThing___] ==== isThing @@ -473,13 +347,6 @@ Checks if the concept is a ``Thing``. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -concept.isThing(); ----- - [#_bool_TypeDBConceptisThingType___] ==== isThingType @@ -497,13 +364,6 @@ Checks if the concept is a ``ThingType``. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -concept.isThingType(); ----- - [#_bool_TypeDBConceptisValue___] ==== isValue @@ -521,13 +381,6 @@ Checks if the concept is a ``Value``. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -concept.isValue(); ----- - [#_bool_TypeDBConceptoperator___const_Concept__other_] ==== operator== diff --git a/cpp/docs/concept/ConceptManager.adoc b/cpp/docs/concept/ConceptManager.adoc index 76899cfa92..913c2c3218 100644 --- a/cpp/docs/concept/ConceptManager.adoc +++ b/cpp/docs/concept/ConceptManager.adoc @@ -34,13 +34,6 @@ a| `iid` a| The iid of the ``Attribute`` to retrieve a| `const std::string&` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.getAttribute(iid).get(); ----- - [#_ConceptPtrFuture__AttributeType___TypeDBConceptManagergetAttributeType___const_stdstring__label___const] ==== getAttributeType @@ -67,13 +60,6 @@ a| `label` a| The label of the ``AttributeType`` to retrieve a| `const std::stri .Returns `ConceptPtrFuture< AttributeType >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.getAttributeType(label).get(); ----- - [#_ConceptPtrFuture__Entity___TypeDBConceptManagergetEntity___const_stdstring__iid___const] ==== getEntity @@ -100,13 +86,6 @@ a| `iid` a| The iid of the ``Entity`` to retrieve a| `const std::string&` .Returns `ConceptPtrFuture< Entity >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.getEntity(iid).get(); ----- - [#_ConceptPtrFuture__EntityType___TypeDBConceptManagergetEntityType___const_stdstring__label___const] ==== getEntityType @@ -133,13 +112,6 @@ a| `label` a| The label of the ``EntityType`` to retrieve a| `const std::string& .Returns `ConceptPtrFuture< EntityType >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.getEntityType(label).get(); ----- - [#_ConceptPtrFuture__Relation___TypeDBConceptManagergetRelation___const_stdstring__iid___const] ==== getRelation @@ -166,13 +138,6 @@ a| `iid` a| The iid of the ``Relation`` to retrieve a| `const std::string&` .Returns `ConceptPtrFuture< Relation >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.getRelation(iid).get(); ----- - [#_ConceptPtrFuture__RelationType___TypeDBConceptManagergetRelationType___const_stdstring__label___const] ==== getRelationType @@ -199,13 +164,6 @@ a| `label` a| The label of the ``RelationType`` to retrieve a| `const std::strin .Returns `ConceptPtrFuture< RelationType >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.getRelationType(label).get(); ----- - [#_stdunique_ptr__AttributeType___TypeDBConceptManagergetRootAttributeType_____const] ==== getRootAttributeType @@ -223,13 +181,6 @@ Retrieve the root ``AttributeType``, “attribute”. .Returns `std::unique_ptr< AttributeType >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.getRootAttributeType(); ----- - [#_stdunique_ptr__EntityType___TypeDBConceptManagergetRootEntityType_____const] ==== getRootEntityType @@ -247,13 +198,6 @@ Retrieves the root ``EntityType``, “entity”. .Returns `std::unique_ptr< EntityType >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.getRootEntityType(); ----- - [#_stdunique_ptr__RelationType___TypeDBConceptManagergetRootRelationType_____const] ==== getRootRelationType @@ -271,13 +215,6 @@ Retrieve the root ``RelationType``, “relation”. .Returns `std::unique_ptr< RelationType >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.getRootRelationType(); ----- - [#_stdvector__DriverException___TypeDBConceptManagergetSchemaExceptions___] ==== getSchemaExceptions @@ -295,13 +232,6 @@ Retrieves a list of all schema exceptions for the current transaction. .Returns `std::vector< DriverException >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.getSchemaExceptions(); ----- - [#_ConceptPtrFuture__AttributeType___TypeDBConceptManagerputAttributeType___const_stdstring__label__ValueType_valueType___const] ==== putAttributeType @@ -329,13 +259,6 @@ a| `valueType` a| The value type of the ``AttributeType`` to create a| `ValueTyp .Returns `ConceptPtrFuture< AttributeType >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.putAttributeType(label, valueType).get(); ----- - [#_ConceptPtrFuture__EntityType___TypeDBConceptManagerputEntityType___const_stdstring__label___const] ==== putEntityType @@ -362,13 +285,6 @@ a| `label` a| The label of the ``EntityType`` to create or retrieve a| `const st .Returns `ConceptPtrFuture< EntityType >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.putEntityType(label).get(); ----- - [#_ConceptPtrFuture__RelationType___TypeDBConceptManagerputRelationType___const_stdstring__label___const] ==== putRelationType @@ -395,12 +311,5 @@ a| `label` a| The label of the ``RelationType`` to create or retrieve a| `const .Returns `ConceptPtrFuture< RelationType >` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.concepts.putRelationType(label).get(); ----- - // end::methods[] diff --git a/cpp/docs/connection/Database.adoc b/cpp/docs/connection/Database.adoc index d3f25e90b7..ddb28aef28 100644 --- a/cpp/docs/connection/Database.adoc +++ b/cpp/docs/connection/Database.adoc @@ -25,13 +25,6 @@ Deletes this database. .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -database.deleteDatabase() ----- - [#_stdstring_TypeDBDatabasename_____const] ==== name @@ -65,13 +58,6 @@ Returns the preferred replica for this database. Operations which can be run on .Returns `std::optional< ReplicaInfo >` -[caption=""] -.Code examples -[source,cpp] ----- -database.preferredReplica() ----- - [#_stdoptional__ReplicaInfo___TypeDBDatabaseprimaryReplica___] ==== primaryReplica @@ -89,13 +75,6 @@ Returns the primary replica for this database. _Only works in TypeDB Cloud_ .Returns `std::optional< ReplicaInfo >` -[caption=""] -.Code examples -[source,cpp] ----- -database.primaryReplica() ----- - [#_ReplicaInfoIterable_TypeDBDatabasereplicas___] ==== replicas @@ -113,13 +92,6 @@ Set of ``Replica`` instances for this database. Only works in TypeDB Cloud .Returns `ReplicaInfoIterable` -[caption=""] -.Code examples -[source,cpp] ----- -database.replicas() ----- - [#_stdstring_TypeDBDatabaseruleSchema___] ==== ruleSchema @@ -137,13 +109,6 @@ The rules in the schema as a valid TypeQL define query string. .Returns `std::string` -[caption=""] -.Code examples -[source,cpp] ----- -database.ruleSchema() ----- - [#_stdstring_TypeDBDatabaseschema___] ==== schema @@ -161,13 +126,6 @@ A full schema text as a valid TypeQL define query string. .Returns `std::string` -[caption=""] -.Code examples -[source,cpp] ----- -database.schema() ----- - [#_stdstring_TypeDBDatabasetypeSchema___] ==== typeSchema @@ -185,12 +143,5 @@ The types in the schema as a valid TypeQL define query string. .Returns `std::string` -[caption=""] -.Code examples -[source,cpp] ----- -database.typeSchema() ----- - // end::methods[] diff --git a/cpp/docs/connection/DatabaseManager.adoc b/cpp/docs/connection/DatabaseManager.adoc index 6bc7e16c96..6119e15927 100644 --- a/cpp/docs/connection/DatabaseManager.adoc +++ b/cpp/docs/connection/DatabaseManager.adoc @@ -25,13 +25,6 @@ Retrieves all databases present on the TypeDB server .Returns `DatabaseIterable` -[caption=""] -.Code examples -[source,cpp] ----- -driver.databases.all() ----- - [#_bool_TypeDBDatabaseManagercontains___const_stdstring____const] ==== contains @@ -58,13 +51,6 @@ a| `name` a| The database name to be checked a| .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -driver.databases.contains(name) ----- - [#_void_TypeDBDatabaseManagercreate___const_stdstring____const] ==== create @@ -91,13 +77,6 @@ a| `name` a| The name of the database to be created a| .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -driver.databases.create(name) ----- - [#_Database_TypeDBDatabaseManagerget___const_stdstring____const] ==== get @@ -124,12 +103,5 @@ a| `name` a| The name of the database to retrieve a| .Returns `Database` -[caption=""] -.Code examples -[source,cpp] ----- -driver.databases.get(name) ----- - // end::methods[] diff --git a/cpp/docs/connection/Driver.adoc b/cpp/docs/connection/Driver.adoc index 18324459e7..0be4186459 100644 --- a/cpp/docs/connection/Driver.adoc +++ b/cpp/docs/connection/Driver.adoc @@ -37,13 +37,6 @@ Closes the driver. Before instantiating a new driver, the driver that’s curren .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -driver.close() ----- - [#_static_Driver_TypeDBDrivercloudDriver___const_stdvector__stdstring____cloudAddresses__const_Credential__credential_] ==== cloudDriver @@ -71,13 +64,6 @@ a| `credential` a| The Credential to connect with a| `const Credential&` .Returns `static Driver` -[caption=""] -.Code examples -[source,cpp] ----- -Driver::cloudDriver(addresses, credential); ----- - [#_static_Driver_TypeDBDrivercoreDriver___const_stdstring__coreAddress_] ==== coreDriver @@ -104,13 +90,6 @@ a| `address` a| The address of the TypeDB server a| .Returns `static Driver` -[caption=""] -.Code examples -[source,cpp] ----- -Driver::coreDriver(address); ----- - [#_static_void_TypeDBDriverinitLogging___] ==== initLogging @@ -128,13 +107,6 @@ Enables logging in the TypeDB driver. .Returns `static void` -[caption=""] -.Code examples -[source,cpp] ----- -Driver::initLogging(); ----- - [#_bool_TypeDBDriverisOpen___] ==== isOpen @@ -152,13 +124,6 @@ Checks whether this connection is presently open. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -driver.isOpen(); ----- - [#_Session_TypeDBDriversession___const_stdstring__database__SessionType_sessionType__const_Options__options__Options___] ==== session @@ -187,13 +152,6 @@ a| `options` a| ``TypeDBOptions`` for the session a| .Returns `Session` -[caption=""] -.Code examples -[source,cpp] ----- -driver.session(database, sessionType, options); ----- - [#_User_TypeDBDriveruser___] ==== user @@ -211,12 +169,5 @@ Returns the logged-in user for the connection. Only for TypeDB Cloud. .Returns `User` -[caption=""] -.Code examples -[source,cpp] ----- -driver.user(); ----- - // end::methods[] diff --git a/cpp/docs/connection/UserManager.adoc b/cpp/docs/connection/UserManager.adoc index 2152ae91e3..a850ff9c1e 100644 --- a/cpp/docs/connection/UserManager.adoc +++ b/cpp/docs/connection/UserManager.adoc @@ -25,13 +25,6 @@ Retrieves all users which exist on the TypeDB server. .Returns `UserIterable` -[caption=""] -.Code examples -[source,cpp] ----- -driver.users.all(); ----- - [#_bool_TypeDBUserManagercontains___const_stdstring__username___const] ==== contains @@ -58,13 +51,6 @@ a| `username` a| The user name to be checked a| `const std::string&` .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -driver.users.contains(username); ----- - [#_void_TypeDBUserManagercreate___const_stdstring__username__const_stdstring__password___const] ==== create @@ -92,13 +78,6 @@ a| `password` a| The password of the user to be created a| `const std::string&` .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -driver.users.create(username, password); ----- - [#_void_TypeDBUserManagerdeleteUser___const_stdstring__username___const] ==== deleteUser @@ -125,13 +104,6 @@ a| `username` a| The name of the user to be deleted a| `const std::string&` .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -driver.users.deleteUser(username); ----- - [#_stdunique_ptr__User___TypeDBUserManagerget___const_stdstring__username___const] ==== get @@ -158,13 +130,6 @@ a| `username` a| The name of the user to retrieve a| `const std::string&` .Returns `std::unique_ptr< User >` -[caption=""] -.Code examples -[source,cpp] ----- -driver.users.get(username); ----- - [#_void_TypeDBUserManagerpasswordSet___const_stdstring__username__const_stdstring__password___const] ==== passwordSet @@ -192,12 +157,5 @@ a| `password` a| The new password a| `const std::string&` .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -driver.users.passwordSet(username, password); ----- - // end::methods[] diff --git a/cpp/docs/data/Attribute.adoc b/cpp/docs/data/Attribute.adoc index f4e59008da..e8556af852 100644 --- a/cpp/docs/data/Attribute.adoc +++ b/cpp/docs/data/Attribute.adoc @@ -41,13 +41,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< Thing >` -[caption=""] -.Code examples -[source,cpp] ----- -attribute.getOwners(transaction); ----- - [#_ConceptIterable__Thing___TypeDBAttributegetOwners___Transaction__transaction__const_ThingType__ptr__ownerType_] ==== getOwners @@ -75,13 +68,6 @@ a| `ownerType` a| Filter results for only owners of the given type a| `const Thi .Returns `ConceptIterable< Thing >` -[caption=""] -.Code examples -[source,cpp] ----- -attribute.getOwners(transaction, ownerType); ----- - [#_stdunique_ptr__AttributeType___TypeDBAttributegetType___] ==== getType @@ -99,13 +85,6 @@ Retrieves the type which this ``Attribute`` belongs to. .Returns `std::unique_ptr< AttributeType >` -[caption=""] -.Code examples -[source,cpp] ----- -attribute.getType(); ----- - [#_stdunique_ptr__Value___TypeDBAttributegetValue___] ==== getValue @@ -123,12 +102,5 @@ Retrieves the value which the ``Attribute`` instance holds. .Returns `std::unique_ptr< Value >` -[caption=""] -.Code examples -[source,cpp] ----- -attribute.getValue(); ----- - // end::methods[] diff --git a/cpp/docs/data/Entity.adoc b/cpp/docs/data/Entity.adoc index e70b11a7de..7292eb9420 100644 --- a/cpp/docs/data/Entity.adoc +++ b/cpp/docs/data/Entity.adoc @@ -32,12 +32,5 @@ Retrieves the type which this ``Entity`` belongs to. .Returns `std::unique_ptr< EntityType >` -[caption=""] -.Code examples -[source,cpp] ----- -entity.getType(); ----- - // end::methods[] diff --git a/cpp/docs/data/Relation.adoc b/cpp/docs/data/Relation.adoc index 17c5ce4232..01965a6ca3 100644 --- a/cpp/docs/data/Relation.adoc +++ b/cpp/docs/data/Relation.adoc @@ -43,13 +43,6 @@ a| `player` a| The thing to play the role a| `Thing*` .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -relation.addPlayer(transaction, roleType, player).get(); ----- - [#_stdmap__stdunique_ptr__RoleType____stdunique_ptr__Thing_____TypeDBRelationgetPlayers___Transaction__transaction_] ==== getPlayers @@ -76,13 +69,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `std::map< std::unique_ptr< RoleType >, std::unique_ptr< Thing > >` -[caption=""] -.Code examples -[source,cpp] ----- -relation.getPlayers(transaction) ----- - [#_ConceptIterable__Thing___TypeDBRelationgetPlayersByRoleType___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes_] ==== getPlayersByRoleType @@ -110,13 +96,6 @@ a| `roleTypes` a| 0 or more role types a| `const std::vector< std::unique_ptr< R .Returns `ConceptIterable< Thing >` -[caption=""] -.Code examples -[source,cpp] ----- -relation.getPlayersByRoleType(transaction, roleTypes); ----- - [#_ConceptIterable__Thing___TypeDBRelationgetPlayersByRoleType___Transaction__transaction__const_stdvector__RoleType__ptr_____roleTypes_] ==== getPlayersByRoleType @@ -159,13 +138,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< RoleType >` -[caption=""] -.Code examples -[source,cpp] ----- -relation.getRelating(transaction); ----- - [#_stdunique_ptr__RelationType___TypeDBRelationgetType___] ==== getType @@ -183,13 +155,6 @@ Retrieves the type which this ``Relation`` belongs to. .Returns `std::unique_ptr< RelationType >` -[caption=""] -.Code examples -[source,cpp] ----- -relation.getType(); ----- - [#_VoidFuture_TypeDBRelationremovePlayer___Transaction__transaction__RoleType__ptr__roleType__Thing__ptr__player_] ==== removePlayer @@ -218,12 +183,5 @@ a| `player` a| The instance to no longer play the role in this ``Relation`` a| ` .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -relation.removePlayer(transaction, roleType, player).get(); ----- - // end::methods[] diff --git a/cpp/docs/data/Thing.adoc b/cpp/docs/data/Thing.adoc index 73958f85c1..52b8aeb9f8 100644 --- a/cpp/docs/data/Thing.adoc +++ b/cpp/docs/data/Thing.adoc @@ -38,13 +38,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -thing.deleteThing(transaction).get(); ----- - [#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdinitializer_list__Annotation____annotations___] ==== getHas @@ -72,14 +65,6 @@ a| `annotations` a| Only retrieve attributes with all given ``Annotation``s a| .Returns `ConceptIterable< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -thing.getHas(transaction); -thing.getHas(transaction, {Annotation.key()})); ----- - [#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_AttributeType__ptr__attribute_] ==== getHas @@ -123,13 +108,6 @@ a| `attributeTypes` a| The ``AttributeType``s to filter the attributes by a| `co .Returns `ConceptIterable< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -thing.getHas(transaction, attributeTypes); ----- - [#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__const_AttributeType__ptr_____attributeTypes_] ==== getHas @@ -179,13 +157,6 @@ Retrieves the unique id of the ``Thing``. .Returns `std::string` -[caption=""] -.Code examples -[source,cpp] ----- -thing.getIID(); ----- - [#_ConceptIterable__RoleType___TypeDBThinggetPlaying___Transaction__transaction_] ==== getPlaying @@ -212,13 +183,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< RoleType >` -[caption=""] -.Code examples -[source,cpp] ----- -thing.getPlaying(transaction); ----- - [#_ConceptIterable__Relation___TypeDBThinggetRelations___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes___] ==== getRelations @@ -246,14 +210,6 @@ a| `roleTypes` a| The array of roles to filter the relations by. a| .Returns `ConceptIterable< Relation >` -[caption=""] -.Code examples -[source,cpp] ----- -thing.getRelations(transaction); -thing.getRelations(transaction, roleTypes); ----- - [#_ConceptIterable__Relation___TypeDBThinggetRelations___Transaction__transaction__const_stdvector__RoleType__ptr_____roleTypes_] ==== getRelations @@ -287,13 +243,6 @@ Retrieves the type which this ``Thing`` belongs to. .Returns `std::unique_ptr< ThingType >` -[caption=""] -.Code examples -[source,cpp] ----- -thing.getType(); ----- - [#_BoolFuture_TypeDBThingisDeleted___Transaction__transaction_] ==== isDeleted @@ -320,13 +269,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `BoolFuture` -[caption=""] -.Code examples -[source,cpp] ----- -thing.isDeleted(transaction).get(); ----- - [#_bool_TypeDBThingisInferred___] ==== isInferred @@ -344,13 +286,6 @@ Checks if this ``Thing`` is inferred by a [Reasoning Rule]. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -thing.isInferred(); ----- - [#_VoidFuture_TypeDBThingsetHas___Transaction__transaction__Attribute__ptr__attribute_] ==== setHas @@ -378,13 +313,6 @@ a| `attribute` a| The ``Attribute`` to be owned by this ``Thing``. a| `Attribute .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -thing.setHas(transaction, attribute).get(); ----- - [#_VoidFuture_TypeDBThingunsetHas___Transaction__transaction__Attribute__ptr__attribute_] ==== unsetHas @@ -412,12 +340,5 @@ a| `attribute` a| The ``Attribute`` to be disowned from this ``Thing``. a| `Attr .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -thing.unsetHas(transaction, attribute).get(); ----- - // end::methods[] diff --git a/cpp/docs/data/Value.adoc b/cpp/docs/data/Value.adoc index 42dd6ff7ac..45bc424bc3 100644 --- a/cpp/docs/data/Value.adoc +++ b/cpp/docs/data/Value.adoc @@ -29,13 +29,6 @@ Returns a ``boolean`` value of this value concept. If the value has another type .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -value.asBoolean(); ----- - [#_DateTime_TypeDBValueasDateTime___] ==== asDateTime @@ -53,13 +46,6 @@ Returns a ``DateTime`` value of this value concept. If the value has another typ .Returns `DateTime` -[caption=""] -.Code examples -[source,cpp] ----- -value.asDatetime(); ----- - [#_double_TypeDBValueasDouble___] ==== asDouble @@ -77,13 +63,6 @@ Returns a ``double`` value of this value concept. If the value has another type, .Returns `double` -[caption=""] -.Code examples -[source,cpp] ----- -value.asDouble(); ----- - [#_int64_t_TypeDBValueasLong___] ==== asLong @@ -101,13 +80,6 @@ Returns a ``long`` value of this value concept. If the value has another type, r .Returns `int64_t` -[caption=""] -.Code examples -[source,cpp] ----- -value.asLong(); ----- - [#_stdstring_TypeDBValueasString___] ==== asString @@ -125,13 +97,6 @@ Returns a ``string`` value of this value concept. If the value has another type, .Returns `std::string` -[caption=""] -.Code examples -[source,cpp] ----- -value.asString(); ----- - [#_static_stdstring_TypeDBValueformatDateTime___DateTime_t_] ==== formatDateTime @@ -149,13 +114,6 @@ Returns a string in the TypeQL DateTime format corresponding to the specified Da .Returns `static std::string` -[caption=""] -.Code examples -[source,cpp] ----- -Value::formatDateTime(datetime); ----- - [#_bool_TypeDBValueisBoolean___] ==== isBoolean @@ -173,13 +131,6 @@ Returns ``true`` if the value which this value concept holds is of type ``boolea .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -value.isBoolean() ----- - [#_bool_TypeDBValueisDateTime___] ==== isDateTime @@ -197,13 +148,6 @@ Returns ``True`` if the value which this value concept holds is of type ``DateTi .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -value.isDatetime(); ----- - [#_bool_TypeDBValueisDouble___] ==== isDouble @@ -221,13 +165,6 @@ Returns ``true`` if the value which this value concept holds is of type ``double .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -value.isDouble(); ----- - [#_bool_TypeDBValueisLong___] ==== isLong @@ -245,13 +182,6 @@ Returns ``true`` if the value which this value concept holds is of type ``long`` .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -value.isLong() ----- - [#_bool_TypeDBValueisString___] ==== isString @@ -269,13 +199,6 @@ Returns ``true`` if the value which this value concept holds is of type ``string .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -value.isString(); ----- - [#_static_stdunique_ptr__Value___TypeDBValueof___bool_value_] ==== of @@ -293,13 +216,6 @@ Creates a new Value object of the specified boolean value. .Returns `static std::unique_ptr< Value >` -[caption=""] -.Code examples -[source,cpp] ----- -Value::of(value); ----- - [#_static_stdunique_ptr__Value___TypeDBValueof___int64_t_value_] ==== of @@ -317,13 +233,6 @@ Creates a new Value object of the specified long value. .Returns `static std::unique_ptr< Value >` -[caption=""] -.Code examples -[source,cpp] ----- -Value::of(value); ----- - [#_static_stdunique_ptr__Value___TypeDBValueof___double_value_] ==== of @@ -341,13 +250,6 @@ Creates a new Value object of the specified double value. .Returns `static std::unique_ptr< Value >` -[caption=""] -.Code examples -[source,cpp] ----- -Value::of(value); ----- - [#_static_stdunique_ptr__Value___TypeDBValueof___const_stdstring__value_] ==== of @@ -365,13 +267,6 @@ Creates a new Value object of the specified string value. .Returns `static std::unique_ptr< Value >` -[caption=""] -.Code examples -[source,cpp] ----- -Value::of(value); ----- - [#_static_stdunique_ptr__Value___TypeDBValueof___DateTime_value_] ==== of @@ -389,13 +284,6 @@ Creates a new Value object of the specified DateTime value. .Returns `static std::unique_ptr< Value >` -[caption=""] -.Code examples -[source,cpp] ----- -Value::of(value); ----- - [#_static_DateTime_TypeDBValueparseDateTime___const_stdstring__s_] ==== parseDateTime @@ -413,13 +301,6 @@ Parses a DateTime from a string in the TypeQL DateTime format (yyyy-mm-dd'T'HH:M .Returns `static DateTime` -[caption=""] -.Code examples -[source,cpp] ----- -Value::parseDateTime(str); ----- - [#_ValueType_TypeDBValuevalueType___] ==== valueType @@ -437,12 +318,5 @@ Retrieves the ``ValueType`` of this value concept. .Returns `ValueType` -[caption=""] -.Code examples -[source,cpp] ----- -value.getType() ----- - // end::methods[] diff --git a/cpp/docs/errors/DriverException.adoc b/cpp/docs/errors/DriverException.adoc index 211e889679..3e1df49ecd 100644 --- a/cpp/docs/errors/DriverException.adoc +++ b/cpp/docs/errors/DriverException.adoc @@ -25,16 +25,6 @@ Retrieves the error code. .Returns `const std::string_view` -[caption=""] -.Code examples -[source,cpp] ----- -try { ... } -catch (TypeDB::DriverException& e){ - if ("[CXN11]" == e.code()) { ... } -} ----- - [#_const_stdstring_view_TypeDBDriverExceptionmessage___] ==== message @@ -52,16 +42,5 @@ Retrieves the descriptive error message. .Returns `const std::string_view` -[caption=""] -.Code examples -[source,cpp] ----- -try { ... } -catch (TypeDB::DriverException& e){ - logError(e.message()); - throw e; -} ----- - // end::methods[] diff --git a/cpp/docs/logic/LogicManager.adoc b/cpp/docs/logic/LogicManager.adoc index 9843845f8f..95eed7b458 100644 --- a/cpp/docs/logic/LogicManager.adoc +++ b/cpp/docs/logic/LogicManager.adoc @@ -34,13 +34,6 @@ a| `label` a| The label of the Rule to create or retrieve a| `const std::string& .Returns `OptionalRuleFuture` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.logic.getRule(label).get(); ----- - [#_RuleIterable_TypeDBLogicManagergetRules_____const] ==== getRules @@ -58,13 +51,6 @@ Retrieves all rules. .Returns `RuleIterable` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.logic.getRules() ----- - [#_RuleFuture_TypeDBLogicManagerputRule___const_stdstring__label__const_stdstring__when__const_stdstring__then___const] ==== putRule @@ -93,12 +79,5 @@ a| `then` a| The then body of the rule to create a| `const std::string&` .Returns `RuleFuture` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.logic.putRule(label, when, then).get(); ----- - // end::methods[] diff --git a/cpp/docs/logic/Rule.adoc b/cpp/docs/logic/Rule.adoc index fae4a2ef9b..32dc7ab46a 100644 --- a/cpp/docs/logic/Rule.adoc +++ b/cpp/docs/logic/Rule.adoc @@ -36,13 +36,6 @@ a| `transaction` a| The current ``Transaction`` a| `Transaction&` .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -rule.deleteRule(transaction).get(); ----- - [#_BoolFuture_TypeDBRuleisDeleted___Transaction__transaction_] ==== isDeleted @@ -69,13 +62,6 @@ a| `transaction` a| The current ``Transaction`` a| `Transaction&` .Returns `BoolFuture` -[caption=""] -.Code examples -[source,cpp] ----- -rule.isDeleted(transaction).get(); ----- - [#_stdstring_TypeDBRulelabel___] ==== label @@ -119,13 +105,6 @@ a| `label` a| The new label to be given to the rule a| `const std::string&` .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -rule.setLabel(transaction, newLabel).get(); ----- - [#_stdstring_TypeDBRulethen___] ==== then diff --git a/cpp/docs/schema/Annotation.adoc b/cpp/docs/schema/Annotation.adoc index 72c12c3a9c..3a588017bb 100644 --- a/cpp/docs/schema/Annotation.adoc +++ b/cpp/docs/schema/Annotation.adoc @@ -25,13 +25,6 @@ Checks if this ``Annotation`` is a ``@key`` annotation. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -annotation.isKey(); ----- - [#_bool_TypeDBAnnotationisUnique___] ==== isUnique @@ -49,13 +42,6 @@ Checks if this ``Annotation`` is a ``@unique`` annotation. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -annotation.isUnique(); ----- - [#_static_Annotation_TypeDBAnnotationkey___] ==== key @@ -73,13 +59,6 @@ Produces a ``@key`` annotation. .Returns `static Annotation` -[caption=""] -.Code examples -[source,cpp] ----- -ThingType.Annotation.key(); ----- - [#_stdstring_TypeDBAnnotationtoString___] ==== toString @@ -113,12 +92,5 @@ Produces a ``@unique`` annotation. .Returns `static Annotation` -[caption=""] -.Code examples -[source,cpp] ----- -Annotation.unique(); ----- - // end::methods[] diff --git a/cpp/docs/schema/AttributeType.adoc b/cpp/docs/schema/AttributeType.adoc index 7d369bd848..cb6e1b7d3a 100644 --- a/cpp/docs/schema/AttributeType.adoc +++ b/cpp/docs/schema/AttributeType.adoc @@ -47,13 +47,6 @@ a| `value` a| ``Attribute``’s value a| `Value*` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.get(transaction, value).get(); ----- - [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__const_stdstring__value_] ==== get @@ -81,13 +74,6 @@ a| `value` a| ``Attribute``’s value a| `const std::string&` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.get(transaction, value).get(); ----- - [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__int64_t_value_] ==== get @@ -115,13 +101,6 @@ a| `value` a| ``Attribute``’s value a| `int64_t` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.get(transaction, value).get(); ----- - [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__double_value_] ==== get @@ -149,13 +128,6 @@ a| `value` a| ``Attribute``’s value a| `double` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.get(transaction, value).get(); ----- - [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__bool_value_] ==== get @@ -183,13 +155,6 @@ a| `value` a| ``Attribute``’s value a| `bool` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.get(transaction, value).get(); ----- - [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__DateTime_value_] ==== get @@ -217,13 +182,6 @@ a| `value` a| ``Attribute``’s value a| `DateTime` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.get(transaction, value).get(); ----- - [#_ConceptIterable__Attribute___TypeDBAttributeTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getInstances @@ -251,18 +209,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.getInstances(transaction); -attributeType.getInstances(transaction, transitivity); - Parameters - - transitivity Transitivity::TRANSITIVE for direct and indirect subtypes, Transitivity::EXPLICIT for direct subtypes only - transaction The current transaction ----- - [#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getOwners @@ -290,13 +236,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< ThingType >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.getOwners(transaction); ----- - [#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Transaction__transaction__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getOwners @@ -325,35 +264,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< ThingType >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.getOwners(transaction, {Annotation::key()}, transitivity); - */ -ConceptIterable getOwners(Transaction& transaction, const std::initializer_list& annotations, Transitivity transitivity = Transitivity::TRANSITIVE); - -/** - Retrieve all Things that own an attribute of this AttributeType, - filtered by Annotations, directly or through inheritance. - - Examples ----- - -[source,cpp] ----- -attributeType.getOwners(transaction, annotations); ----- - -[source,cpp] ----- -Parameters - - transaction The current transaction - annotations Only retrieve ThingTypes that have an attribute of this AttributeType with all given Annotations - transitivity Transitivity::TRANSITIVE for direct and indirect subtypes, Transitivity::EXPLICIT for direct subtypes only ----- - [#_OptionalStringFuture_TypeDBAttributeTypegetRegex___Transaction__transaction_] ==== getRegex @@ -380,13 +290,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `OptionalStringFuture` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.getRegex(transaction).get(); ----- - [#_ConceptIterable__AttributeType___TypeDBAttributeTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -414,14 +317,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< AttributeType >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.getSubtypes(transaction); -attributeType.getSubtypes(transaction, transitivity); ----- - [#_ConceptIterable__AttributeType___TypeDBAttributeTypegetSubtypes___Transaction__transaction__ValueType_valueType__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -450,13 +345,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< AttributeType >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.getSubtypes(transaction, valueType, transitivity); ----- - [#_ValueType_TypeDBAttributeTypegetValueType___] ==== getValueType @@ -474,13 +362,6 @@ Retrieves the ``Value.Type`` of this ``AttributeType``. .Returns `ValueType` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.getValueType(); ----- - [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__Value__ptr__value_] ==== put @@ -508,13 +389,6 @@ a| `value` a| New ``Attribute``’s value a| `Value*` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.put(transaction, value).get(); ----- - [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__const_stdstring__value_] ==== put @@ -542,13 +416,6 @@ a| `value` a| New ``Attribute``’s value a| `const std::string&` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.put(transaction, value).get(); ----- - [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__int64_t_value_] ==== put @@ -576,13 +443,6 @@ a| `value` a| New ``Attribute``’s value a| `int64_t` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.put(transaction, value).get(); ----- - [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__double_value_] ==== put @@ -610,13 +470,6 @@ a| `value` a| New ``Attribute``’s value a| `double` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.put(transaction, value).get(); ----- - [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__bool_value_] ==== put @@ -644,13 +497,6 @@ a| `value` a| New ``Attribute``’s value a| `bool` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.put(transaction, value).get(); ----- - [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__DateTime_value_] ==== put @@ -678,13 +524,6 @@ a| `value` a| New ``Attribute``’s value a| `DateTime` .Returns `ConceptPtrFuture< Attribute >` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.put(transaction, value).get(); ----- - [#_VoidFuture_TypeDBAttributeTypesetRegex___Transaction__transaction__const_stdstring__regex_] ==== setRegex @@ -714,13 +553,6 @@ a| `regex` a| Regular expression a| `const std::string&` .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.setRegex(transaction, regex).get(); ----- - [#_VoidFuture_TypeDBAttributeTypesetSupertype___Transaction__transaction__AttributeType__ptr__attributeType_] ==== setSupertype @@ -748,13 +580,6 @@ a| `attributeType` a| The ``AttributeType`` to set as the supertype of this ``At .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.setSupertype(transaction, superType).get(); ----- - [#_VoidFuture_TypeDBAttributeTypeunsetRegex___Transaction__transaction_] ==== unsetRegex @@ -781,12 +606,5 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -attributeType.unsetRegex(transaction).get(); ----- - // end::methods[] diff --git a/cpp/docs/schema/EntityType.adoc b/cpp/docs/schema/EntityType.adoc index 138a3fbfd3..082b09279d 100644 --- a/cpp/docs/schema/EntityType.adoc +++ b/cpp/docs/schema/EntityType.adoc @@ -40,13 +40,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< Entity >` -[caption=""] -.Code examples -[source,cpp] ----- -entityType.create(transaction).get(); ----- - [#_ConceptIterable__Entity___TypeDBEntityTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getInstances @@ -74,13 +67,6 @@ a| `transitivity` a| ``Transitivity::EXPLICIT`` for direct instances only, ``Tra .Returns `ConceptIterable< Entity >` -[caption=""] -.Code examples -[source,cpp] ----- -entityType.getInstances(transaction, transitivity); ----- - [#_ConceptIterable__EntityType___TypeDBEntityTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -108,13 +94,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< EntityType >` -[caption=""] -.Code examples -[source,cpp] ----- -entityType.getSubtypes(transaction, transitivity); ----- - [#_VoidFuture_TypeDBEntityTypesetSupertype___Transaction__transaction__EntityType__ptr__superEntityType_] ==== setSupertype @@ -142,12 +121,5 @@ a| `superEntityType` a| The ``EntityType`` to set as the supertype of this ``Ent .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -entityType.setSupertype(transaction, entityType).get(); ----- - // end::methods[] diff --git a/cpp/docs/schema/RelationType.adoc b/cpp/docs/schema/RelationType.adoc index 63f3b3fa9f..6b38e23af6 100644 --- a/cpp/docs/schema/RelationType.adoc +++ b/cpp/docs/schema/RelationType.adoc @@ -42,13 +42,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< Relation >` -[caption=""] -.Code examples -[source,cpp] ----- -relationType.create(transaction).get(); ----- - [#_ConceptIterable__Relation___TypeDBRelationTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getInstances @@ -76,13 +69,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect instan .Returns `ConceptIterable< Relation >` -[caption=""] -.Code examples -[source,cpp] ----- -relationType.getInstances(transaction, transitivity) ----- - [#_ConceptIterable__RoleType___TypeDBRelationTypegetRelates___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getRelates @@ -110,13 +96,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and inherited relat .Returns `ConceptIterable< RoleType >` -[caption=""] -.Code examples -[source,cpp] ----- -relationType.getRelates(transaction, transitivity); ----- - [#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelates___Transaction__transaction__const_stdstring__roleLabel_] ==== getRelates @@ -144,13 +123,6 @@ a| `roleLabel` a| Label of the role we wish to retrieve a| `const std::string&` .Returns `ConceptPtrFuture< RoleType >` -[caption=""] -.Code examples -[source,cpp] ----- -relationType.getRelates(transaction, roleLabel).get(); ----- - [#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelatesOverridden___Transaction__transaction__RoleType__ptr__roleType_] ==== getRelatesOverridden @@ -178,13 +150,6 @@ a| `roleLabel` a| Label of the role that overrides an inherited role a| .Returns `ConceptPtrFuture< RoleType >` -[caption=""] -.Code examples -[source,cpp] ----- -relationType.getRelatesOverridden(transaction, roleLabel).get(); ----- - [#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelatesOverridden___Transaction__transaction__const_stdstring__roleLabel_] ==== getRelatesOverridden @@ -212,13 +177,6 @@ a| `roleLabel` a| Label of the role that overrides an inherited role a| `const s .Returns `ConceptPtrFuture< RoleType >` -[caption=""] -.Code examples -[source,cpp] ----- -relationType.getRelatesOverridden(transaction, roleLabel).get(); ----- - [#_ConceptIterable__RelationType___TypeDBRelationTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -246,13 +204,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< RelationType >` -[caption=""] -.Code examples -[source,cpp] ----- -relationType.getSubtypes(transaction, transitivity); ----- - [#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel_] ==== setRelates @@ -313,14 +264,6 @@ a| `overriddenLabel` a| The label being overridden, if applicable a| `const std: .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -relationType.setRelates(transaction, roleLabel).get(); -relationType.setRelates(transaction, roleLabel, overriddenLabel).get(); ----- - [#_VoidFuture_TypeDBRelationTypesetSupertype___Transaction__transaction__RelationType__ptr__superRelationType_] ==== setSupertype @@ -348,13 +291,6 @@ a| `superRelationType` a| The ``RelationType`` to set as the supertype of this ` .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -relationType.setSupertype(transaction, superRelationType).get(); ----- - [#_VoidFuture_TypeDBRelationTypeunsetRelates___Transaction__transaction__RoleType__ptr__roleType_] ==== unsetRelates @@ -398,12 +334,5 @@ a| `roleLabel` a| The role to not relate to the relation type. a| `const std::st .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -relationType.unsetRelates(transaction, roleLabel).get(); ----- - // end::methods[] diff --git a/cpp/docs/schema/RoleType.adoc b/cpp/docs/schema/RoleType.adoc index b7ae22d737..fd5fe780dd 100644 --- a/cpp/docs/schema/RoleType.adoc +++ b/cpp/docs/schema/RoleType.adoc @@ -45,13 +45,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -type.deleteType(transaction).get(); ----- - [#_virtual_stdstring_TypeDBRoleTypegetLabel___] ==== getLabel @@ -73,13 +66,6 @@ Implements TypeDB::Type. .Returns `virtual std::string` -[caption=""] -.Code examples -[source,cpp] ----- -type.getLabel(); ----- - [#_stdstring_TypeDBRoleTypegetName___] ==== getName @@ -97,13 +83,6 @@ Returns the name of this role type's label. .Returns `std::string` -[caption=""] -.Code examples -[source,cpp] ----- -label.getName(); ----- - [#_ConceptIterable__Thing___TypeDBRoleTypegetPlayerInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getPlayerInstances @@ -131,13 +110,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect playin .Returns `ConceptIterable< Thing >` -[caption=""] -.Code examples -[source,cpp] ----- -roleType.getPlayerInstances(transaction, transitivity); ----- - [#_ConceptIterable__ThingType___TypeDBRoleTypegetPlayerTypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getPlayerTypes @@ -165,13 +137,6 @@ a| `transitivity` a| ``Transitivity.TRANSITIVE`` for direct and indirect playing .Returns `ConceptIterable< ThingType >` -[caption=""] -.Code examples -[source,cpp] ----- -roleType.getPlayerTypes(transaction, transitivity) ----- - [#_ConceptIterable__Relation___TypeDBRoleTypegetRelationInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getRelationInstances @@ -199,13 +164,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect relati .Returns `ConceptIterable< Relation >` -[caption=""] -.Code examples -[source,cpp] ----- -roleType.getRelationInstances(transaction, transitivity) ----- - [#_ConceptPtrFuture__RelationType___TypeDBRoleTypegetRelationType___Transaction__transaction_] ==== getRelationType @@ -232,13 +190,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< RelationType >` -[caption=""] -.Code examples -[source,cpp] ----- -roleType.getRelationType(transaction).get(); ----- - [#_ConceptIterable__RelationType___TypeDBRoleTypegetRelationTypes___Transaction__transaction_] ==== getRelationTypes @@ -265,13 +216,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< RelationType >` -[caption=""] -.Code examples -[source,cpp] ----- -roleType.getRelationTypes(transaction); ----- - [#_stdstring_TypeDBRoleTypegetScope___] ==== getScope @@ -289,13 +233,6 @@ Returns the scope part of this role type's label. .Returns `std::string` -[caption=""] -.Code examples -[source,cpp] ----- -label.getScope(); ----- - [#_ConceptIterable__RoleType___TypeDBRoleTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -323,13 +260,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< RoleType >` -[caption=""] -.Code examples -[source,cpp] ----- -roleType.getSubtypes(transaction, transitivity); ----- - [#_ConceptPtrFuture__RoleType___TypeDBRoleTypegetSupertype___Transaction__transaction_] ==== getSupertype @@ -356,13 +286,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< RoleType >` -[caption=""] -.Code examples -[source,cpp] ----- -roleType.getSupertype(transaction).get(); ----- - [#_ConceptIterable__RoleType___TypeDBRoleTypegetSupertypes___Transaction__transaction_] ==== getSupertypes @@ -389,13 +312,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< RoleType >` -[caption=""] -.Code examples -[source,cpp] ----- -roleType.getSupertypes(transaction); ----- - [#_virtual_bool_TypeDBRoleTypeisAbstract___] ==== isAbstract @@ -417,13 +333,6 @@ Implements TypeDB::Type. .Returns `virtual bool` -[caption=""] -.Code examples -[source,cpp] ----- -type.isAbstract(); ----- - [#_virtual_BoolFuture_TypeDBRoleTypeisDeleted___Transaction__transaction_] ==== isDeleted @@ -454,13 +363,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual BoolFuture` -[caption=""] -.Code examples -[source,cpp] ----- -type.isDeleted(transaction).get(); ----- - [#_bool_TypeDBRoleTypeisRoot___] ==== isRoot @@ -478,13 +380,6 @@ Checks if the type is a root type. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -type.isRoot(); ----- - [#_virtual_VoidFuture_TypeDBRoleTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] ==== setLabel @@ -516,12 +411,5 @@ a| `label` a| The new ``Label`` to be given to the type. a| .Returns `virtual VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -type.setLabel(transaction, newLabel).get(); ----- - // end::methods[] diff --git a/cpp/docs/schema/ThingType.adoc b/cpp/docs/schema/ThingType.adoc index 471a8b3715..7c044faa70 100644 --- a/cpp/docs/schema/ThingType.adoc +++ b/cpp/docs/schema/ThingType.adoc @@ -43,13 +43,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -type.deleteType(transaction).get(); ----- - [#_virtual_stdstring_TypeDBThingTypegetLabel___] ==== getLabel @@ -71,13 +64,6 @@ Implements TypeDB::Type. .Returns `virtual std::string` -[caption=""] -.Code examples -[source,cpp] ----- -type.getLabel(); ----- - [#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getOwns @@ -189,14 +175,6 @@ a| `annotations` a| Only retrieve attribute types owned with annotations. a| `co .Returns `ConceptIterable< AttributeType >` -[caption=""] -.Code examples -[source,cpp] ----- -thingType.getOwns(transaction); -thingType.getOwns(transaction, valueType, Transitivity::EXPLICIT, Collections.singleton(Annotation.key())); ----- - [#_ConceptPtrFuture__AttributeType___TypeDBThingTypegetOwnsOverridden___Transaction__transaction__AttributeType__ptr__attributeType_] ==== getOwnsOverridden @@ -224,13 +202,6 @@ a| `attributeType` a| The ``AttributeType`` that overrides requested ``Attribute .Returns `ConceptPtrFuture< AttributeType >` -[caption=""] -.Code examples -[source,cpp] ----- -thingType.getOwnsOverridden(transaction, attributeType).get(); ----- - [#_ConceptIterable__RoleType___TypeDBThingTypegetPlays___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getPlays @@ -258,14 +229,6 @@ a| `transitivity` a| transitivity: ``Transitivity::TRANSITIVE`` for direct and i .Returns `ConceptIterable< RoleType >` -[caption=""] -.Code examples -[source,cpp] ----- -thingType.getPlays(transaction).get(); -thingType.getPlays(transaction, Transitivity::EXPLICIT).get(); ----- - [#_ConceptPtrFuture__RoleType___TypeDBThingTypegetPlaysOverridden___Transaction__transaction__RoleType__ptr__roleType_] ==== getPlaysOverridden @@ -293,13 +256,6 @@ a| `roleType` a| The ``RoleType`` that overrides an inherited role a| `RoleType* .Returns `ConceptPtrFuture< RoleType >` -[caption=""] -.Code examples -[source,cpp] ----- -thingType.getPlaysOverridden(transaction, roleType).get(); ----- - [#_ConceptIterable__ThingType___TypeDBThingTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -329,14 +285,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< ThingType >` -[caption=""] -.Code examples -[source,cpp] ----- -type.getSubtypes(transaction); -type.getSubtypes(transaction, Transitivity.EXPLICIT); ----- - [#_ConceptPtrFuture__ThingType___TypeDBThingTypegetSupertype___Transaction__transaction_] ==== getSupertype @@ -365,13 +313,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< ThingType >` -[caption=""] -.Code examples -[source,cpp] ----- -type.getSupertype(transaction).get(); ----- - [#_ConceptIterable__ThingType___TypeDBThingTypegetSupertypes___Transaction__transaction_] ==== getSupertypes @@ -400,13 +341,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< ThingType >` -[caption=""] -.Code examples -[source,cpp] ----- -type.getSupertypes(transaction); ----- - [#_StringFuture_TypeDBThingTypegetSyntax___Transaction__transaction_] ==== getSyntax @@ -433,13 +367,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `StringFuture` -[caption=""] -.Code examples -[source,cpp] ----- -thingType.getSyntax(transaction).get(); ----- - [#_virtual_bool_TypeDBThingTypeisAbstract___] ==== isAbstract @@ -461,13 +388,6 @@ Implements TypeDB::Type. .Returns `virtual bool` -[caption=""] -.Code examples -[source,cpp] ----- -type.isAbstract(); ----- - [#_virtual_BoolFuture_TypeDBThingTypeisDeleted___Transaction__transaction_] ==== isDeleted @@ -498,13 +418,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual BoolFuture` -[caption=""] -.Code examples -[source,cpp] ----- -type.isDeleted(transaction).get(); ----- - [#_bool_TypeDBThingTypeisRoot___] ==== isRoot @@ -522,13 +435,6 @@ Checks if the type is a root type. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -type.isRoot(); ----- - [#_VoidFuture_TypeDBThingTypesetAbstract___Transaction__transaction_] ==== setAbstract @@ -555,13 +461,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -thingType.setAbstract(transaction).get(); ----- - [#_virtual_VoidFuture_TypeDBThingTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] ==== setLabel @@ -593,13 +492,6 @@ a| `label` a| The new ``Label`` to be given to the type. a| .Returns `virtual VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -type.setLabel(transaction, newLabel).get(); ----- - [#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__const_stdinitializer_list__Annotation____annotations___] ==== setOwns @@ -679,14 +571,6 @@ a| `annotations` a| Adds annotations to the ownership. a| `const std::vector< An .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -thingType.setOwns(transaction, attributeType).get(); -thingType.setOwns(transaction, attributeType, overriddenType, Collections.singleton(Annotation.key())).get(); ----- - [#_VoidFuture_TypeDBThingTypesetPlays___Transaction__transaction__RoleType__ptr__roleType_] ==== setPlays @@ -731,14 +615,6 @@ a| `overriddenType` a| The role type that this role overrides, if applicable a| .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -thingType.setPlays(transaction, roleType).get(); -thingType.setPlays(transaction, roleType, overriddenType).get(); ----- - [#_VoidFuture_TypeDBThingTypeunsetAbstract___Transaction__transaction_] ==== unsetAbstract @@ -765,13 +641,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -thingType.unsetAbstract(transaction).get(); ----- - [#_VoidFuture_TypeDBThingTypeunsetOwns___Transaction__transaction__AttributeType__ptr__attributeType_] ==== unsetOwns @@ -799,13 +668,6 @@ a| `attributeType` a| The ``AttributeType`` to not be owned by the type. a| `Att .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -thingType.unsetOwns(transaction, attributeType).get(); ----- - [#_VoidFuture_TypeDBThingTypeunsetPlays___Transaction__transaction__RoleType__ptr__roleType_] ==== unsetPlays @@ -833,12 +695,5 @@ a| `roleType` a| The role to not be played by the instances of this type. a| `Ro .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -thingType.unsetPlays(transaction, roleType).get(); ----- - // end::methods[] diff --git a/cpp/docs/schema/Type.adoc b/cpp/docs/schema/Type.adoc index 67853a9f82..1fb9d6817e 100644 --- a/cpp/docs/schema/Type.adoc +++ b/cpp/docs/schema/Type.adoc @@ -40,13 +40,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -type.deleteType(transaction).get(); ----- - [#_virtual_stdstring_TypeDBTypegetLabel___] ==== getLabel @@ -66,13 +59,6 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. .Returns `virtual std::string` -[caption=""] -.Code examples -[source,cpp] ----- -type.getLabel(); ----- - [#_ConceptIterable__Type___TypeDBTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -100,14 +86,6 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< Type >` -[caption=""] -.Code examples -[source,cpp] ----- -type.getSubtypes(transaction); -type.getSubtypes(transaction, Transitivity.EXPLICIT); ----- - [#_ConceptPtrFuture__Type___TypeDBTypegetSupertype___Transaction__transaction_] ==== getSupertype @@ -134,13 +112,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< Type >` -[caption=""] -.Code examples -[source,cpp] ----- -type.getSupertype(transaction).get(); ----- - [#_ConceptIterable__Type___TypeDBTypegetSupertypes___Transaction__transaction_] ==== getSupertypes @@ -167,13 +138,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< Type >` -[caption=""] -.Code examples -[source,cpp] ----- -type.getSupertypes(transaction); ----- - [#_virtual_bool_TypeDBTypeisAbstract___] ==== isAbstract @@ -193,13 +157,6 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. .Returns `virtual bool` -[caption=""] -.Code examples -[source,cpp] ----- -type.isAbstract(); ----- - [#_virtual_BoolFuture_TypeDBTypeisDeleted___Transaction__transaction_] ==== isDeleted @@ -228,13 +185,6 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual BoolFuture` -[caption=""] -.Code examples -[source,cpp] ----- -type.isDeleted(transaction).get(); ----- - [#_virtual_VoidFuture_TypeDBTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] ==== setLabel @@ -264,12 +214,5 @@ a| `label` a| The new ``Label`` to be given to the type. a| .Returns `virtual VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -type.setLabel(transaction, newLabel).get(); ----- - // end::methods[] diff --git a/cpp/docs/session/Options.adoc b/cpp/docs/session/Options.adoc index 2718199cfb..47f6effba1 100644 --- a/cpp/docs/session/Options.adoc +++ b/cpp/docs/session/Options.adoc @@ -27,13 +27,6 @@ Produces a new ``Options`` object. .Returns `TypeDB::Options::Options` -[caption=""] -.Code examples -[source,cpp] ----- -TypeDBOptions options = TypeDBOptions(); ----- - [#_stdoptional__bool___TypeDBOptionsexplain___] ==== explain @@ -51,13 +44,6 @@ Returns the value set for the explanation in this ``TypeDBOptions`` object. If s .Returns `std::optional< bool >` -[caption=""] -.Code examples -[source,cpp] ----- -options.explain(); ----- - [#_Options__TypeDBOptionsexplain___bool_explain_] ==== explain @@ -84,13 +70,6 @@ a| `explain` a| Explicitly enable or disable explanations a| `bool` .Returns `Options&` -[caption=""] -.Code examples -[source,cpp] ----- -options.explain(explain); ----- - [#_stdoptional__bool___TypeDBOptionsinfer___] ==== infer @@ -108,13 +87,6 @@ Returns the value set for the inference in this ``TypeDBOptions`` object. .Returns `std::optional< bool >` -[caption=""] -.Code examples -[source,cpp] ----- -options.infer(); ----- - [#_Options__TypeDBOptionsinfer___bool_infer_] ==== infer @@ -141,13 +113,6 @@ a| `infer` a| Explicitly enable or disable inference a| `bool` .Returns `Options&` -[caption=""] -.Code examples -[source,cpp] ----- -options.infer(infer); ----- - [#_stdoptional__bool___TypeDBOptionsparallel___] ==== parallel @@ -165,13 +130,6 @@ Returns the value set for the parallel execution in this ``TypeDBOptions`` objec .Returns `std::optional< bool >` -[caption=""] -.Code examples -[source,cpp] ----- -options.parallel(); ----- - [#_Options__TypeDBOptionsparallel___bool_parallel_] ==== parallel @@ -198,13 +156,6 @@ a| `parallel` a| Explicitly enable or disable parallel execution a| `bool` .Returns `Options&` -[caption=""] -.Code examples -[source,cpp] ----- -options.parallel(parallel); ----- - [#_stdoptional__bool___TypeDBOptionsprefetch___] ==== prefetch @@ -222,13 +173,6 @@ Returns the value set for the prefetching in this ``TypeDBOptions`` object. If s .Returns `std::optional< bool >` -[caption=""] -.Code examples -[source,cpp] ----- -options.prefetch(); ----- - [#_Options__TypeDBOptionsprefetch___bool_prefetch_] ==== prefetch @@ -255,13 +199,6 @@ a| `prefetch` a| Explicitly enable or disable prefetching a| `bool` .Returns `Options&` -[caption=""] -.Code examples -[source,cpp] ----- -options.prefetch(prefetch); ----- - [#_stdoptional__int32_t___TypeDBOptionsprefetchSize___] ==== prefetchSize @@ -279,13 +216,6 @@ Returns the value set for the prefetch size in this ``TypeDBOptions`` object. If .Returns `std::optional< int32_t >` -[caption=""] -.Code examples -[source,cpp] ----- -options.prefetchSize(); ----- - [#_Options__TypeDBOptionsprefetchSize___int32_t_prefetchSize_] ==== prefetchSize @@ -312,13 +242,6 @@ a| `prefetchSize` a| Number of answers that the server should send before the dr .Returns `Options&` -[caption=""] -.Code examples -[source,cpp] ----- -options.prefetchSize(prefetchSize); ----- - [#_stdoptional__bool___TypeDBOptionsreadAnyReplica___] ==== readAnyReplica @@ -336,13 +259,6 @@ Returns the value set for reading data from any replica in this ``TypeDBOptions` .Returns `std::optional< bool >` -[caption=""] -.Code examples -[source,cpp] ----- -options.readAnyReplica(); ----- - [#_Options__TypeDBOptionsreadAnyReplica___bool_readAnyReplica_] ==== readAnyReplica @@ -369,13 +285,6 @@ a| `readAnyReplica` a| Explicitly enable or disable reading data from any replic .Returns `Options&` -[caption=""] -.Code examples -[source,cpp] ----- -options.readAnyReplica(readAnyReplica); ----- - [#_stdoptional__int64_t___TypeDBOptionsschemaLockAcquireTimeoutMillis___] ==== schemaLockAcquireTimeoutMillis @@ -393,13 +302,6 @@ Returns the value set for the schema lock acquire timeout in this ``TypeDBOption .Returns `std::optional< int64_t >` -[caption=""] -.Code examples -[source,cpp] ----- -options.schemaLockAcquireTimeoutMillis(); ----- - [#_Options__TypeDBOptionsschemaLockAcquireTimeoutMillis___int64_t_timeoutMillis_] ==== schemaLockAcquireTimeoutMillis @@ -426,13 +328,6 @@ a| `schemaLockAcquireTimeoutMillis` a| How long the driver should wait if openin .Returns `Options&` -[caption=""] -.Code examples -[source,cpp] ----- -options.schemaLockAcquireTimeoutMillis(schemaLockAcquireTimeoutMillis); ----- - [#_stdoptional__int64_t___TypeDBOptionssessionIdleTimeoutMillis___] ==== sessionIdleTimeoutMillis @@ -450,13 +345,6 @@ Returns the value set for the session idle timeout in this ``TypeDBOptions`` obj .Returns `std::optional< int64_t >` -[caption=""] -.Code examples -[source,cpp] ----- -options.sessionIdleTimeoutMillis(); ----- - [#_Options__TypeDBOptionssessionIdleTimeoutMillis___int64_t_timeoutMillis_] ==== sessionIdleTimeoutMillis @@ -483,13 +371,6 @@ a| `sessionIdleTimeoutMillis` a| timeout that allows the server to close session .Returns `Options&` -[caption=""] -.Code examples -[source,cpp] ----- -options.sessionIdleTimeoutMillis(sessionIdleTimeoutMillis); ----- - [#_stdoptional__bool___TypeDBOptionstraceInference___] ==== traceInference @@ -507,13 +388,6 @@ Returns the value set for reasoning tracing in this ``TypeDBOptions`` object. If .Returns `std::optional< bool >` -[caption=""] -.Code examples -[source,cpp] ----- -options.traceInference(); ----- - [#_Options__TypeDBOptionstraceInference___bool_traceInference_] ==== traceInference @@ -540,13 +414,6 @@ a| `traceInference` a| Explicitly enable or disable reasoning tracing a| `bool` .Returns `Options&` -[caption=""] -.Code examples -[source,cpp] ----- -options.traceInference(traceInference); ----- - [#_stdoptional__int64_t___TypeDBOptionstransactionTimeoutMillis___] ==== transactionTimeoutMillis @@ -564,13 +431,6 @@ Returns the value set for the transaction timeout in this ``TypeDBOptions`` obje .Returns `std::optional< int64_t >` -[caption=""] -.Code examples -[source,cpp] ----- -options.transactionTimeoutMillis(); ----- - [#_Options__TypeDBOptionstransactionTimeoutMillis___int64_t_timeoutMillis_] ==== transactionTimeoutMillis @@ -597,12 +457,5 @@ a| `transactionTimeoutMillis` a| Timeout for killing transactions automatically .Returns `Options&` -[caption=""] -.Code examples -[source,cpp] ----- -options.transactionTimeoutMillis(transactionTimeoutMillis); ----- - // end::methods[] diff --git a/cpp/docs/session/Session.adoc b/cpp/docs/session/Session.adoc index 4ac3f2908c..213973451f 100644 --- a/cpp/docs/session/Session.adoc +++ b/cpp/docs/session/Session.adoc @@ -25,13 +25,6 @@ Closes the session. Before opening a new session, the session currently open sho .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -session.close(); ----- - [#_stdstring_TypeDBSessiondatabaseName_____const] ==== databaseName @@ -49,13 +42,6 @@ Returns the name of the database of the session. .Returns `std::string` -[caption=""] -.Code examples -[source,cpp] ----- -session.databaseName(); ----- - [#_bool_TypeDBSessionisOpen_____const] ==== isOpen @@ -73,13 +59,6 @@ Checks whether this session is open. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -session.isOpen(); ----- - [#_void_TypeDBSessiononClose___stdfunction__void____callback_] ==== onClose @@ -106,13 +85,6 @@ a| `function` a| The callback function. a| .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -session.onClose(function) ----- - [#_void_TypeDBSessiononReopen___stdfunction__void____callback_] ==== onReopen @@ -139,13 +111,6 @@ a| `function` a| The callback function. a| .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -session.onReopen(function) ----- - [#_Transaction_TypeDBSessiontransaction___TransactionType_type__const_Options__options__Options_____const] ==== transaction @@ -173,13 +138,6 @@ a| `options` a| Options for the session a| .Returns `Transaction` -[caption=""] -.Code examples -[source,cpp] ----- -session.transaction(transactionType, options); ----- - [#_SessionType_TypeDBSessiontype_____const] ==== type diff --git a/cpp/docs/transaction/QueryManager.adoc b/cpp/docs/transaction/QueryManager.adoc index 084e176643..f31467bd64 100644 --- a/cpp/docs/transaction/QueryManager.adoc +++ b/cpp/docs/transaction/QueryManager.adoc @@ -35,13 +35,6 @@ a| `options` a| Specify query options a| .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.query.define(query, options).get() ----- - [#_ExplanationIterable_TypeDBQueryManagerexplain___const_Explainable__explainable__const_Options___Options_____const] ==== explain @@ -69,13 +62,6 @@ a| `options` a| Specify query options a| .Returns `ExplanationIterable` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.query.explain(explainable, options) ----- - [#_JSONIterable_TypeDBQueryManagerfetch___const_stdstring__query__const_Options__options__Options_____const] ==== fetch @@ -103,13 +89,6 @@ a| `options` a| Specify query options a| .Returns `JSONIterable` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.query.fetch(query, options) ----- - [#_ConceptMapIterable_TypeDBQueryManagerget___const_stdstring__query__const_Options__options__Options_____const] ==== get @@ -137,13 +116,6 @@ a| `options` a| Specify query options a| .Returns `ConceptMapIterable` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.query.get(query, options) ----- - [#_AggregateFuture_TypeDBQueryManagergetAggregate___const_stdstring__query__const_Options___Options_____const] ==== getAggregate @@ -171,13 +143,6 @@ a| `options` a| Specify query options a| .Returns `AggregateFuture` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.query.getAggregate(query, options).get() ----- - [#_ConceptMapGroupIterable_TypeDBQueryManagergetGroup___const_stdstring__query__const_Options___Options_____const] ==== getGroup @@ -205,13 +170,6 @@ a| `options` a| Specify query options a| .Returns `ConceptMapGroupIterable` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.query.getGroup(query, options) ----- - [#_ValueGroupIterable_TypeDBQueryManagergetGroupAggregate___const_stdstring__query__const_Options___Options_____const] ==== getGroupAggregate @@ -239,13 +197,6 @@ a| `options` a| Specify query options a| .Returns `ValueGroupIterable` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.query.getGroupAggregate(query, options) ----- - [#_ConceptMapIterable_TypeDBQueryManagerinsert___const_stdstring__query__const_Options__options__Options_____const] ==== insert @@ -273,13 +224,6 @@ a| `options` a| Specify query options a| .Returns `ConceptMapIterable` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.query.insert(query, options) ----- - [#_VoidFuture_TypeDBQueryManagermatchDelete___const_stdstring__query__const_Options__options__Options_____const] ==== matchDelete @@ -307,13 +251,6 @@ a| `options` a| Specify query options a| .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.query.matchDelete(query, options).get() ----- - [#_VoidFuture_TypeDBQueryManagerundefine___const_stdstring__query__const_Options__options__Options_____const] ==== undefine @@ -341,13 +278,6 @@ a| `options` a| Specify query options a| .Returns `VoidFuture` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.query.undefine(query, options).get() ----- - [#_ConceptMapIterable_TypeDBQueryManagerupdate___const_stdstring__query__const_Options___Options_____const] ==== update @@ -375,12 +305,5 @@ a| `options` a| Specify query options a| .Returns `ConceptMapIterable` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.query.update(query, options) ----- - // end::methods[] diff --git a/cpp/docs/transaction/Transaction.adoc b/cpp/docs/transaction/Transaction.adoc index 312e99b298..89adedb651 100644 --- a/cpp/docs/transaction/Transaction.adoc +++ b/cpp/docs/transaction/Transaction.adoc @@ -38,13 +38,6 @@ Closes the transaction. .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.close() ----- - [#_void_TypeDBTransactioncommit___] ==== commit @@ -62,13 +55,6 @@ Commits the changes made via this transaction to the TypeDB database. Whether or .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.commit() ----- - [#_void_TypeDBTransactionforceClose___] ==== forceClose @@ -86,13 +72,6 @@ Closes the transaction. .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.close() ----- - [#_bool_TypeDBTransactionisOpen_____const] ==== isOpen @@ -110,13 +89,6 @@ Checks whether this transaction is open. .Returns `bool` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.isOpen(); ----- - [#_void_TypeDBTransactiononClose___stdfunction__void_const_stdoptional__DriverException______callback_] ==== onClose @@ -143,13 +115,6 @@ a| `function` a| The callback function. a| .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.onClose(function); ----- - [#_void_TypeDBTransactionrollback___] ==== rollback @@ -167,13 +132,6 @@ Rolls back the uncommitted changes made via this transaction. .Returns `void` -[caption=""] -.Code examples -[source,cpp] ----- -transaction.rollback() ----- - [#_TypeDBTransactionType_TypeDBTransactiontype_____const] ==== type diff --git a/csharp/Test/Behaviour/Connection/ConnectionStepsCore.cs b/csharp/Test/Behaviour/Connection/ConnectionStepsCore.cs index 3334ad4a2d..0798b9c777 100644 --- a/csharp/Test/Behaviour/Connection/ConnectionStepsCore.cs +++ b/csharp/Test/Behaviour/Connection/ConnectionStepsCore.cs @@ -48,7 +48,7 @@ public override void TypeDBStarts() [When(@"connection opens with default authentication")] public override void ConnectionOpensWithDefaultAuthentication() { - Driver = CreateTypeDBDriver(TypeDB.DEFAULT_ADDRESS); + Driver = CreateTypeDBDriver(Drivers.DEFAULT_ADDRESS); } [Given(@"connection opens with authentication: {}, {}")] diff --git a/csharp/Test/Integration/Examples/CloudExamplesTest.cs b/csharp/Test/Integration/Examples/CloudExamplesTest.cs index b194c89957..839167140b 100644 --- a/csharp/Test/Integration/Examples/CloudExamplesTest.cs +++ b/csharp/Test/Integration/Examples/CloudExamplesTest.cs @@ -1,6 +1,4 @@ /* - * Copyright (C) 2022 Vaticle - * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information diff --git a/csharp/Test/Integration/Marshal/MarshalTest.cs b/csharp/Test/Integration/Marshal/MarshalTest.cs index 1b975e3c4a..63c7033526 100644 --- a/csharp/Test/Integration/Marshal/MarshalTest.cs +++ b/csharp/Test/Integration/Marshal/MarshalTest.cs @@ -34,7 +34,7 @@ public static class Utils { public static ITypeDBDriver OpenConnection() { - ITypeDBDriver driver = Drivers.CoreDriver(TypeDB.DEFAULT_ADDRESS); + ITypeDBDriver driver = Drivers.CoreDriver(Drivers.DEFAULT_ADDRESS); Assert.IsNotNull(driver); Assert.True(driver.IsOpen()); From 5e350fd52301f9b7ca4417e72b9ecfa8b773bf68 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 2 Apr 2024 11:08:42 +0100 Subject: [PATCH 064/118] Fix some docs --- cpp/docs/answer/ConceptMap.adoc | 35 ++++ cpp/docs/answer/ConceptMapGroup.adoc | 14 ++ cpp/docs/answer/Explainable.adoc | 14 ++ cpp/docs/answer/Explainables.adoc | 42 +++++ cpp/docs/answer/Explanation.adoc | 35 ++++ cpp/docs/answer/ValueGroup.adoc | 14 ++ cpp/docs/concept/Concept.adoc | 147 +++++++++++++++ cpp/docs/concept/ConceptManager.adoc | 91 ++++++++++ cpp/docs/connection/Database.adoc | 49 +++++ cpp/docs/connection/DatabaseManager.adoc | 28 +++ cpp/docs/connection/Driver.adoc | 49 +++++ cpp/docs/connection/UserManager.adoc | 42 +++++ cpp/docs/data/Attribute.adoc | 28 +++ cpp/docs/data/Entity.adoc | 7 + cpp/docs/data/Relation.adoc | 42 +++++ cpp/docs/data/Thing.adoc | 79 ++++++++ cpp/docs/data/Value.adoc | 126 +++++++++++++ cpp/docs/errors/DriverException.adoc | 21 +++ cpp/docs/logic/LogicManager.adoc | 21 +++ cpp/docs/logic/Rule.adoc | 21 +++ cpp/docs/schema/Annotation.adoc | 28 +++ cpp/docs/schema/AttributeType.adoc | 182 +++++++++++++++++++ cpp/docs/schema/EntityType.adoc | 28 +++ cpp/docs/schema/RelationType.adoc | 71 ++++++++ cpp/docs/schema/RoleType.adoc | 112 ++++++++++++ cpp/docs/schema/ThingType.adoc | 145 +++++++++++++++ cpp/docs/schema/Type.adoc | 57 ++++++ cpp/docs/session/Options.adoc | 147 +++++++++++++++ cpp/docs/session/Session.adoc | 42 +++++ cpp/docs/transaction/QueryManager.adoc | 77 ++++++++ cpp/docs/transaction/Transaction.adoc | 42 +++++ csharp/docs/connection/IUser.adoc | 18 -- csharp/docs/connection/TypeDBCredential.adoc | 44 ----- tool/docs/cpp/DoxygenParserCpp.kt | 2 +- tool/docs/csharp/DoxygenParserCsharp.kt | 2 +- 35 files changed, 1838 insertions(+), 64 deletions(-) diff --git a/cpp/docs/answer/ConceptMap.adoc b/cpp/docs/answer/ConceptMap.adoc index 46f014e436..56c7b1a1e0 100644 --- a/cpp/docs/answer/ConceptMap.adoc +++ b/cpp/docs/answer/ConceptMap.adoc @@ -25,6 +25,13 @@ Produces an ``Iterator`` over all concepts in this ``ConceptMap``. .Returns `ConceptIterable< Concept >` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.concepts(); +---- + [#_Explainables_TypeDBConceptMapexplainables___] ==== explainables @@ -42,6 +49,13 @@ Gets the ``Explainables`` object for this ``ConceptMap``, exposing which of the .Returns `Explainables` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables(); +---- + [#_stdunique_ptr__Concept___TypeDBConceptMapget___const_stdstring__variableName_] ==== get @@ -68,6 +82,13 @@ a| `variable` a| The string representation of a variable a| .Returns `std::unique_ptr< Concept >` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.get(variable); +---- + [#_stdmap__stdstring__stdunique_ptr__Concept_____TypeDBConceptMapmap___] ==== map @@ -85,6 +106,13 @@ Returns the inner ``Map`` where keys are query variables, and values are concept .Returns `std::map< std::string, std::unique_ptr< Concept > >` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.map(); +---- + [#_stdstring_TypeDBConceptMaptoString___] ==== toString @@ -118,5 +146,12 @@ Produces an ``Iterator`` stream over all variables in this ``ConceptMap``. .Returns `StringIterable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.variables(); +---- + // end::methods[] diff --git a/cpp/docs/answer/ConceptMapGroup.adoc b/cpp/docs/answer/ConceptMapGroup.adoc index 390ff214d6..e440dda03a 100644 --- a/cpp/docs/answer/ConceptMapGroup.adoc +++ b/cpp/docs/answer/ConceptMapGroup.adoc @@ -25,6 +25,13 @@ Retrieves the ``ConceptMap``s of the group. .Returns `ConceptMapIterable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMapGroup.conceptMaps(); +---- + [#_stdunique_ptr__Concept___TypeDBConceptMapGroupowner___] ==== owner @@ -42,6 +49,13 @@ Retrieves the concept that is the group owner. .Returns `std::unique_ptr< Concept >` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMapGroup.owner(); +---- + [#_stdstring_TypeDBConceptMapGrouptoString___] ==== toString diff --git a/cpp/docs/answer/Explainable.adoc b/cpp/docs/answer/Explainable.adoc index 75c94347df..e41c187473 100644 --- a/cpp/docs/answer/Explainable.adoc +++ b/cpp/docs/answer/Explainable.adoc @@ -25,6 +25,13 @@ Retrieves the subquery of the original query that is actually being explained. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +explainable.conjunction(); +---- + [#_int64_t_TypeDBExplainableexplainableId___] ==== explainableId @@ -42,5 +49,12 @@ Retrieves the unique ID that identifies this ``Explainable``. .Returns `int64_t` +[caption=""] +.Code examples +[source,cpp] +---- +explainable.id(); +---- + // end::methods[] diff --git a/cpp/docs/answer/Explainables.adoc b/cpp/docs/answer/Explainables.adoc index 413954d7f0..eeac15a813 100644 --- a/cpp/docs/answer/Explainables.adoc +++ b/cpp/docs/answer/Explainables.adoc @@ -34,6 +34,13 @@ a| `variable` a| The string representation of a variable a| `std::string&` .Returns `Explainable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().attribute(variable); +---- + [#_StringIterable_TypeDBExplainablesattributes___] ==== attributes @@ -51,6 +58,13 @@ Retrieves all of this ``ConceptMap``’s explainable attributes. .Returns `StringIterable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().attributes(); +---- + [#_Explainable_TypeDBExplainablesownership___stdstring__owner__stdstring__attribute_] ==== ownership @@ -78,6 +92,13 @@ a| `attribute` a| The string representation of the attribute variable a| `std::s .Returns `Explainable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().ownership(owner, attribute); +---- + [#_OwnerAttributePairIterable_TypeDBExplainablesownerships___] ==== ownerships @@ -95,6 +116,13 @@ Retrieves all of this ``ConceptMap``’s explainable ownerships. .Returns `OwnerAttributePairIterable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().ownerships(); +---- + [#_Explainable_TypeDBExplainablesrelation___stdstring__variable_] ==== relation @@ -121,6 +149,13 @@ a| `variable` a| The string representation of a variable a| `std::string&` .Returns `Explainable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().relation(variable); +---- + [#_StringIterable_TypeDBExplainablesrelations___] ==== relations @@ -138,6 +173,13 @@ Retrieves all of this ``ConceptMap``’s explainable relations. .Returns `StringIterable` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMap.explainables().relations(); +---- + [#_stdstring_TypeDBExplainablestoString___] ==== toString diff --git a/cpp/docs/answer/Explanation.adoc b/cpp/docs/answer/Explanation.adoc index 50bfceaf0c..035a3aeef8 100644 --- a/cpp/docs/answer/Explanation.adoc +++ b/cpp/docs/answer/Explanation.adoc @@ -27,6 +27,13 @@ Retrieves the Conclusion for this Explanation. .Returns `ConceptMap` +[caption=""] +.Code examples +[source,cpp] +---- +explanation.conclusion() +---- + [#_ConceptMap_TypeDBExplanationcondition___] ==== condition @@ -44,6 +51,13 @@ Retrieves the Condition for this Explanation. .Returns `ConceptMap` +[caption=""] +.Code examples +[source,cpp] +---- +explanation.condition() +---- + [#_stdvector__stdstring___TypeDBExplanationqueryVariableMapping___const_stdstring__var_] ==== queryVariableMapping @@ -70,6 +84,13 @@ a| `var` a| The query variable to map to rule variables. a| `const std::string&` .Returns `std::vector< std::string >` +[caption=""] +.Code examples +[source,cpp] +---- +explanation.variableMapping(var) +---- + [#_stdvector__stdstring___TypeDBExplanationqueryVariables___] ==== queryVariables @@ -87,6 +108,13 @@ Retrieves the query variables for this ``Explanation``. .Returns `std::vector< std::string >` +[caption=""] +.Code examples +[source,cpp] +---- +explanation.queryVariables() +---- + [#_Rule_TypeDBExplanationrule___] ==== rule @@ -104,6 +132,13 @@ Retrieves the Rule for this Explanation. .Returns `Rule` +[caption=""] +.Code examples +[source,cpp] +---- +explanation.rule() +---- + [#_stdstring_TypeDBExplanationtoString___] ==== toString diff --git a/cpp/docs/answer/ValueGroup.adoc b/cpp/docs/answer/ValueGroup.adoc index bb89e98cf5..bd8829b44f 100644 --- a/cpp/docs/answer/ValueGroup.adoc +++ b/cpp/docs/answer/ValueGroup.adoc @@ -25,6 +25,13 @@ Retrieves the concept that is the group owner. .Returns `std::unique_ptr< Concept >` +[caption=""] +.Code examples +[source,cpp] +---- +conceptMapGroup.owner() +---- + [#_stdstring_TypeDBValueGrouptoString___] ==== toString @@ -58,5 +65,12 @@ Retrieves the ``Value`` answer of the group. .Returns `AggregateResult` +[caption=""] +.Code examples +[source,cpp] +---- +valueGroup.value(); +---- + // end::methods[] diff --git a/cpp/docs/concept/Concept.adoc b/cpp/docs/concept/Concept.adoc index f6c5db56ae..f6454c7925 100644 --- a/cpp/docs/concept/Concept.adoc +++ b/cpp/docs/concept/Concept.adoc @@ -25,6 +25,13 @@ Casts the concept to ``Attribute``. .Returns `Attribute*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asAttribute(); +---- + [#_AttributeType__ptr__TypeDBConceptasAttributeType___] ==== asAttributeType @@ -42,6 +49,13 @@ Casts the concept to ``EntityType``. .Returns `AttributeType*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asEntityType(); +---- + [#_Entity__ptr__TypeDBConceptasEntity___] ==== asEntity @@ -59,6 +73,13 @@ Casts the concept to ``Entity``. .Returns `Entity*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asEntity(); +---- + [#_EntityType__ptr__TypeDBConceptasEntityType___] ==== asEntityType @@ -76,6 +97,13 @@ Casts the concept to ``EntityType``. .Returns `EntityType*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asEntityType(); +---- + [#_Relation__ptr__TypeDBConceptasRelation___] ==== asRelation @@ -93,6 +121,13 @@ Casts the concept to ``Relation``. .Returns `Relation*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asRelation(); +---- + [#_RelationType__ptr__TypeDBConceptasRelationType___] ==== asRelationType @@ -110,6 +145,13 @@ Casts the concept to ``RelationType``. .Returns `RelationType*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asRelationType(); +---- + [#_RoleType__ptr__TypeDBConceptasRoleType___] ==== asRoleType @@ -127,6 +169,13 @@ Casts the concept to ``RoleType``. .Returns `RoleType*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asRoleType(); +---- + [#_Thing__ptr__TypeDBConceptasThing___] ==== asThing @@ -144,6 +193,13 @@ Casts the concept to ``Thing``. .Returns `Thing*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asThing(); +---- + [#_ThingType__ptr__TypeDBConceptasThingType___] ==== asThingType @@ -161,6 +217,13 @@ Casts the concept to ``ThingType``. .Returns `ThingType*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asThingType(); +---- + [#_Value__ptr__TypeDBConceptasValue___] ==== asValue @@ -178,6 +241,13 @@ Casts the concept to ``Value``. .Returns `Value*` +[caption=""] +.Code examples +[source,cpp] +---- +concept.asValue(); +---- + [#_static_bool_TypeDBConceptequals___Concept__ptr__first__Concept__ptr__second_] ==== equals @@ -211,6 +281,13 @@ Returns the ConceptType of this concept. .Returns `ConceptType` +[caption=""] +.Code examples +[source,cpp] +---- +switch(concept.getConceptType()) { ... } +---- + [#_bool_TypeDBConceptisAttribute___] ==== isAttribute @@ -228,6 +305,13 @@ Checks if the concept is a ``Relation``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isRelation(); +---- + [#_bool_TypeDBConceptisAttributeType___] ==== isAttributeType @@ -245,6 +329,13 @@ Checks if the concept is an ``AttributeType``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isAttributeType(); +---- + [#_bool_TypeDBConceptisEntity___] ==== isEntity @@ -262,6 +353,13 @@ Checks if the concept is an ``Entity``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isEntity(); +---- + [#_bool_TypeDBConceptisEntityType___] ==== isEntityType @@ -279,6 +377,13 @@ Checks if the concept is an ``EntityType``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isEntityType(); +---- + [#_bool_TypeDBConceptisRelation___] ==== isRelation @@ -296,6 +401,13 @@ Checks if the concept is a ``Value``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isValue(); +---- + [#_bool_TypeDBConceptisRelationType___] ==== isRelationType @@ -313,6 +425,13 @@ Checks if the concept is a ``RelationType``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isRelationType(); +---- + [#_bool_TypeDBConceptisRoleType___] ==== isRoleType @@ -330,6 +449,13 @@ Checks if the concept is a ``RoleType``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isRoleType(); +---- + [#_bool_TypeDBConceptisThing___] ==== isThing @@ -347,6 +473,13 @@ Checks if the concept is a ``Thing``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isThing(); +---- + [#_bool_TypeDBConceptisThingType___] ==== isThingType @@ -364,6 +497,13 @@ Checks if the concept is a ``ThingType``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isThingType(); +---- + [#_bool_TypeDBConceptisValue___] ==== isValue @@ -381,6 +521,13 @@ Checks if the concept is a ``Value``. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +concept.isValue(); +---- + [#_bool_TypeDBConceptoperator___const_Concept__other_] ==== operator== diff --git a/cpp/docs/concept/ConceptManager.adoc b/cpp/docs/concept/ConceptManager.adoc index 913c2c3218..76899cfa92 100644 --- a/cpp/docs/concept/ConceptManager.adoc +++ b/cpp/docs/concept/ConceptManager.adoc @@ -34,6 +34,13 @@ a| `iid` a| The iid of the ``Attribute`` to retrieve a| `const std::string&` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getAttribute(iid).get(); +---- + [#_ConceptPtrFuture__AttributeType___TypeDBConceptManagergetAttributeType___const_stdstring__label___const] ==== getAttributeType @@ -60,6 +67,13 @@ a| `label` a| The label of the ``AttributeType`` to retrieve a| `const std::stri .Returns `ConceptPtrFuture< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getAttributeType(label).get(); +---- + [#_ConceptPtrFuture__Entity___TypeDBConceptManagergetEntity___const_stdstring__iid___const] ==== getEntity @@ -86,6 +100,13 @@ a| `iid` a| The iid of the ``Entity`` to retrieve a| `const std::string&` .Returns `ConceptPtrFuture< Entity >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getEntity(iid).get(); +---- + [#_ConceptPtrFuture__EntityType___TypeDBConceptManagergetEntityType___const_stdstring__label___const] ==== getEntityType @@ -112,6 +133,13 @@ a| `label` a| The label of the ``EntityType`` to retrieve a| `const std::string& .Returns `ConceptPtrFuture< EntityType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getEntityType(label).get(); +---- + [#_ConceptPtrFuture__Relation___TypeDBConceptManagergetRelation___const_stdstring__iid___const] ==== getRelation @@ -138,6 +166,13 @@ a| `iid` a| The iid of the ``Relation`` to retrieve a| `const std::string&` .Returns `ConceptPtrFuture< Relation >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getRelation(iid).get(); +---- + [#_ConceptPtrFuture__RelationType___TypeDBConceptManagergetRelationType___const_stdstring__label___const] ==== getRelationType @@ -164,6 +199,13 @@ a| `label` a| The label of the ``RelationType`` to retrieve a| `const std::strin .Returns `ConceptPtrFuture< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getRelationType(label).get(); +---- + [#_stdunique_ptr__AttributeType___TypeDBConceptManagergetRootAttributeType_____const] ==== getRootAttributeType @@ -181,6 +223,13 @@ Retrieve the root ``AttributeType``, “attribute”. .Returns `std::unique_ptr< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getRootAttributeType(); +---- + [#_stdunique_ptr__EntityType___TypeDBConceptManagergetRootEntityType_____const] ==== getRootEntityType @@ -198,6 +247,13 @@ Retrieves the root ``EntityType``, “entity”. .Returns `std::unique_ptr< EntityType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getRootEntityType(); +---- + [#_stdunique_ptr__RelationType___TypeDBConceptManagergetRootRelationType_____const] ==== getRootRelationType @@ -215,6 +271,13 @@ Retrieve the root ``RelationType``, “relation”. .Returns `std::unique_ptr< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getRootRelationType(); +---- + [#_stdvector__DriverException___TypeDBConceptManagergetSchemaExceptions___] ==== getSchemaExceptions @@ -232,6 +295,13 @@ Retrieves a list of all schema exceptions for the current transaction. .Returns `std::vector< DriverException >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.getSchemaExceptions(); +---- + [#_ConceptPtrFuture__AttributeType___TypeDBConceptManagerputAttributeType___const_stdstring__label__ValueType_valueType___const] ==== putAttributeType @@ -259,6 +329,13 @@ a| `valueType` a| The value type of the ``AttributeType`` to create a| `ValueTyp .Returns `ConceptPtrFuture< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.putAttributeType(label, valueType).get(); +---- + [#_ConceptPtrFuture__EntityType___TypeDBConceptManagerputEntityType___const_stdstring__label___const] ==== putEntityType @@ -285,6 +362,13 @@ a| `label` a| The label of the ``EntityType`` to create or retrieve a| `const st .Returns `ConceptPtrFuture< EntityType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.putEntityType(label).get(); +---- + [#_ConceptPtrFuture__RelationType___TypeDBConceptManagerputRelationType___const_stdstring__label___const] ==== putRelationType @@ -311,5 +395,12 @@ a| `label` a| The label of the ``RelationType`` to create or retrieve a| `const .Returns `ConceptPtrFuture< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.concepts.putRelationType(label).get(); +---- + // end::methods[] diff --git a/cpp/docs/connection/Database.adoc b/cpp/docs/connection/Database.adoc index ddb28aef28..d3f25e90b7 100644 --- a/cpp/docs/connection/Database.adoc +++ b/cpp/docs/connection/Database.adoc @@ -25,6 +25,13 @@ Deletes this database. .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +database.deleteDatabase() +---- + [#_stdstring_TypeDBDatabasename_____const] ==== name @@ -58,6 +65,13 @@ Returns the preferred replica for this database. Operations which can be run on .Returns `std::optional< ReplicaInfo >` +[caption=""] +.Code examples +[source,cpp] +---- +database.preferredReplica() +---- + [#_stdoptional__ReplicaInfo___TypeDBDatabaseprimaryReplica___] ==== primaryReplica @@ -75,6 +89,13 @@ Returns the primary replica for this database. _Only works in TypeDB Cloud_ .Returns `std::optional< ReplicaInfo >` +[caption=""] +.Code examples +[source,cpp] +---- +database.primaryReplica() +---- + [#_ReplicaInfoIterable_TypeDBDatabasereplicas___] ==== replicas @@ -92,6 +113,13 @@ Set of ``Replica`` instances for this database. Only works in TypeDB Cloud .Returns `ReplicaInfoIterable` +[caption=""] +.Code examples +[source,cpp] +---- +database.replicas() +---- + [#_stdstring_TypeDBDatabaseruleSchema___] ==== ruleSchema @@ -109,6 +137,13 @@ The rules in the schema as a valid TypeQL define query string. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +database.ruleSchema() +---- + [#_stdstring_TypeDBDatabaseschema___] ==== schema @@ -126,6 +161,13 @@ A full schema text as a valid TypeQL define query string. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +database.schema() +---- + [#_stdstring_TypeDBDatabasetypeSchema___] ==== typeSchema @@ -143,5 +185,12 @@ The types in the schema as a valid TypeQL define query string. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +database.typeSchema() +---- + // end::methods[] diff --git a/cpp/docs/connection/DatabaseManager.adoc b/cpp/docs/connection/DatabaseManager.adoc index 6119e15927..6bc7e16c96 100644 --- a/cpp/docs/connection/DatabaseManager.adoc +++ b/cpp/docs/connection/DatabaseManager.adoc @@ -25,6 +25,13 @@ Retrieves all databases present on the TypeDB server .Returns `DatabaseIterable` +[caption=""] +.Code examples +[source,cpp] +---- +driver.databases.all() +---- + [#_bool_TypeDBDatabaseManagercontains___const_stdstring____const] ==== contains @@ -51,6 +58,13 @@ a| `name` a| The database name to be checked a| .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +driver.databases.contains(name) +---- + [#_void_TypeDBDatabaseManagercreate___const_stdstring____const] ==== create @@ -77,6 +91,13 @@ a| `name` a| The name of the database to be created a| .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +driver.databases.create(name) +---- + [#_Database_TypeDBDatabaseManagerget___const_stdstring____const] ==== get @@ -103,5 +124,12 @@ a| `name` a| The name of the database to retrieve a| .Returns `Database` +[caption=""] +.Code examples +[source,cpp] +---- +driver.databases.get(name) +---- + // end::methods[] diff --git a/cpp/docs/connection/Driver.adoc b/cpp/docs/connection/Driver.adoc index 0be4186459..18324459e7 100644 --- a/cpp/docs/connection/Driver.adoc +++ b/cpp/docs/connection/Driver.adoc @@ -37,6 +37,13 @@ Closes the driver. Before instantiating a new driver, the driver that’s curren .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +driver.close() +---- + [#_static_Driver_TypeDBDrivercloudDriver___const_stdvector__stdstring____cloudAddresses__const_Credential__credential_] ==== cloudDriver @@ -64,6 +71,13 @@ a| `credential` a| The Credential to connect with a| `const Credential&` .Returns `static Driver` +[caption=""] +.Code examples +[source,cpp] +---- +Driver::cloudDriver(addresses, credential); +---- + [#_static_Driver_TypeDBDrivercoreDriver___const_stdstring__coreAddress_] ==== coreDriver @@ -90,6 +104,13 @@ a| `address` a| The address of the TypeDB server a| .Returns `static Driver` +[caption=""] +.Code examples +[source,cpp] +---- +Driver::coreDriver(address); +---- + [#_static_void_TypeDBDriverinitLogging___] ==== initLogging @@ -107,6 +128,13 @@ Enables logging in the TypeDB driver. .Returns `static void` +[caption=""] +.Code examples +[source,cpp] +---- +Driver::initLogging(); +---- + [#_bool_TypeDBDriverisOpen___] ==== isOpen @@ -124,6 +152,13 @@ Checks whether this connection is presently open. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +driver.isOpen(); +---- + [#_Session_TypeDBDriversession___const_stdstring__database__SessionType_sessionType__const_Options__options__Options___] ==== session @@ -152,6 +187,13 @@ a| `options` a| ``TypeDBOptions`` for the session a| .Returns `Session` +[caption=""] +.Code examples +[source,cpp] +---- +driver.session(database, sessionType, options); +---- + [#_User_TypeDBDriveruser___] ==== user @@ -169,5 +211,12 @@ Returns the logged-in user for the connection. Only for TypeDB Cloud. .Returns `User` +[caption=""] +.Code examples +[source,cpp] +---- +driver.user(); +---- + // end::methods[] diff --git a/cpp/docs/connection/UserManager.adoc b/cpp/docs/connection/UserManager.adoc index a850ff9c1e..2152ae91e3 100644 --- a/cpp/docs/connection/UserManager.adoc +++ b/cpp/docs/connection/UserManager.adoc @@ -25,6 +25,13 @@ Retrieves all users which exist on the TypeDB server. .Returns `UserIterable` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.all(); +---- + [#_bool_TypeDBUserManagercontains___const_stdstring__username___const] ==== contains @@ -51,6 +58,13 @@ a| `username` a| The user name to be checked a| `const std::string&` .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.contains(username); +---- + [#_void_TypeDBUserManagercreate___const_stdstring__username__const_stdstring__password___const] ==== create @@ -78,6 +92,13 @@ a| `password` a| The password of the user to be created a| `const std::string&` .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.create(username, password); +---- + [#_void_TypeDBUserManagerdeleteUser___const_stdstring__username___const] ==== deleteUser @@ -104,6 +125,13 @@ a| `username` a| The name of the user to be deleted a| `const std::string&` .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.deleteUser(username); +---- + [#_stdunique_ptr__User___TypeDBUserManagerget___const_stdstring__username___const] ==== get @@ -130,6 +158,13 @@ a| `username` a| The name of the user to retrieve a| `const std::string&` .Returns `std::unique_ptr< User >` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.get(username); +---- + [#_void_TypeDBUserManagerpasswordSet___const_stdstring__username__const_stdstring__password___const] ==== passwordSet @@ -157,5 +192,12 @@ a| `password` a| The new password a| `const std::string&` .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +driver.users.passwordSet(username, password); +---- + // end::methods[] diff --git a/cpp/docs/data/Attribute.adoc b/cpp/docs/data/Attribute.adoc index e8556af852..f4e59008da 100644 --- a/cpp/docs/data/Attribute.adoc +++ b/cpp/docs/data/Attribute.adoc @@ -41,6 +41,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< Thing >` +[caption=""] +.Code examples +[source,cpp] +---- +attribute.getOwners(transaction); +---- + [#_ConceptIterable__Thing___TypeDBAttributegetOwners___Transaction__transaction__const_ThingType__ptr__ownerType_] ==== getOwners @@ -68,6 +75,13 @@ a| `ownerType` a| Filter results for only owners of the given type a| `const Thi .Returns `ConceptIterable< Thing >` +[caption=""] +.Code examples +[source,cpp] +---- +attribute.getOwners(transaction, ownerType); +---- + [#_stdunique_ptr__AttributeType___TypeDBAttributegetType___] ==== getType @@ -85,6 +99,13 @@ Retrieves the type which this ``Attribute`` belongs to. .Returns `std::unique_ptr< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +attribute.getType(); +---- + [#_stdunique_ptr__Value___TypeDBAttributegetValue___] ==== getValue @@ -102,5 +123,12 @@ Retrieves the value which the ``Attribute`` instance holds. .Returns `std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +attribute.getValue(); +---- + // end::methods[] diff --git a/cpp/docs/data/Entity.adoc b/cpp/docs/data/Entity.adoc index 7292eb9420..e70b11a7de 100644 --- a/cpp/docs/data/Entity.adoc +++ b/cpp/docs/data/Entity.adoc @@ -32,5 +32,12 @@ Retrieves the type which this ``Entity`` belongs to. .Returns `std::unique_ptr< EntityType >` +[caption=""] +.Code examples +[source,cpp] +---- +entity.getType(); +---- + // end::methods[] diff --git a/cpp/docs/data/Relation.adoc b/cpp/docs/data/Relation.adoc index 01965a6ca3..17c5ce4232 100644 --- a/cpp/docs/data/Relation.adoc +++ b/cpp/docs/data/Relation.adoc @@ -43,6 +43,13 @@ a| `player` a| The thing to play the role a| `Thing*` .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +relation.addPlayer(transaction, roleType, player).get(); +---- + [#_stdmap__stdunique_ptr__RoleType____stdunique_ptr__Thing_____TypeDBRelationgetPlayers___Transaction__transaction_] ==== getPlayers @@ -69,6 +76,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `std::map< std::unique_ptr< RoleType >, std::unique_ptr< Thing > >` +[caption=""] +.Code examples +[source,cpp] +---- +relation.getPlayers(transaction) +---- + [#_ConceptIterable__Thing___TypeDBRelationgetPlayersByRoleType___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes_] ==== getPlayersByRoleType @@ -96,6 +110,13 @@ a| `roleTypes` a| 0 or more role types a| `const std::vector< std::unique_ptr< R .Returns `ConceptIterable< Thing >` +[caption=""] +.Code examples +[source,cpp] +---- +relation.getPlayersByRoleType(transaction, roleTypes); +---- + [#_ConceptIterable__Thing___TypeDBRelationgetPlayersByRoleType___Transaction__transaction__const_stdvector__RoleType__ptr_____roleTypes_] ==== getPlayersByRoleType @@ -138,6 +159,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +relation.getRelating(transaction); +---- + [#_stdunique_ptr__RelationType___TypeDBRelationgetType___] ==== getType @@ -155,6 +183,13 @@ Retrieves the type which this ``Relation`` belongs to. .Returns `std::unique_ptr< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +relation.getType(); +---- + [#_VoidFuture_TypeDBRelationremovePlayer___Transaction__transaction__RoleType__ptr__roleType__Thing__ptr__player_] ==== removePlayer @@ -183,5 +218,12 @@ a| `player` a| The instance to no longer play the role in this ``Relation`` a| ` .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +relation.removePlayer(transaction, roleType, player).get(); +---- + // end::methods[] diff --git a/cpp/docs/data/Thing.adoc b/cpp/docs/data/Thing.adoc index 52b8aeb9f8..73958f85c1 100644 --- a/cpp/docs/data/Thing.adoc +++ b/cpp/docs/data/Thing.adoc @@ -38,6 +38,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thing.deleteThing(transaction).get(); +---- + [#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdinitializer_list__Annotation____annotations___] ==== getHas @@ -65,6 +72,14 @@ a| `annotations` a| Only retrieve attributes with all given ``Annotation``s a| .Returns `ConceptIterable< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getHas(transaction); +thing.getHas(transaction, {Annotation.key()})); +---- + [#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_AttributeType__ptr__attribute_] ==== getHas @@ -108,6 +123,13 @@ a| `attributeTypes` a| The ``AttributeType``s to filter the attributes by a| `co .Returns `ConceptIterable< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getHas(transaction, attributeTypes); +---- + [#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__const_AttributeType__ptr_____attributeTypes_] ==== getHas @@ -157,6 +179,13 @@ Retrieves the unique id of the ``Thing``. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getIID(); +---- + [#_ConceptIterable__RoleType___TypeDBThinggetPlaying___Transaction__transaction_] ==== getPlaying @@ -183,6 +212,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getPlaying(transaction); +---- + [#_ConceptIterable__Relation___TypeDBThinggetRelations___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes___] ==== getRelations @@ -210,6 +246,14 @@ a| `roleTypes` a| The array of roles to filter the relations by. a| .Returns `ConceptIterable< Relation >` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getRelations(transaction); +thing.getRelations(transaction, roleTypes); +---- + [#_ConceptIterable__Relation___TypeDBThinggetRelations___Transaction__transaction__const_stdvector__RoleType__ptr_____roleTypes_] ==== getRelations @@ -243,6 +287,13 @@ Retrieves the type which this ``Thing`` belongs to. .Returns `std::unique_ptr< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +thing.getType(); +---- + [#_BoolFuture_TypeDBThingisDeleted___Transaction__transaction_] ==== isDeleted @@ -269,6 +320,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `BoolFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thing.isDeleted(transaction).get(); +---- + [#_bool_TypeDBThingisInferred___] ==== isInferred @@ -286,6 +344,13 @@ Checks if this ``Thing`` is inferred by a [Reasoning Rule]. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +thing.isInferred(); +---- + [#_VoidFuture_TypeDBThingsetHas___Transaction__transaction__Attribute__ptr__attribute_] ==== setHas @@ -313,6 +378,13 @@ a| `attribute` a| The ``Attribute`` to be owned by this ``Thing``. a| `Attribute .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thing.setHas(transaction, attribute).get(); +---- + [#_VoidFuture_TypeDBThingunsetHas___Transaction__transaction__Attribute__ptr__attribute_] ==== unsetHas @@ -340,5 +412,12 @@ a| `attribute` a| The ``Attribute`` to be disowned from this ``Thing``. a| `Attr .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thing.unsetHas(transaction, attribute).get(); +---- + // end::methods[] diff --git a/cpp/docs/data/Value.adoc b/cpp/docs/data/Value.adoc index 45bc424bc3..42dd6ff7ac 100644 --- a/cpp/docs/data/Value.adoc +++ b/cpp/docs/data/Value.adoc @@ -29,6 +29,13 @@ Returns a ``boolean`` value of this value concept. If the value has another type .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.asBoolean(); +---- + [#_DateTime_TypeDBValueasDateTime___] ==== asDateTime @@ -46,6 +53,13 @@ Returns a ``DateTime`` value of this value concept. If the value has another typ .Returns `DateTime` +[caption=""] +.Code examples +[source,cpp] +---- +value.asDatetime(); +---- + [#_double_TypeDBValueasDouble___] ==== asDouble @@ -63,6 +77,13 @@ Returns a ``double`` value of this value concept. If the value has another type, .Returns `double` +[caption=""] +.Code examples +[source,cpp] +---- +value.asDouble(); +---- + [#_int64_t_TypeDBValueasLong___] ==== asLong @@ -80,6 +101,13 @@ Returns a ``long`` value of this value concept. If the value has another type, r .Returns `int64_t` +[caption=""] +.Code examples +[source,cpp] +---- +value.asLong(); +---- + [#_stdstring_TypeDBValueasString___] ==== asString @@ -97,6 +125,13 @@ Returns a ``string`` value of this value concept. If the value has another type, .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +value.asString(); +---- + [#_static_stdstring_TypeDBValueformatDateTime___DateTime_t_] ==== formatDateTime @@ -114,6 +149,13 @@ Returns a string in the TypeQL DateTime format corresponding to the specified Da .Returns `static std::string` +[caption=""] +.Code examples +[source,cpp] +---- +Value::formatDateTime(datetime); +---- + [#_bool_TypeDBValueisBoolean___] ==== isBoolean @@ -131,6 +173,13 @@ Returns ``true`` if the value which this value concept holds is of type ``boolea .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.isBoolean() +---- + [#_bool_TypeDBValueisDateTime___] ==== isDateTime @@ -148,6 +197,13 @@ Returns ``True`` if the value which this value concept holds is of type ``DateTi .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.isDatetime(); +---- + [#_bool_TypeDBValueisDouble___] ==== isDouble @@ -165,6 +221,13 @@ Returns ``true`` if the value which this value concept holds is of type ``double .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.isDouble(); +---- + [#_bool_TypeDBValueisLong___] ==== isLong @@ -182,6 +245,13 @@ Returns ``true`` if the value which this value concept holds is of type ``long`` .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.isLong() +---- + [#_bool_TypeDBValueisString___] ==== isString @@ -199,6 +269,13 @@ Returns ``true`` if the value which this value concept holds is of type ``string .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +value.isString(); +---- + [#_static_stdunique_ptr__Value___TypeDBValueof___bool_value_] ==== of @@ -216,6 +293,13 @@ Creates a new Value object of the specified boolean value. .Returns `static std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +Value::of(value); +---- + [#_static_stdunique_ptr__Value___TypeDBValueof___int64_t_value_] ==== of @@ -233,6 +317,13 @@ Creates a new Value object of the specified long value. .Returns `static std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +Value::of(value); +---- + [#_static_stdunique_ptr__Value___TypeDBValueof___double_value_] ==== of @@ -250,6 +341,13 @@ Creates a new Value object of the specified double value. .Returns `static std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +Value::of(value); +---- + [#_static_stdunique_ptr__Value___TypeDBValueof___const_stdstring__value_] ==== of @@ -267,6 +365,13 @@ Creates a new Value object of the specified string value. .Returns `static std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +Value::of(value); +---- + [#_static_stdunique_ptr__Value___TypeDBValueof___DateTime_value_] ==== of @@ -284,6 +389,13 @@ Creates a new Value object of the specified DateTime value. .Returns `static std::unique_ptr< Value >` +[caption=""] +.Code examples +[source,cpp] +---- +Value::of(value); +---- + [#_static_DateTime_TypeDBValueparseDateTime___const_stdstring__s_] ==== parseDateTime @@ -301,6 +413,13 @@ Parses a DateTime from a string in the TypeQL DateTime format (yyyy-mm-dd'T'HH:M .Returns `static DateTime` +[caption=""] +.Code examples +[source,cpp] +---- +Value::parseDateTime(str); +---- + [#_ValueType_TypeDBValuevalueType___] ==== valueType @@ -318,5 +437,12 @@ Retrieves the ``ValueType`` of this value concept. .Returns `ValueType` +[caption=""] +.Code examples +[source,cpp] +---- +value.getType() +---- + // end::methods[] diff --git a/cpp/docs/errors/DriverException.adoc b/cpp/docs/errors/DriverException.adoc index 3e1df49ecd..211e889679 100644 --- a/cpp/docs/errors/DriverException.adoc +++ b/cpp/docs/errors/DriverException.adoc @@ -25,6 +25,16 @@ Retrieves the error code. .Returns `const std::string_view` +[caption=""] +.Code examples +[source,cpp] +---- +try { ... } +catch (TypeDB::DriverException& e){ + if ("[CXN11]" == e.code()) { ... } +} +---- + [#_const_stdstring_view_TypeDBDriverExceptionmessage___] ==== message @@ -42,5 +52,16 @@ Retrieves the descriptive error message. .Returns `const std::string_view` +[caption=""] +.Code examples +[source,cpp] +---- +try { ... } +catch (TypeDB::DriverException& e){ + logError(e.message()); + throw e; +} +---- + // end::methods[] diff --git a/cpp/docs/logic/LogicManager.adoc b/cpp/docs/logic/LogicManager.adoc index 95eed7b458..9843845f8f 100644 --- a/cpp/docs/logic/LogicManager.adoc +++ b/cpp/docs/logic/LogicManager.adoc @@ -34,6 +34,13 @@ a| `label` a| The label of the Rule to create or retrieve a| `const std::string& .Returns `OptionalRuleFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.logic.getRule(label).get(); +---- + [#_RuleIterable_TypeDBLogicManagergetRules_____const] ==== getRules @@ -51,6 +58,13 @@ Retrieves all rules. .Returns `RuleIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.logic.getRules() +---- + [#_RuleFuture_TypeDBLogicManagerputRule___const_stdstring__label__const_stdstring__when__const_stdstring__then___const] ==== putRule @@ -79,5 +93,12 @@ a| `then` a| The then body of the rule to create a| `const std::string&` .Returns `RuleFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.logic.putRule(label, when, then).get(); +---- + // end::methods[] diff --git a/cpp/docs/logic/Rule.adoc b/cpp/docs/logic/Rule.adoc index 32dc7ab46a..fae4a2ef9b 100644 --- a/cpp/docs/logic/Rule.adoc +++ b/cpp/docs/logic/Rule.adoc @@ -36,6 +36,13 @@ a| `transaction` a| The current ``Transaction`` a| `Transaction&` .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +rule.deleteRule(transaction).get(); +---- + [#_BoolFuture_TypeDBRuleisDeleted___Transaction__transaction_] ==== isDeleted @@ -62,6 +69,13 @@ a| `transaction` a| The current ``Transaction`` a| `Transaction&` .Returns `BoolFuture` +[caption=""] +.Code examples +[source,cpp] +---- +rule.isDeleted(transaction).get(); +---- + [#_stdstring_TypeDBRulelabel___] ==== label @@ -105,6 +119,13 @@ a| `label` a| The new label to be given to the rule a| `const std::string&` .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +rule.setLabel(transaction, newLabel).get(); +---- + [#_stdstring_TypeDBRulethen___] ==== then diff --git a/cpp/docs/schema/Annotation.adoc b/cpp/docs/schema/Annotation.adoc index 3a588017bb..72c12c3a9c 100644 --- a/cpp/docs/schema/Annotation.adoc +++ b/cpp/docs/schema/Annotation.adoc @@ -25,6 +25,13 @@ Checks if this ``Annotation`` is a ``@key`` annotation. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +annotation.isKey(); +---- + [#_bool_TypeDBAnnotationisUnique___] ==== isUnique @@ -42,6 +49,13 @@ Checks if this ``Annotation`` is a ``@unique`` annotation. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +annotation.isUnique(); +---- + [#_static_Annotation_TypeDBAnnotationkey___] ==== key @@ -59,6 +73,13 @@ Produces a ``@key`` annotation. .Returns `static Annotation` +[caption=""] +.Code examples +[source,cpp] +---- +ThingType.Annotation.key(); +---- + [#_stdstring_TypeDBAnnotationtoString___] ==== toString @@ -92,5 +113,12 @@ Produces a ``@unique`` annotation. .Returns `static Annotation` +[caption=""] +.Code examples +[source,cpp] +---- +Annotation.unique(); +---- + // end::methods[] diff --git a/cpp/docs/schema/AttributeType.adoc b/cpp/docs/schema/AttributeType.adoc index cb6e1b7d3a..7d369bd848 100644 --- a/cpp/docs/schema/AttributeType.adoc +++ b/cpp/docs/schema/AttributeType.adoc @@ -47,6 +47,13 @@ a| `value` a| ``Attribute``’s value a| `Value*` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__const_stdstring__value_] ==== get @@ -74,6 +81,13 @@ a| `value` a| ``Attribute``’s value a| `const std::string&` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__int64_t_value_] ==== get @@ -101,6 +115,13 @@ a| `value` a| ``Attribute``’s value a| `int64_t` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__double_value_] ==== get @@ -128,6 +149,13 @@ a| `value` a| ``Attribute``’s value a| `double` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__bool_value_] ==== get @@ -155,6 +183,13 @@ a| `value` a| ``Attribute``’s value a| `bool` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__DateTime_value_] ==== get @@ -182,6 +217,13 @@ a| `value` a| ``Attribute``’s value a| `DateTime` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.get(transaction, value).get(); +---- + [#_ConceptIterable__Attribute___TypeDBAttributeTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getInstances @@ -209,6 +251,18 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getInstances(transaction); +attributeType.getInstances(transaction, transitivity); + Parameters + + transitivity Transitivity::TRANSITIVE for direct and indirect subtypes, Transitivity::EXPLICIT for direct subtypes only + transaction The current transaction +---- + [#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getOwners @@ -236,6 +290,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getOwners(transaction); +---- + [#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Transaction__transaction__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getOwners @@ -264,6 +325,35 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getOwners(transaction, {Annotation::key()}, transitivity); + */ +ConceptIterable getOwners(Transaction& transaction, const std::initializer_list& annotations, Transitivity transitivity = Transitivity::TRANSITIVE); + +/** + Retrieve all Things that own an attribute of this AttributeType, + filtered by Annotations, directly or through inheritance. + + Examples +---- + +[source,cpp] +---- +attributeType.getOwners(transaction, annotations); +---- + +[source,cpp] +---- +Parameters + + transaction The current transaction + annotations Only retrieve ThingTypes that have an attribute of this AttributeType with all given Annotations + transitivity Transitivity::TRANSITIVE for direct and indirect subtypes, Transitivity::EXPLICIT for direct subtypes only +---- + [#_OptionalStringFuture_TypeDBAttributeTypegetRegex___Transaction__transaction_] ==== getRegex @@ -290,6 +380,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `OptionalStringFuture` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getRegex(transaction).get(); +---- + [#_ConceptIterable__AttributeType___TypeDBAttributeTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -317,6 +414,14 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getSubtypes(transaction); +attributeType.getSubtypes(transaction, transitivity); +---- + [#_ConceptIterable__AttributeType___TypeDBAttributeTypegetSubtypes___Transaction__transaction__ValueType_valueType__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -345,6 +450,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getSubtypes(transaction, valueType, transitivity); +---- + [#_ValueType_TypeDBAttributeTypegetValueType___] ==== getValueType @@ -362,6 +474,13 @@ Retrieves the ``Value.Type`` of this ``AttributeType``. .Returns `ValueType` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.getValueType(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__Value__ptr__value_] ==== put @@ -389,6 +508,13 @@ a| `value` a| New ``Attribute``’s value a| `Value*` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__const_stdstring__value_] ==== put @@ -416,6 +542,13 @@ a| `value` a| New ``Attribute``’s value a| `const std::string&` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__int64_t_value_] ==== put @@ -443,6 +576,13 @@ a| `value` a| New ``Attribute``’s value a| `int64_t` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__double_value_] ==== put @@ -470,6 +610,13 @@ a| `value` a| New ``Attribute``’s value a| `double` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__bool_value_] ==== put @@ -497,6 +644,13 @@ a| `value` a| New ``Attribute``’s value a| `bool` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__DateTime_value_] ==== put @@ -524,6 +678,13 @@ a| `value` a| New ``Attribute``’s value a| `DateTime` .Returns `ConceptPtrFuture< Attribute >` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.put(transaction, value).get(); +---- + [#_VoidFuture_TypeDBAttributeTypesetRegex___Transaction__transaction__const_stdstring__regex_] ==== setRegex @@ -553,6 +714,13 @@ a| `regex` a| Regular expression a| `const std::string&` .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.setRegex(transaction, regex).get(); +---- + [#_VoidFuture_TypeDBAttributeTypesetSupertype___Transaction__transaction__AttributeType__ptr__attributeType_] ==== setSupertype @@ -580,6 +748,13 @@ a| `attributeType` a| The ``AttributeType`` to set as the supertype of this ``At .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.setSupertype(transaction, superType).get(); +---- + [#_VoidFuture_TypeDBAttributeTypeunsetRegex___Transaction__transaction_] ==== unsetRegex @@ -606,5 +781,12 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +attributeType.unsetRegex(transaction).get(); +---- + // end::methods[] diff --git a/cpp/docs/schema/EntityType.adoc b/cpp/docs/schema/EntityType.adoc index 082b09279d..138a3fbfd3 100644 --- a/cpp/docs/schema/EntityType.adoc +++ b/cpp/docs/schema/EntityType.adoc @@ -40,6 +40,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< Entity >` +[caption=""] +.Code examples +[source,cpp] +---- +entityType.create(transaction).get(); +---- + [#_ConceptIterable__Entity___TypeDBEntityTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getInstances @@ -67,6 +74,13 @@ a| `transitivity` a| ``Transitivity::EXPLICIT`` for direct instances only, ``Tra .Returns `ConceptIterable< Entity >` +[caption=""] +.Code examples +[source,cpp] +---- +entityType.getInstances(transaction, transitivity); +---- + [#_ConceptIterable__EntityType___TypeDBEntityTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -94,6 +108,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< EntityType >` +[caption=""] +.Code examples +[source,cpp] +---- +entityType.getSubtypes(transaction, transitivity); +---- + [#_VoidFuture_TypeDBEntityTypesetSupertype___Transaction__transaction__EntityType__ptr__superEntityType_] ==== setSupertype @@ -121,5 +142,12 @@ a| `superEntityType` a| The ``EntityType`` to set as the supertype of this ``Ent .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +entityType.setSupertype(transaction, entityType).get(); +---- + // end::methods[] diff --git a/cpp/docs/schema/RelationType.adoc b/cpp/docs/schema/RelationType.adoc index 6b38e23af6..63f3b3fa9f 100644 --- a/cpp/docs/schema/RelationType.adoc +++ b/cpp/docs/schema/RelationType.adoc @@ -42,6 +42,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< Relation >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.create(transaction).get(); +---- + [#_ConceptIterable__Relation___TypeDBRelationTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getInstances @@ -69,6 +76,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect instan .Returns `ConceptIterable< Relation >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getInstances(transaction, transitivity) +---- + [#_ConceptIterable__RoleType___TypeDBRelationTypegetRelates___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getRelates @@ -96,6 +110,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and inherited relat .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getRelates(transaction, transitivity); +---- + [#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelates___Transaction__transaction__const_stdstring__roleLabel_] ==== getRelates @@ -123,6 +144,13 @@ a| `roleLabel` a| Label of the role we wish to retrieve a| `const std::string&` .Returns `ConceptPtrFuture< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getRelates(transaction, roleLabel).get(); +---- + [#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelatesOverridden___Transaction__transaction__RoleType__ptr__roleType_] ==== getRelatesOverridden @@ -150,6 +178,13 @@ a| `roleLabel` a| Label of the role that overrides an inherited role a| .Returns `ConceptPtrFuture< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getRelatesOverridden(transaction, roleLabel).get(); +---- + [#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelatesOverridden___Transaction__transaction__const_stdstring__roleLabel_] ==== getRelatesOverridden @@ -177,6 +212,13 @@ a| `roleLabel` a| Label of the role that overrides an inherited role a| `const s .Returns `ConceptPtrFuture< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getRelatesOverridden(transaction, roleLabel).get(); +---- + [#_ConceptIterable__RelationType___TypeDBRelationTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -204,6 +246,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.getSubtypes(transaction, transitivity); +---- + [#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel_] ==== setRelates @@ -264,6 +313,14 @@ a| `overriddenLabel` a| The label being overridden, if applicable a| `const std: .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.setRelates(transaction, roleLabel).get(); +relationType.setRelates(transaction, roleLabel, overriddenLabel).get(); +---- + [#_VoidFuture_TypeDBRelationTypesetSupertype___Transaction__transaction__RelationType__ptr__superRelationType_] ==== setSupertype @@ -291,6 +348,13 @@ a| `superRelationType` a| The ``RelationType`` to set as the supertype of this ` .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.setSupertype(transaction, superRelationType).get(); +---- + [#_VoidFuture_TypeDBRelationTypeunsetRelates___Transaction__transaction__RoleType__ptr__roleType_] ==== unsetRelates @@ -334,5 +398,12 @@ a| `roleLabel` a| The role to not relate to the relation type. a| `const std::st .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +relationType.unsetRelates(transaction, roleLabel).get(); +---- + // end::methods[] diff --git a/cpp/docs/schema/RoleType.adoc b/cpp/docs/schema/RoleType.adoc index fd5fe780dd..b7ae22d737 100644 --- a/cpp/docs/schema/RoleType.adoc +++ b/cpp/docs/schema/RoleType.adoc @@ -45,6 +45,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.deleteType(transaction).get(); +---- + [#_virtual_stdstring_TypeDBRoleTypegetLabel___] ==== getLabel @@ -66,6 +73,13 @@ Implements TypeDB::Type. .Returns `virtual std::string` +[caption=""] +.Code examples +[source,cpp] +---- +type.getLabel(); +---- + [#_stdstring_TypeDBRoleTypegetName___] ==== getName @@ -83,6 +97,13 @@ Returns the name of this role type's label. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +label.getName(); +---- + [#_ConceptIterable__Thing___TypeDBRoleTypegetPlayerInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getPlayerInstances @@ -110,6 +131,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect playin .Returns `ConceptIterable< Thing >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getPlayerInstances(transaction, transitivity); +---- + [#_ConceptIterable__ThingType___TypeDBRoleTypegetPlayerTypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getPlayerTypes @@ -137,6 +165,13 @@ a| `transitivity` a| ``Transitivity.TRANSITIVE`` for direct and indirect playing .Returns `ConceptIterable< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getPlayerTypes(transaction, transitivity) +---- + [#_ConceptIterable__Relation___TypeDBRoleTypegetRelationInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getRelationInstances @@ -164,6 +199,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect relati .Returns `ConceptIterable< Relation >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getRelationInstances(transaction, transitivity) +---- + [#_ConceptPtrFuture__RelationType___TypeDBRoleTypegetRelationType___Transaction__transaction_] ==== getRelationType @@ -190,6 +232,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getRelationType(transaction).get(); +---- + [#_ConceptIterable__RelationType___TypeDBRoleTypegetRelationTypes___Transaction__transaction_] ==== getRelationTypes @@ -216,6 +265,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< RelationType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getRelationTypes(transaction); +---- + [#_stdstring_TypeDBRoleTypegetScope___] ==== getScope @@ -233,6 +289,13 @@ Returns the scope part of this role type's label. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +label.getScope(); +---- + [#_ConceptIterable__RoleType___TypeDBRoleTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -260,6 +323,13 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getSubtypes(transaction, transitivity); +---- + [#_ConceptPtrFuture__RoleType___TypeDBRoleTypegetSupertype___Transaction__transaction_] ==== getSupertype @@ -286,6 +356,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getSupertype(transaction).get(); +---- + [#_ConceptIterable__RoleType___TypeDBRoleTypegetSupertypes___Transaction__transaction_] ==== getSupertypes @@ -312,6 +389,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +roleType.getSupertypes(transaction); +---- + [#_virtual_bool_TypeDBRoleTypeisAbstract___] ==== isAbstract @@ -333,6 +417,13 @@ Implements TypeDB::Type. .Returns `virtual bool` +[caption=""] +.Code examples +[source,cpp] +---- +type.isAbstract(); +---- + [#_virtual_BoolFuture_TypeDBRoleTypeisDeleted___Transaction__transaction_] ==== isDeleted @@ -363,6 +454,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual BoolFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.isDeleted(transaction).get(); +---- + [#_bool_TypeDBRoleTypeisRoot___] ==== isRoot @@ -380,6 +478,13 @@ Checks if the type is a root type. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +type.isRoot(); +---- + [#_virtual_VoidFuture_TypeDBRoleTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] ==== setLabel @@ -411,5 +516,12 @@ a| `label` a| The new ``Label`` to be given to the type. a| .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.setLabel(transaction, newLabel).get(); +---- + // end::methods[] diff --git a/cpp/docs/schema/ThingType.adoc b/cpp/docs/schema/ThingType.adoc index 7c044faa70..471a8b3715 100644 --- a/cpp/docs/schema/ThingType.adoc +++ b/cpp/docs/schema/ThingType.adoc @@ -43,6 +43,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.deleteType(transaction).get(); +---- + [#_virtual_stdstring_TypeDBThingTypegetLabel___] ==== getLabel @@ -64,6 +71,13 @@ Implements TypeDB::Type. .Returns `virtual std::string` +[caption=""] +.Code examples +[source,cpp] +---- +type.getLabel(); +---- + [#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getOwns @@ -175,6 +189,14 @@ a| `annotations` a| Only retrieve attribute types owned with annotations. a| `co .Returns `ConceptIterable< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.getOwns(transaction); +thingType.getOwns(transaction, valueType, Transitivity::EXPLICIT, Collections.singleton(Annotation.key())); +---- + [#_ConceptPtrFuture__AttributeType___TypeDBThingTypegetOwnsOverridden___Transaction__transaction__AttributeType__ptr__attributeType_] ==== getOwnsOverridden @@ -202,6 +224,13 @@ a| `attributeType` a| The ``AttributeType`` that overrides requested ``Attribute .Returns `ConceptPtrFuture< AttributeType >` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.getOwnsOverridden(transaction, attributeType).get(); +---- + [#_ConceptIterable__RoleType___TypeDBThingTypegetPlays___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getPlays @@ -229,6 +258,14 @@ a| `transitivity` a| transitivity: ``Transitivity::TRANSITIVE`` for direct and i .Returns `ConceptIterable< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.getPlays(transaction).get(); +thingType.getPlays(transaction, Transitivity::EXPLICIT).get(); +---- + [#_ConceptPtrFuture__RoleType___TypeDBThingTypegetPlaysOverridden___Transaction__transaction__RoleType__ptr__roleType_] ==== getPlaysOverridden @@ -256,6 +293,13 @@ a| `roleType` a| The ``RoleType`` that overrides an inherited role a| `RoleType* .Returns `ConceptPtrFuture< RoleType >` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.getPlaysOverridden(transaction, roleType).get(); +---- + [#_ConceptIterable__ThingType___TypeDBThingTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -285,6 +329,14 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSubtypes(transaction); +type.getSubtypes(transaction, Transitivity.EXPLICIT); +---- + [#_ConceptPtrFuture__ThingType___TypeDBThingTypegetSupertype___Transaction__transaction_] ==== getSupertype @@ -313,6 +365,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSupertype(transaction).get(); +---- + [#_ConceptIterable__ThingType___TypeDBThingTypegetSupertypes___Transaction__transaction_] ==== getSupertypes @@ -341,6 +400,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< ThingType >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSupertypes(transaction); +---- + [#_StringFuture_TypeDBThingTypegetSyntax___Transaction__transaction_] ==== getSyntax @@ -367,6 +433,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `StringFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.getSyntax(transaction).get(); +---- + [#_virtual_bool_TypeDBThingTypeisAbstract___] ==== isAbstract @@ -388,6 +461,13 @@ Implements TypeDB::Type. .Returns `virtual bool` +[caption=""] +.Code examples +[source,cpp] +---- +type.isAbstract(); +---- + [#_virtual_BoolFuture_TypeDBThingTypeisDeleted___Transaction__transaction_] ==== isDeleted @@ -418,6 +498,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual BoolFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.isDeleted(transaction).get(); +---- + [#_bool_TypeDBThingTypeisRoot___] ==== isRoot @@ -435,6 +522,13 @@ Checks if the type is a root type. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +type.isRoot(); +---- + [#_VoidFuture_TypeDBThingTypesetAbstract___Transaction__transaction_] ==== setAbstract @@ -461,6 +555,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.setAbstract(transaction).get(); +---- + [#_virtual_VoidFuture_TypeDBThingTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] ==== setLabel @@ -492,6 +593,13 @@ a| `label` a| The new ``Label`` to be given to the type. a| .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.setLabel(transaction, newLabel).get(); +---- + [#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__const_stdinitializer_list__Annotation____annotations___] ==== setOwns @@ -571,6 +679,14 @@ a| `annotations` a| Adds annotations to the ownership. a| `const std::vector< An .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.setOwns(transaction, attributeType).get(); +thingType.setOwns(transaction, attributeType, overriddenType, Collections.singleton(Annotation.key())).get(); +---- + [#_VoidFuture_TypeDBThingTypesetPlays___Transaction__transaction__RoleType__ptr__roleType_] ==== setPlays @@ -615,6 +731,14 @@ a| `overriddenType` a| The role type that this role overrides, if applicable a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.setPlays(transaction, roleType).get(); +thingType.setPlays(transaction, roleType, overriddenType).get(); +---- + [#_VoidFuture_TypeDBThingTypeunsetAbstract___Transaction__transaction_] ==== unsetAbstract @@ -641,6 +765,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.unsetAbstract(transaction).get(); +---- + [#_VoidFuture_TypeDBThingTypeunsetOwns___Transaction__transaction__AttributeType__ptr__attributeType_] ==== unsetOwns @@ -668,6 +799,13 @@ a| `attributeType` a| The ``AttributeType`` to not be owned by the type. a| `Att .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.unsetOwns(transaction, attributeType).get(); +---- + [#_VoidFuture_TypeDBThingTypeunsetPlays___Transaction__transaction__RoleType__ptr__roleType_] ==== unsetPlays @@ -695,5 +833,12 @@ a| `roleType` a| The role to not be played by the instances of this type. a| `Ro .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +thingType.unsetPlays(transaction, roleType).get(); +---- + // end::methods[] diff --git a/cpp/docs/schema/Type.adoc b/cpp/docs/schema/Type.adoc index 1fb9d6817e..67853a9f82 100644 --- a/cpp/docs/schema/Type.adoc +++ b/cpp/docs/schema/Type.adoc @@ -40,6 +40,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.deleteType(transaction).get(); +---- + [#_virtual_stdstring_TypeDBTypegetLabel___] ==== getLabel @@ -59,6 +66,13 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. .Returns `virtual std::string` +[caption=""] +.Code examples +[source,cpp] +---- +type.getLabel(); +---- + [#_ConceptIterable__Type___TypeDBTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] ==== getSubtypes @@ -86,6 +100,14 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp .Returns `ConceptIterable< Type >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSubtypes(transaction); +type.getSubtypes(transaction, Transitivity.EXPLICIT); +---- + [#_ConceptPtrFuture__Type___TypeDBTypegetSupertype___Transaction__transaction_] ==== getSupertype @@ -112,6 +134,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptPtrFuture< Type >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSupertype(transaction).get(); +---- + [#_ConceptIterable__Type___TypeDBTypegetSupertypes___Transaction__transaction_] ==== getSupertypes @@ -138,6 +167,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `ConceptIterable< Type >` +[caption=""] +.Code examples +[source,cpp] +---- +type.getSupertypes(transaction); +---- + [#_virtual_bool_TypeDBTypeisAbstract___] ==== isAbstract @@ -157,6 +193,13 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. .Returns `virtual bool` +[caption=""] +.Code examples +[source,cpp] +---- +type.isAbstract(); +---- + [#_virtual_BoolFuture_TypeDBTypeisDeleted___Transaction__transaction_] ==== isDeleted @@ -185,6 +228,13 @@ a| `transaction` a| The current transaction a| `Transaction&` .Returns `virtual BoolFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.isDeleted(transaction).get(); +---- + [#_virtual_VoidFuture_TypeDBTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] ==== setLabel @@ -214,5 +264,12 @@ a| `label` a| The new ``Label`` to be given to the type. a| .Returns `virtual VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +type.setLabel(transaction, newLabel).get(); +---- + // end::methods[] diff --git a/cpp/docs/session/Options.adoc b/cpp/docs/session/Options.adoc index 47f6effba1..2718199cfb 100644 --- a/cpp/docs/session/Options.adoc +++ b/cpp/docs/session/Options.adoc @@ -27,6 +27,13 @@ Produces a new ``Options`` object. .Returns `TypeDB::Options::Options` +[caption=""] +.Code examples +[source,cpp] +---- +TypeDBOptions options = TypeDBOptions(); +---- + [#_stdoptional__bool___TypeDBOptionsexplain___] ==== explain @@ -44,6 +51,13 @@ Returns the value set for the explanation in this ``TypeDBOptions`` object. If s .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.explain(); +---- + [#_Options__TypeDBOptionsexplain___bool_explain_] ==== explain @@ -70,6 +84,13 @@ a| `explain` a| Explicitly enable or disable explanations a| `bool` .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.explain(explain); +---- + [#_stdoptional__bool___TypeDBOptionsinfer___] ==== infer @@ -87,6 +108,13 @@ Returns the value set for the inference in this ``TypeDBOptions`` object. .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.infer(); +---- + [#_Options__TypeDBOptionsinfer___bool_infer_] ==== infer @@ -113,6 +141,13 @@ a| `infer` a| Explicitly enable or disable inference a| `bool` .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.infer(infer); +---- + [#_stdoptional__bool___TypeDBOptionsparallel___] ==== parallel @@ -130,6 +165,13 @@ Returns the value set for the parallel execution in this ``TypeDBOptions`` objec .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.parallel(); +---- + [#_Options__TypeDBOptionsparallel___bool_parallel_] ==== parallel @@ -156,6 +198,13 @@ a| `parallel` a| Explicitly enable or disable parallel execution a| `bool` .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.parallel(parallel); +---- + [#_stdoptional__bool___TypeDBOptionsprefetch___] ==== prefetch @@ -173,6 +222,13 @@ Returns the value set for the prefetching in this ``TypeDBOptions`` object. If s .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.prefetch(); +---- + [#_Options__TypeDBOptionsprefetch___bool_prefetch_] ==== prefetch @@ -199,6 +255,13 @@ a| `prefetch` a| Explicitly enable or disable prefetching a| `bool` .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.prefetch(prefetch); +---- + [#_stdoptional__int32_t___TypeDBOptionsprefetchSize___] ==== prefetchSize @@ -216,6 +279,13 @@ Returns the value set for the prefetch size in this ``TypeDBOptions`` object. If .Returns `std::optional< int32_t >` +[caption=""] +.Code examples +[source,cpp] +---- +options.prefetchSize(); +---- + [#_Options__TypeDBOptionsprefetchSize___int32_t_prefetchSize_] ==== prefetchSize @@ -242,6 +312,13 @@ a| `prefetchSize` a| Number of answers that the server should send before the dr .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.prefetchSize(prefetchSize); +---- + [#_stdoptional__bool___TypeDBOptionsreadAnyReplica___] ==== readAnyReplica @@ -259,6 +336,13 @@ Returns the value set for reading data from any replica in this ``TypeDBOptions` .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.readAnyReplica(); +---- + [#_Options__TypeDBOptionsreadAnyReplica___bool_readAnyReplica_] ==== readAnyReplica @@ -285,6 +369,13 @@ a| `readAnyReplica` a| Explicitly enable or disable reading data from any replic .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.readAnyReplica(readAnyReplica); +---- + [#_stdoptional__int64_t___TypeDBOptionsschemaLockAcquireTimeoutMillis___] ==== schemaLockAcquireTimeoutMillis @@ -302,6 +393,13 @@ Returns the value set for the schema lock acquire timeout in this ``TypeDBOption .Returns `std::optional< int64_t >` +[caption=""] +.Code examples +[source,cpp] +---- +options.schemaLockAcquireTimeoutMillis(); +---- + [#_Options__TypeDBOptionsschemaLockAcquireTimeoutMillis___int64_t_timeoutMillis_] ==== schemaLockAcquireTimeoutMillis @@ -328,6 +426,13 @@ a| `schemaLockAcquireTimeoutMillis` a| How long the driver should wait if openin .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.schemaLockAcquireTimeoutMillis(schemaLockAcquireTimeoutMillis); +---- + [#_stdoptional__int64_t___TypeDBOptionssessionIdleTimeoutMillis___] ==== sessionIdleTimeoutMillis @@ -345,6 +450,13 @@ Returns the value set for the session idle timeout in this ``TypeDBOptions`` obj .Returns `std::optional< int64_t >` +[caption=""] +.Code examples +[source,cpp] +---- +options.sessionIdleTimeoutMillis(); +---- + [#_Options__TypeDBOptionssessionIdleTimeoutMillis___int64_t_timeoutMillis_] ==== sessionIdleTimeoutMillis @@ -371,6 +483,13 @@ a| `sessionIdleTimeoutMillis` a| timeout that allows the server to close session .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.sessionIdleTimeoutMillis(sessionIdleTimeoutMillis); +---- + [#_stdoptional__bool___TypeDBOptionstraceInference___] ==== traceInference @@ -388,6 +507,13 @@ Returns the value set for reasoning tracing in this ``TypeDBOptions`` object. If .Returns `std::optional< bool >` +[caption=""] +.Code examples +[source,cpp] +---- +options.traceInference(); +---- + [#_Options__TypeDBOptionstraceInference___bool_traceInference_] ==== traceInference @@ -414,6 +540,13 @@ a| `traceInference` a| Explicitly enable or disable reasoning tracing a| `bool` .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.traceInference(traceInference); +---- + [#_stdoptional__int64_t___TypeDBOptionstransactionTimeoutMillis___] ==== transactionTimeoutMillis @@ -431,6 +564,13 @@ Returns the value set for the transaction timeout in this ``TypeDBOptions`` obje .Returns `std::optional< int64_t >` +[caption=""] +.Code examples +[source,cpp] +---- +options.transactionTimeoutMillis(); +---- + [#_Options__TypeDBOptionstransactionTimeoutMillis___int64_t_timeoutMillis_] ==== transactionTimeoutMillis @@ -457,5 +597,12 @@ a| `transactionTimeoutMillis` a| Timeout for killing transactions automatically .Returns `Options&` +[caption=""] +.Code examples +[source,cpp] +---- +options.transactionTimeoutMillis(transactionTimeoutMillis); +---- + // end::methods[] diff --git a/cpp/docs/session/Session.adoc b/cpp/docs/session/Session.adoc index 213973451f..4ac3f2908c 100644 --- a/cpp/docs/session/Session.adoc +++ b/cpp/docs/session/Session.adoc @@ -25,6 +25,13 @@ Closes the session. Before opening a new session, the session currently open sho .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +session.close(); +---- + [#_stdstring_TypeDBSessiondatabaseName_____const] ==== databaseName @@ -42,6 +49,13 @@ Returns the name of the database of the session. .Returns `std::string` +[caption=""] +.Code examples +[source,cpp] +---- +session.databaseName(); +---- + [#_bool_TypeDBSessionisOpen_____const] ==== isOpen @@ -59,6 +73,13 @@ Checks whether this session is open. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +session.isOpen(); +---- + [#_void_TypeDBSessiononClose___stdfunction__void____callback_] ==== onClose @@ -85,6 +106,13 @@ a| `function` a| The callback function. a| .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +session.onClose(function) +---- + [#_void_TypeDBSessiononReopen___stdfunction__void____callback_] ==== onReopen @@ -111,6 +139,13 @@ a| `function` a| The callback function. a| .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +session.onReopen(function) +---- + [#_Transaction_TypeDBSessiontransaction___TransactionType_type__const_Options__options__Options_____const] ==== transaction @@ -138,6 +173,13 @@ a| `options` a| Options for the session a| .Returns `Transaction` +[caption=""] +.Code examples +[source,cpp] +---- +session.transaction(transactionType, options); +---- + [#_SessionType_TypeDBSessiontype_____const] ==== type diff --git a/cpp/docs/transaction/QueryManager.adoc b/cpp/docs/transaction/QueryManager.adoc index f31467bd64..084e176643 100644 --- a/cpp/docs/transaction/QueryManager.adoc +++ b/cpp/docs/transaction/QueryManager.adoc @@ -35,6 +35,13 @@ a| `options` a| Specify query options a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.define(query, options).get() +---- + [#_ExplanationIterable_TypeDBQueryManagerexplain___const_Explainable__explainable__const_Options___Options_____const] ==== explain @@ -62,6 +69,13 @@ a| `options` a| Specify query options a| .Returns `ExplanationIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.explain(explainable, options) +---- + [#_JSONIterable_TypeDBQueryManagerfetch___const_stdstring__query__const_Options__options__Options_____const] ==== fetch @@ -89,6 +103,13 @@ a| `options` a| Specify query options a| .Returns `JSONIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.fetch(query, options) +---- + [#_ConceptMapIterable_TypeDBQueryManagerget___const_stdstring__query__const_Options__options__Options_____const] ==== get @@ -116,6 +137,13 @@ a| `options` a| Specify query options a| .Returns `ConceptMapIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.get(query, options) +---- + [#_AggregateFuture_TypeDBQueryManagergetAggregate___const_stdstring__query__const_Options___Options_____const] ==== getAggregate @@ -143,6 +171,13 @@ a| `options` a| Specify query options a| .Returns `AggregateFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.getAggregate(query, options).get() +---- + [#_ConceptMapGroupIterable_TypeDBQueryManagergetGroup___const_stdstring__query__const_Options___Options_____const] ==== getGroup @@ -170,6 +205,13 @@ a| `options` a| Specify query options a| .Returns `ConceptMapGroupIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.getGroup(query, options) +---- + [#_ValueGroupIterable_TypeDBQueryManagergetGroupAggregate___const_stdstring__query__const_Options___Options_____const] ==== getGroupAggregate @@ -197,6 +239,13 @@ a| `options` a| Specify query options a| .Returns `ValueGroupIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.getGroupAggregate(query, options) +---- + [#_ConceptMapIterable_TypeDBQueryManagerinsert___const_stdstring__query__const_Options__options__Options_____const] ==== insert @@ -224,6 +273,13 @@ a| `options` a| Specify query options a| .Returns `ConceptMapIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.insert(query, options) +---- + [#_VoidFuture_TypeDBQueryManagermatchDelete___const_stdstring__query__const_Options__options__Options_____const] ==== matchDelete @@ -251,6 +307,13 @@ a| `options` a| Specify query options a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.matchDelete(query, options).get() +---- + [#_VoidFuture_TypeDBQueryManagerundefine___const_stdstring__query__const_Options__options__Options_____const] ==== undefine @@ -278,6 +341,13 @@ a| `options` a| Specify query options a| .Returns `VoidFuture` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.undefine(query, options).get() +---- + [#_ConceptMapIterable_TypeDBQueryManagerupdate___const_stdstring__query__const_Options___Options_____const] ==== update @@ -305,5 +375,12 @@ a| `options` a| Specify query options a| .Returns `ConceptMapIterable` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.query.update(query, options) +---- + // end::methods[] diff --git a/cpp/docs/transaction/Transaction.adoc b/cpp/docs/transaction/Transaction.adoc index 89adedb651..312e99b298 100644 --- a/cpp/docs/transaction/Transaction.adoc +++ b/cpp/docs/transaction/Transaction.adoc @@ -38,6 +38,13 @@ Closes the transaction. .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.close() +---- + [#_void_TypeDBTransactioncommit___] ==== commit @@ -55,6 +62,13 @@ Commits the changes made via this transaction to the TypeDB database. Whether or .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.commit() +---- + [#_void_TypeDBTransactionforceClose___] ==== forceClose @@ -72,6 +86,13 @@ Closes the transaction. .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.close() +---- + [#_bool_TypeDBTransactionisOpen_____const] ==== isOpen @@ -89,6 +110,13 @@ Checks whether this transaction is open. .Returns `bool` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.isOpen(); +---- + [#_void_TypeDBTransactiononClose___stdfunction__void_const_stdoptional__DriverException______callback_] ==== onClose @@ -115,6 +143,13 @@ a| `function` a| The callback function. a| .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.onClose(function); +---- + [#_void_TypeDBTransactionrollback___] ==== rollback @@ -132,6 +167,13 @@ Rolls back the uncommitted changes made via this transaction. .Returns `void` +[caption=""] +.Code examples +[source,cpp] +---- +transaction.rollback() +---- + [#_TypeDBTransactionType_TypeDBTransactiontype_____const] ==== type diff --git a/csharp/docs/connection/IUser.adoc b/csharp/docs/connection/IUser.adoc index fa5945dfb5..2609529d8d 100644 --- a/csharp/docs/connection/IUser.adoc +++ b/csharp/docs/connection/IUser.adoc @@ -36,24 +36,6 @@ void UpdatePassword(string passwordOld, string passwordNew) Updates the password for this user. - - Parameters - - - - - - passwordOld - The current password of this user - - - passwordNew - The new password - - - - - [caption=""] .Input parameters diff --git a/csharp/docs/connection/TypeDBCredential.adoc b/csharp/docs/connection/TypeDBCredential.adoc index 9f3f88d1ef..2e7bb32101 100644 --- a/csharp/docs/connection/TypeDBCredential.adoc +++ b/csharp/docs/connection/TypeDBCredential.adoc @@ -29,28 +29,6 @@ TypeDBCredential(string username, string password, bool tlsEnabled) ---- - - Parameters - - - - - - username - The name of the user to connect as - - - password - The password for the user - - - tlsEnabled - Specify whether the connection to TypeDB Cloud must be done over TLS - - - - - [caption=""] .Input parameters @@ -76,28 +54,6 @@ TypeDBCredential(string username, string password, string? tlsRootCAPath) ---- - - Parameters - - - - - - username - The name of the user to connect as - - - password - The password for the user - - - tlsRootCAPath - Path to the CA certificate to use for authenticating server certificates - - - - - [caption=""] .Input parameters diff --git a/tool/docs/cpp/DoxygenParserCpp.kt b/tool/docs/cpp/DoxygenParserCpp.kt index b4051e34ee..3c3597762d 100644 --- a/tool/docs/cpp/DoxygenParserCpp.kt +++ b/tool/docs/cpp/DoxygenParserCpp.kt @@ -257,7 +257,7 @@ class DoxygenParserCpp : Callable { val methodDescr: List = element.selectFirst("div.memdoc") ?.let { splitToParagraphs(it.html()) } ?.map { replaceSpaces(reformatTextWithCode(it.substringBefore(""), idToAnchor)) } ?: listOf() - val methodExamples = element.select("td.memdoc > pre + div pre").map { replaceSpaces(it.text()) } + val methodExamples = element.select("div.memdoc > pre").map { replaceSpaces(it.text()) } val methodArgs = element.select("table.params > tbody > tr") .map { diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index d8e9a4acec..64eda4ff17 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -249,7 +249,7 @@ class DoxygenParserCsharp : Callable { val methodReturnType = getReturnTypeFromSignature(methodSignature) val methodDescr: List = element.selectFirst("div.memdoc") ?.let { splitToParagraphs(it.html()) } - ?.map { replaceSpaces(reformatTextWithCode(it.substringBefore(""), idToAnchor)) } ?: listOf() val methodExamples = element.select("div.memdoc > pre").map { replaceSpaces(it.text()) } val methodArgs = element.select("table.params > tbody > tr") From 632b3a76f23877b6aef1d6774cfe25cb6f9ac8c5 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 2 Apr 2024 12:22:03 +0100 Subject: [PATCH 065/118] Fix checkstyle. Change packages content --- csharp/BUILD | 49 +++++---------- csharp/Test/Deployment/BUILD | 25 ++++++++ .../Test/Deployment/NugetApplicationTest.cs | 19 ++++++ .../Deployment/NugetApplicationTest.csproj | 27 +++++++-- ....template => TypeDB.Driver.Runtime.nuspec} | 25 +++++++- ...e.nuspec.template => TypeDB.Driver.nuspec} | 19 ++++++ csharp/TypeDB.Driver.nuspec.template | 60 ------------------- 7 files changed, 123 insertions(+), 101 deletions(-) create mode 100644 csharp/Test/Deployment/BUILD rename csharp/{TypeDB.Driver.Pinvoke.nuspec.template => TypeDB.Driver.Runtime.nuspec} (54%) rename csharp/{TypeDB.Driver.NoRuntime.nuspec.template => TypeDB.Driver.nuspec} (83%) delete mode 100644 csharp/TypeDB.Driver.nuspec.template diff --git a/csharp/BUILD b/csharp/BUILD index d9da25a680..332ee3b546 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -58,50 +58,41 @@ csharp_library( nuget_pack( - name = "driver-csharp-pinvoke-pack-mac", + name = "driver-csharp-runtime-pack-mac", files = { "libtypedb_driver.dylib": "libtypedb_driver.dylib", }, - id = "TypeDB.Driver.Pinvoke", libs = { ":typedb_driver_pinvoke": "TypeDB.Driver.Pinvoke", }, + id = "TypeDB.Driver.Runtime", mac_native_lib = "libtypedb_driver.dylib", target_framework = target_framework, - nuspec_template = "TypeDB.Driver.Pinvoke.nuspec.template", + nuspec_template = "TypeDB.Driver.Runtime.nuspec", version = "0.0.1", visibility = ["//visibility:public"], ) nuget_pack( - name = "driver-csharp-pack-mac", + name = "driver-csharp-runtime-pack-linux", files = { "libtypedb_driver.dylib": "libtypedb_driver.dylib", }, - id = "TypeDB.Driver", libs = { - ":driver-csharp": "TypeDB.Driver", ":typedb_driver_pinvoke": "TypeDB.Driver.Pinvoke", - "//csharp/Api:api": "TypeDB.Driver.Api", - "//csharp/Common:common": "TypeDB.Driver.Common", - "//csharp/Connection:connection": "TypeDB.Driver.Connection", - "//csharp/Concept:concept": "TypeDB.Driver.Concept", - "//csharp/Logic:logic": "TypeDB.Driver.Logic", - "//csharp/Query:query": "TypeDB.Driver.Query", - "//csharp/User:user": "TypeDB.Driver.User", }, - mac_native_lib = "libtypedb_driver.dylib", + id = "TypeDB.Driver.Runtime", + linux_native_lib = "libtypedb_driver.dylib", target_framework = target_framework, - nuspec_template = "TypeDB.Driver.nuspec.template", + nuspec_template = "TypeDB.Driver.Runtime.nuspec", version = "0.0.1", visibility = ["//visibility:public"], ) - nuget_pack( - name = "driver-csharp-pack-noruntime", - id = "TypeDB.Driver.NoRuntime", + name = "driver-csharp-pack", + id = "TypeDB.Driver", libs = { ":driver-csharp": "TypeDB.Driver", "//csharp/Api:api": "TypeDB.Driver.Api", @@ -113,7 +104,7 @@ nuget_pack( "//csharp/User:user": "TypeDB.Driver.User", }, target_framework = target_framework, - nuspec_template = "TypeDB.Driver.NoRuntime.nuspec.template", + nuspec_template = "TypeDB.Driver.nuspec", version = "0.0.1", visibility = ["//visibility:public"], ) @@ -138,7 +129,7 @@ nuget_pack( }, linux_native_lib = "libtypedb_driver.so", target_framework = target_framework, - nuspec_template = "TypeDB.Driver.nuspec.template", + nuspec_template = "TypeDB.Driver.nuspec", version = "0.0.1", visibility = ["//visibility:public"], ) @@ -163,31 +154,23 @@ nuget_pack( }, win_native_lib = "typedb_driver.dll", target_framework = target_framework, - nuspec_template = "TypeDB.Driver.nuspec.template", + nuspec_template = "TypeDB.Driver.nuspec", version = "0.0.1", visibility = ["//visibility:public"], ) nuget_push( - name = "driver-csharp-pinvoke-push-mac", - src = ":driver-csharp-pinvoke-pack-mac", - snapshot_url = deployment['nuget']['snapshot'], - release_url = deployment['nuget']['release'], -) - - -nuget_push( - name = "driver-csharp-push-mac", - src = ":driver-csharp-pack-mac", + name = "driver-csharp-runtime-push-mac", + src = ":driver-csharp-runtime-pack-mac", snapshot_url = deployment['nuget']['snapshot'], release_url = deployment['nuget']['release'], ) nuget_push( - name = "driver-csharp-push-noruntime", - src = ":driver-csharp-pack-noruntime", + name = "driver-csharp-push", + src = ":driver-csharp-pack", snapshot_url = deployment['nuget']['snapshot'], release_url = deployment['nuget']['release'], ) diff --git a/csharp/Test/Deployment/BUILD b/csharp/Test/Deployment/BUILD new file mode 100644 index 0000000000..1167e95f85 --- /dev/null +++ b/csharp/Test/Deployment/BUILD @@ -0,0 +1,25 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") + + +checkstyle_test( + name = "checkstyle", + include = glob(["*"]), + license_type = "apache-header", +) diff --git a/csharp/Test/Deployment/NugetApplicationTest.cs b/csharp/Test/Deployment/NugetApplicationTest.cs index fdd111761e..0596f31620 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.cs +++ b/csharp/Test/Deployment/NugetApplicationTest.cs @@ -1,3 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + using System; using System.Collections.Generic; using System.Linq; diff --git a/csharp/Test/Deployment/NugetApplicationTest.csproj b/csharp/Test/Deployment/NugetApplicationTest.csproj index 1df7491f65..514acf2bae 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.csproj +++ b/csharp/Test/Deployment/NugetApplicationTest.csproj @@ -1,5 +1,23 @@ - + + Exe net6.0 @@ -27,11 +45,10 @@ - - - + + + - diff --git a/csharp/TypeDB.Driver.Pinvoke.nuspec.template b/csharp/TypeDB.Driver.Runtime.nuspec similarity index 54% rename from csharp/TypeDB.Driver.Pinvoke.nuspec.template rename to csharp/TypeDB.Driver.Runtime.nuspec index 8bbea7f955..bc2c87336a 100644 --- a/csharp/TypeDB.Driver.Pinvoke.nuspec.template +++ b/csharp/TypeDB.Driver.Runtime.nuspec @@ -1,3 +1,22 @@ + + @@ -22,9 +41,9 @@ - - - + + + $native_lib_files$ diff --git a/csharp/TypeDB.Driver.NoRuntime.nuspec.template b/csharp/TypeDB.Driver.nuspec similarity index 83% rename from csharp/TypeDB.Driver.NoRuntime.nuspec.template rename to csharp/TypeDB.Driver.nuspec index 803335e852..df4b2bcc16 100644 --- a/csharp/TypeDB.Driver.NoRuntime.nuspec.template +++ b/csharp/TypeDB.Driver.nuspec @@ -1,3 +1,22 @@ + + diff --git a/csharp/TypeDB.Driver.nuspec.template b/csharp/TypeDB.Driver.nuspec.template deleted file mode 100644 index b515d06232..0000000000 --- a/csharp/TypeDB.Driver.nuspec.template +++ /dev/null @@ -1,60 +0,0 @@ - - - - $packageid$ - $version$ - TypeDB - Copyright © 2024 Vaticle - TypeDB - TypeDB Driver - false - The TypeDB driver was developed by Vaticle to enable TypeDB support for C# software and developers. - - TypeDB is a polymorphic database with a conceptual data model, a strong subtyping system, a symbolic reasoning engine, and a beautiful and elegant type-theoretic language: TypeQL. - - https://typedb.com - - Apache-2.0 - https://typedb.com/assets/logo/typedb.svg - Database TypeDB TypeQL - - See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver. TODO: Changelog? - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -$native_lib_files$ - - - From 39739eee88dd7396bacede4ce2547175a1a48d78 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 2 Apr 2024 12:51:58 +0100 Subject: [PATCH 066/118] Fix build, prepare csproj for test --- csharp/BUILD | 64 +++++++------------ .../Deployment/NugetApplicationTest.csproj | 9 ++- csharp/TypeDB.Driver.Runtime.nuspec | 2 +- csharp/TypeDB.Driver.nuspec | 2 +- 4 files changed, 33 insertions(+), 44 deletions(-) diff --git a/csharp/BUILD b/csharp/BUILD index 332ee3b546..77fd2ceed7 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -77,73 +77,42 @@ nuget_pack( nuget_pack( name = "driver-csharp-runtime-pack-linux", files = { - "libtypedb_driver.dylib": "libtypedb_driver.dylib", + "libtypedb_driver.so": "libtypedb_driver.so", }, libs = { ":typedb_driver_pinvoke": "TypeDB.Driver.Pinvoke", }, id = "TypeDB.Driver.Runtime", - linux_native_lib = "libtypedb_driver.dylib", + linux_native_lib = "libtypedb_driver.so", target_framework = target_framework, nuspec_template = "TypeDB.Driver.Runtime.nuspec", version = "0.0.1", visibility = ["//visibility:public"], ) -nuget_pack( - name = "driver-csharp-pack", - id = "TypeDB.Driver", - libs = { - ":driver-csharp": "TypeDB.Driver", - "//csharp/Api:api": "TypeDB.Driver.Api", - "//csharp/Common:common": "TypeDB.Driver.Common", - "//csharp/Connection:connection": "TypeDB.Driver.Connection", - "//csharp/Concept:concept": "TypeDB.Driver.Concept", - "//csharp/Logic:logic": "TypeDB.Driver.Logic", - "//csharp/Query:query": "TypeDB.Driver.Query", - "//csharp/User:user": "TypeDB.Driver.User", - }, - target_framework = target_framework, - nuspec_template = "TypeDB.Driver.nuspec", - version = "0.0.1", - visibility = ["//visibility:public"], -) - nuget_pack( - name = "driver-csharp-pack-linux", + name = "driver-csharp-runtime-pack-win", files = { - "libtypedb_driver.so": "libtypedb_driver.so", + "typedb_driver.dll": "typedb_driver.dll", }, - id = "TypeDB.Driver", libs = { - ":driver-csharp": "TypeDB.Driver", ":typedb_driver_pinvoke": "TypeDB.Driver.Pinvoke", - "//csharp/Api:api": "TypeDB.Driver.Api", - "//csharp/Common:common": "TypeDB.Driver.Common", - "//csharp/Connection:connection": "TypeDB.Driver.Connection", - "//csharp/Concept:concept": "TypeDB.Driver.Concept", - "//csharp/Logic:logic": "TypeDB.Driver.Logic", - "//csharp/Query:query": "TypeDB.Driver.Query", - "//csharp/User:user": "TypeDB.Driver.User", }, - linux_native_lib = "libtypedb_driver.so", + id = "TypeDB.Driver.Runtime", + win_native_lib = "typedb_driver.dll", target_framework = target_framework, - nuspec_template = "TypeDB.Driver.nuspec", + nuspec_template = "TypeDB.Driver.Runtime.nuspec", version = "0.0.1", visibility = ["//visibility:public"], ) nuget_pack( - name = "driver-csharp-pack-win", - files = { - "typedb_driver.dll": "typedb_driver.dll", - }, + name = "driver-csharp-pack", id = "TypeDB.Driver", libs = { ":driver-csharp": "TypeDB.Driver", - ":typedb_driver_pinvoke": "TypeDB.Driver.Pinvoke", "//csharp/Api:api": "TypeDB.Driver.Api", "//csharp/Common:common": "TypeDB.Driver.Common", "//csharp/Connection:connection": "TypeDB.Driver.Connection", @@ -152,7 +121,6 @@ nuget_pack( "//csharp/Query:query": "TypeDB.Driver.Query", "//csharp/User:user": "TypeDB.Driver.User", }, - win_native_lib = "typedb_driver.dll", target_framework = target_framework, nuspec_template = "TypeDB.Driver.nuspec", version = "0.0.1", @@ -168,6 +136,22 @@ nuget_push( ) +nuget_push( + name = "driver-csharp-runtime-push-linux", + src = ":driver-csharp-runtime-pack-linux", + snapshot_url = deployment['nuget']['snapshot'], + release_url = deployment['nuget']['release'], +) + + +nuget_push( + name = "driver-csharp-runtime-push-win", + src = ":driver-csharp-runtime-pack-win", + snapshot_url = deployment['nuget']['snapshot'], + release_url = deployment['nuget']['release'], +) + + nuget_push( name = "driver-csharp-push", src = ":driver-csharp-pack", diff --git a/csharp/Test/Deployment/NugetApplicationTest.csproj b/csharp/Test/Deployment/NugetApplicationTest.csproj index 514acf2bae..a52b23db6d 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.csproj +++ b/csharp/Test/Deployment/NugetApplicationTest.csproj @@ -45,9 +45,14 @@ under the License. - + - + + + + + + diff --git a/csharp/TypeDB.Driver.Runtime.nuspec b/csharp/TypeDB.Driver.Runtime.nuspec index bc2c87336a..0f3dd4bebf 100644 --- a/csharp/TypeDB.Driver.Runtime.nuspec +++ b/csharp/TypeDB.Driver.Runtime.nuspec @@ -1,3 +1,4 @@ + - $packageid$ diff --git a/csharp/TypeDB.Driver.nuspec b/csharp/TypeDB.Driver.nuspec index df4b2bcc16..2e741b16ea 100644 --- a/csharp/TypeDB.Driver.nuspec +++ b/csharp/TypeDB.Driver.nuspec @@ -1,3 +1,4 @@ + - $packageid$ From 0c3d270c948fba288f794e3f5162ab4d0dcad182 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 2 Apr 2024 16:27:19 +0100 Subject: [PATCH 067/118] Refactor rules to produce platform-specific native packages and push them. Prepare many things around it --- .circleci/config.yml | 61 +++++++------ .circleci/windows/csharp/deploy_release.bat | 10 +-- .circleci/windows/csharp/deploy_snapshot.bat | 10 +-- .../windows/csharp/test_deploy_snapshot.bat | 13 ++- csharp/BUILD | 85 +++++-------------- .../Deployment/NugetApplicationTest.csproj | 12 +-- ...me.nuspec => TypeDB.Driver.Pinvoke.nuspec} | 8 +- csharp/TypeDB.Driver.nuspec | 2 +- csharp/docs_structure.bzl | 4 - csharp/rules.bzl | 30 ++++++- tool/docs/csharp/DoxygenParserCsharp.kt | 2 - tool/docs/csharp/rules.bzl | 4 - 12 files changed, 104 insertions(+), 137 deletions(-) rename csharp/{TypeDB.Driver.Runtime.nuspec => TypeDB.Driver.Pinvoke.nuspec} (86%) diff --git a/.circleci/config.yml b/.circleci/config.yml index 8e541d241e..1739ea75b3 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -364,16 +364,19 @@ commands: install-dotnet-linux: steps: - - run: yum install -y dotnet-sdk-6.0 + - run: yum install -y dotnet-runtime-6.0 + + deploy-nuget-runtime-snapshot-unix: + steps: + - run: | + export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD + bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- snapshot deploy-nuget-snapshot-unix: steps: - run: | - export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_USERNAME -# export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_USERNAME -# export DEPLOY_NUGET_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push-mac -- snapshot -# bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push-linux -- snapshot + export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD + bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push -- snapshot test-nuget-snapshot-unix: steps: @@ -393,15 +396,19 @@ commands: (cd csharp/Test/Deployment && /usr/local/bin/dotnet run NugetApplicationTest.csproj) tool/test/stop-core-server.sh + deploy-nuget-runtime-release-unix: + steps: + - run: | + export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! + + bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- release + deploy-nuget-release-unix: steps: - run: | - export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_USERNAME -# export DEPLOY_NUGET_USERNAME=$REPO_TYPEDB_USERNAME -# export DEPLOY_NUGET_PASSWORD=$REPO_TYPEDB_PASSWORD + export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push-mac -- release -# bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push-linux -- release + bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push -- release ######################### # Rust deployment steps # @@ -484,7 +491,7 @@ jobs: - test-cpp-assembly-linux: target-arch: arm64 - - deploy-nuget-snapshot-unix + - deploy-nuget-runtime-snapshot-unix deploy-snapshot-linux-x86_64: executor: linux-x86_64-amazonlinux-2 @@ -505,7 +512,7 @@ jobs: - test-cpp-assembly-linux: target-arch: x86_64 - - deploy-nuget-snapshot-unix + - deploy-nuget-runtime-snapshot-unix deploy-snapshot-mac-arm64: executor: mac-arm64 @@ -528,7 +535,7 @@ jobs: - test-cpp-assembly-mac: target-arch: arm64 - - deploy-nuget-snapshot-unix + - deploy-nuget-runtime-snapshot-unix deploy-snapshot-mac-x86_64: executor: mac-arm64 @@ -552,7 +559,7 @@ jobs: - test-cpp-assembly-mac: target-arch: x86_64 - - deploy-nuget-snapshot-unix + - deploy-nuget-runtime-snapshot-unix deploy-snapshot-windows-x86_64: executor: @@ -586,7 +593,7 @@ jobs: - deploy-maven-snapshot-unix - install-npm-apt - deploy-npm-snapshot-unix - - deploy-nuget-snapshot-unix # TODO: Need here? + - deploy-nuget-snapshot-unix test-snapshot-linux-arm64: executor: linux-arm64-amazonlinux-2 @@ -673,7 +680,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-nuget-release-unix + - deploy-nuget-runtime-release-unix deploy-release-linux-x86_64: executor: linux-x86_64-amazonlinux-2 @@ -685,7 +692,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-nuget-release-unix + - deploy-nuget-runtime-release-unix deploy-release-mac-arm64: executor: mac-arm64 @@ -697,7 +704,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-nuget-release-unix + - deploy-nuget-runtime-release-unix deploy-release-mac-x86_64: executor: mac-arm64 @@ -710,7 +717,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-nuget-release-unix + - deploy-nuget-runtime-release-unix deploy-release-windows-x86_64: executor: @@ -737,7 +744,7 @@ jobs: - deploy-maven-release-unix - install-npm-apt - deploy-npm-release-unix - - deploy-nuget-release-unix # TODO: Need here? + - deploy-nuget-release-unix deploy-github: executor: linux-x86_64-ubuntu-2204 @@ -784,28 +791,28 @@ workflows: - deploy-snapshot-linux-arm64: filters: branches: - only: [development, master] # TODO: Remove csharp-docs-deployment + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - deploy-snapshot-linux-x86_64: filters: branches: - only: [development, master] # TODO: Remove csharp-docs-deployment + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - deploy-snapshot-mac-arm64: filters: branches: - only: [development, master] # TODO: Remove csharp-docs-deployment + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - deploy-snapshot-mac-x86_64: filters: branches: - only: [development, master] # TODO: Remove csharp-docs-deployment + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - deploy-snapshot-windows-x86_64: filters: branches: - only: [development, master] # TODO: Remove csharp-docs-deployment + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - deploy-snapshot-any: filters: branches: - only: [development, master] # TODO: Remove csharp-docs-deployment + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: - deploy-snapshot-linux-arm64 - deploy-snapshot-linux-x86_64 diff --git a/.circleci/windows/csharp/deploy_release.bat b/.circleci/windows/csharp/deploy_release.bat index 5fa39f8d8d..e85dee98b5 100644 --- a/.circleci/windows/csharp/deploy_release.bat +++ b/.circleci/windows/csharp/deploy_release.bat @@ -1,6 +1,4 @@ @echo off -REM Copyright (C) 2022 Vaticle -REM REM Licensed to the Apache Software Foundation (ASF) under one REM or more contributor license agreements. See the NOTICE file REM distributed with this work for additional information @@ -17,17 +15,15 @@ REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY REM KIND, either express or implied. See the License for the REM specific language governing permissions and limitations REM under the License. -REM REM needs to be called such that software installed REM by Chocolatey in prepare.bat is accessible CALL refreshenv ECHO Building and deploying windows package... -SET DEPLOY_NUGET_API_KEY=%REPO_TYPEDB_USERNAME% -@REM SET DEPLOY_NUGET_USERNAME=%REPO_TYPEDB_USERNAME% -@REM SET DEPLOY_NUGET_PASSWORD=%REPO_TYPEDB_PASSWORD% +SET DEPLOY_NUGET_API_KEY=%REPO_TYPEDB_PASSWORD% +@REM TODO: Add new key for nuget as a new variable! SET /p VER= version_snapshot.txt set /p VER= - - - - - - + + + + + + diff --git a/csharp/TypeDB.Driver.Runtime.nuspec b/csharp/TypeDB.Driver.Pinvoke.nuspec similarity index 86% rename from csharp/TypeDB.Driver.Runtime.nuspec rename to csharp/TypeDB.Driver.Pinvoke.nuspec index 0f3dd4bebf..8069c980d5 100644 --- a/csharp/TypeDB.Driver.Runtime.nuspec +++ b/csharp/TypeDB.Driver.Pinvoke.nuspec @@ -41,10 +41,10 @@ under the License. - - - -$native_lib_files$ + + + +$native_lib_declrs$ diff --git a/csharp/TypeDB.Driver.nuspec b/csharp/TypeDB.Driver.nuspec index 2e741b16ea..4e9ae09bf2 100644 --- a/csharp/TypeDB.Driver.nuspec +++ b/csharp/TypeDB.Driver.nuspec @@ -70,7 +70,7 @@ under the License. -$native_lib_files$ +$native_lib_declrs$ diff --git a/csharp/docs_structure.bzl b/csharp/docs_structure.bzl index 8cec7f38be..cd047e06ea 100644 --- a/csharp/docs_structure.bzl +++ b/csharp/docs_structure.bzl @@ -1,6 +1,3 @@ -# -# Copyright (C) 2022 Vaticle -# # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information @@ -17,7 +14,6 @@ # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. -# dir_mapping = { "ITypeDBTransaction.adoc": "transaction", diff --git a/csharp/rules.bzl b/csharp/rules.bzl index 98cfc96a4c..fbf6c2501e 100644 --- a/csharp/rules.bzl +++ b/csharp/rules.bzl @@ -16,11 +16,13 @@ # under the License. load("@vaticle_dependencies//builder/swig:csharp.bzl", "swig_csharp") +load("@vaticle_bazel_distribution//nuget:rules.bzl", "nuget_pack") -def swig_native_csharp_library(name, namespace, nullable_context, target_frameworks, targeting_packs, visibility, tags=[], **kwargs): +def swig_native_csharp_library(name, native_lib_name, namespace, nullable_context, target_frameworks, targeting_packs, visibility, tags=[], **kwargs): swig_csharp( name = "__" + name, + native_lib_name = native_lib_name, namespace = namespace, nullable_context = nullable_context, target_frameworks = target_frameworks, @@ -29,9 +31,33 @@ def swig_native_csharp_library(name, namespace, nullable_context, target_framewo **kwargs, ) - native.alias( name = name, actual = "__" + name, visibility = visibility, ) + + +def swig_native_nuget_pack(name, id, version, libs, native_libs, target_framework, nuspec_template, platforms, visibility, files={}, **kwargs): + # generate identical libraries with different maven coordinate tags, since we can't 'select' tags + for platform in platforms.values(): + nuget_pack( + name = "_{}_as_{}_do_not_reference".format(name, platform), + id = id, + version = version, + files = files, + libs = libs, + native_libs = native_libs, + target_framework = target_framework, + nuspec_template = nuspec_template, + platform = platform, + ) + + native.alias( + name = name, + actual = select({ + config: "_{}_as_{}_do_not_reference".format(name, platform) + for config, platform in platforms.items() + }), + visibility = visibility, + ) diff --git a/tool/docs/csharp/DoxygenParserCsharp.kt b/tool/docs/csharp/DoxygenParserCsharp.kt index 64eda4ff17..fbcc71924d 100644 --- a/tool/docs/csharp/DoxygenParserCsharp.kt +++ b/tool/docs/csharp/DoxygenParserCsharp.kt @@ -1,6 +1,4 @@ /* - * Copyright (C) 2022 Vaticle - * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information diff --git a/tool/docs/csharp/rules.bzl b/tool/docs/csharp/rules.bzl index 9d02f5d5da..42a309a2e9 100644 --- a/tool/docs/csharp/rules.bzl +++ b/tool/docs/csharp/rules.bzl @@ -1,6 +1,3 @@ -# -# Copyright (C) 2022 Vaticle -# # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information @@ -17,7 +14,6 @@ # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. -# load("@io_bazel_rules_kotlin//kotlin:jvm.bzl", "kt_jvm_binary") From 1aecd9ea71797518558a4d545b487c55bbfac570 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 2 Apr 2024 16:43:00 +0100 Subject: [PATCH 068/118] Fix build with platforms --- csharp/BUILD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/csharp/BUILD b/csharp/BUILD index ad5d62fea5..49eb718074 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -76,7 +76,7 @@ swig_native_nuget_pack( "@vaticle_bazel_distribution//platform:is_mac_x86_64": "osx-x64", "@vaticle_bazel_distribution//platform:is_linux_arm64": "linux-arm64", "@vaticle_bazel_distribution//platform:is_linux_x86_64": "linux-x64", - "@vaticle_bazel_distribution//platform:is_windows_x86_64": "windows-x64", + "@vaticle_bazel_distribution//platform:is_windows_x86_64": "win-x64", }, ) From 7b5634c90e232761254d38f456715bbdd4a8f796 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 2 Apr 2024 16:56:28 +0100 Subject: [PATCH 069/118] Remove excessive flag --- csharp/BUILD | 1 - 1 file changed, 1 deletion(-) diff --git a/csharp/BUILD b/csharp/BUILD index 49eb718074..b3a3d3cf6c 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -66,7 +66,6 @@ swig_native_nuget_pack( ":typedb_driver_pinvoke": "TypeDB.Driver.Pinvoke", }, native_libs = ["typedb_driver"], - platform = "osx-x64", target_framework = target_framework, nuspec_template = "TypeDB.Driver.Pinvoke.nuspec", version = "0.0.1", From 1153f6cd795d66c2fc9d55069ba876af982cee2a Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 2 Apr 2024 17:52:34 +0100 Subject: [PATCH 070/118] Remove direct version specification in the rules --- csharp/BUILD | 2 -- csharp/rules.bzl | 4 ++-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/csharp/BUILD b/csharp/BUILD index b3a3d3cf6c..b94df257a9 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -68,7 +68,6 @@ swig_native_nuget_pack( native_libs = ["typedb_driver"], target_framework = target_framework, nuspec_template = "TypeDB.Driver.Pinvoke.nuspec", - version = "0.0.1", visibility= ["//visibility:public"], platforms = { "@vaticle_bazel_distribution//platform:is_mac_arm64": "osx-arm64", @@ -103,7 +102,6 @@ nuget_pack( }, target_framework = target_framework, nuspec_template = "TypeDB.Driver.nuspec", - version = "0.0.1", visibility = ["//visibility:public"], ) diff --git a/csharp/rules.bzl b/csharp/rules.bzl index fbf6c2501e..dfedfd4c04 100644 --- a/csharp/rules.bzl +++ b/csharp/rules.bzl @@ -38,19 +38,19 @@ def swig_native_csharp_library(name, native_lib_name, namespace, nullable_contex ) -def swig_native_nuget_pack(name, id, version, libs, native_libs, target_framework, nuspec_template, platforms, visibility, files={}, **kwargs): +def swig_native_nuget_pack(name, id, libs, native_libs, target_framework, nuspec_template, platforms, visibility, files={}, **kwargs): # generate identical libraries with different maven coordinate tags, since we can't 'select' tags for platform in platforms.values(): nuget_pack( name = "_{}_as_{}_do_not_reference".format(name, platform), id = id, - version = version, files = files, libs = libs, native_libs = native_libs, target_framework = target_framework, nuspec_template = nuspec_template, platform = platform, + **kwargs, ) native.alias( From 46c1e9064f53f716a3b91a136351501e10209162 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Tue, 2 Apr 2024 18:00:11 +0100 Subject: [PATCH 071/118] Enable snapshot tests for my branch --- .circleci/config.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 1739ea75b3..9c85d224a9 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -823,35 +823,35 @@ workflows: - test-snapshot-linux-arm64: filters: branches: - only: [master] + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: - deploy-snapshot-linux-arm64 - deploy-snapshot-any - test-snapshot-linux-x86_64: filters: branches: - only: [master] + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: - deploy-snapshot-linux-x86_64 - deploy-snapshot-any - test-snapshot-mac-arm64: filters: branches: - only: [master] + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: - deploy-snapshot-mac-arm64 - deploy-snapshot-any - test-snapshot-mac-x86_64: filters: branches: - only: [master] + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: - deploy-snapshot-mac-x86_64 - deploy-snapshot-any - test-snapshot-windows-x86_64: filters: branches: - only: [master] + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: - deploy-snapshot-windows-x86_64 - deploy-snapshot-any @@ -859,7 +859,7 @@ workflows: - test-snapshot-any: filters: branches: - only: [master] + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: - deploy-snapshot-any From a0ed6ab279824792fc9975af94feb28888f573ac Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 09:08:48 +0100 Subject: [PATCH 072/118] Comment out excessive steps. Prepare test project for c# --- .circleci/config.yml | 159 +++++++++--------- .factory/automation.yml | 72 ++++---- .../Deployment/NugetApplicationTest.csproj | 15 +- 3 files changed, 124 insertions(+), 122 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 9c85d224a9..9928b56cac 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -364,17 +364,20 @@ commands: install-dotnet-linux: steps: - - run: yum install -y dotnet-runtime-6.0 + - run: | + yum install -y dotnet-runtime-6.0 deploy-nuget-runtime-snapshot-unix: steps: - run: | + export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- snapshot deploy-nuget-snapshot-unix: steps: - run: | + export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push -- snapshot @@ -399,15 +402,15 @@ commands: deploy-nuget-runtime-release-unix: steps: - run: | + export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- release deploy-nuget-release-unix: steps: - run: | + export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push -- release ######################### @@ -479,17 +482,17 @@ jobs: - install-bazel-yum: bazel-arch: arm64 - - deploy-pip-snapshot-unix - - - deploy-maven-jni-snapshot-unix - - - deploy-clib-snapshot-unix - - test-clib-assembly-linux: - target-arch: arm64 - - - deploy-cpp-snapshot-unix - - test-cpp-assembly-linux: - target-arch: arm64 +# - deploy-pip-snapshot-unix +# +# - deploy-maven-jni-snapshot-unix +# +# - deploy-clib-snapshot-unix +# - test-clib-assembly-linux: +# target-arch: arm64 +# +# - deploy-cpp-snapshot-unix +# - test-cpp-assembly-linux: +# target-arch: arm64 - deploy-nuget-runtime-snapshot-unix @@ -500,17 +503,17 @@ jobs: - install-bazel-yum: bazel-arch: amd64 - - deploy-pip-snapshot-unix - - - deploy-maven-jni-snapshot-unix - - - deploy-clib-snapshot-unix - - test-clib-assembly-linux: - target-arch: x86_64 - - - deploy-cpp-snapshot-unix - - test-cpp-assembly-linux: - target-arch: x86_64 +# - deploy-pip-snapshot-unix +# +# - deploy-maven-jni-snapshot-unix +# +# - deploy-clib-snapshot-unix +# - test-clib-assembly-linux: +# target-arch: x86_64 +# +# - deploy-cpp-snapshot-unix +# - test-cpp-assembly-linux: +# target-arch: x86_64 - deploy-nuget-runtime-snapshot-unix @@ -521,19 +524,19 @@ jobs: - install-bazel-brew: bazel-arch: arm64 - - deploy-pip-snapshot-unix - - - deploy-maven-jni-snapshot-unix - - - run: brew install cmake - - - deploy-clib-snapshot-unix - - test-clib-assembly-mac: - target-arch: arm64 - - - deploy-cpp-snapshot-unix - - test-cpp-assembly-mac: - target-arch: arm64 +# - deploy-pip-snapshot-unix +# +# - deploy-maven-jni-snapshot-unix +# +# - run: brew install cmake +# +# - deploy-clib-snapshot-unix +# - test-clib-assembly-mac: +# target-arch: arm64 +# +# - deploy-cpp-snapshot-unix +# - test-cpp-assembly-mac: +# target-arch: arm64 - deploy-nuget-runtime-snapshot-unix @@ -545,19 +548,19 @@ jobs: - install-bazel-brew: bazel-arch: amd64 - - deploy-pip-snapshot-unix - - - deploy-maven-jni-snapshot-unix - - - run: brew install cmake - - - deploy-clib-snapshot-unix - - test-clib-assembly-mac: - target-arch: x86_64 - - - deploy-cpp-snapshot-unix - - test-cpp-assembly-mac: - target-arch: x86_64 +# - deploy-pip-snapshot-unix +# +# - deploy-maven-jni-snapshot-unix +# +# - run: brew install cmake +# +# - deploy-clib-snapshot-unix +# - test-clib-assembly-mac: +# target-arch: x86_64 +# +# - deploy-cpp-snapshot-unix +# - test-cpp-assembly-mac: +# target-arch: x86_64 - deploy-nuget-runtime-snapshot-unix @@ -571,15 +574,15 @@ jobs: - checkout - run: .circleci\windows\prepare.bat - - run: .circleci\windows\python\deploy_snapshot.bat - - - run: .circleci\windows\java\deploy_snapshot.bat - - - run: .circleci\windows\clib\deploy_snapshot.bat - - run: .circleci\windows\clib\test_assembly.bat - - - run: .circleci\windows\cpp\deploy_snapshot.bat - - run: .circleci\windows\cpp\test_assembly.bat +# - run: .circleci\windows\python\deploy_snapshot.bat +# +# - run: .circleci\windows\java\deploy_snapshot.bat +# +# - run: .circleci\windows\clib\deploy_snapshot.bat +# - run: .circleci\windows\clib\test_assembly.bat +# +# - run: .circleci\windows\cpp\deploy_snapshot.bat +# - run: .circleci\windows\cpp\test_assembly.bat - run: .circleci\windows\csharp\deploy_snapshot.bat @@ -589,10 +592,10 @@ jobs: - checkout - install-bazel-apt: bazel-arch: amd64 - - deploy-crate-snapshot-unix - - deploy-maven-snapshot-unix - - install-npm-apt - - deploy-npm-snapshot-unix +# - deploy-crate-snapshot-unix +# - deploy-maven-snapshot-unix +# - install-npm-apt +# - deploy-npm-snapshot-unix - deploy-nuget-snapshot-unix test-snapshot-linux-arm64: @@ -601,9 +604,9 @@ jobs: - checkout - install-bazel-yum: bazel-arch: arm64 - - test-pip-snapshot-unix - - install-maven-linux - - test-maven-snapshot-unix +# - test-pip-snapshot-unix +# - install-maven-linux +# - test-maven-snapshot-unix - install-dotnet-linux - test-nuget-snapshot-unix @@ -613,9 +616,9 @@ jobs: - checkout - install-bazel-yum: bazel-arch: amd64 - - test-pip-snapshot-unix - - install-maven-linux - - test-maven-snapshot-unix +# - test-pip-snapshot-unix +# - install-maven-linux +# - test-maven-snapshot-unix - install-dotnet-linux - test-nuget-snapshot-unix @@ -625,9 +628,9 @@ jobs: - checkout - install-bazel-brew: bazel-arch: arm64 - - test-pip-snapshot-unix - - install-maven-mac - - test-maven-snapshot-unix +# - test-pip-snapshot-unix +# - install-maven-mac +# - test-maven-snapshot-unix - install-dotnet-mac - test-nuget-snapshot-unix @@ -638,9 +641,9 @@ jobs: - checkout - install-bazel-brew: bazel-arch: amd64 - - test-pip-snapshot-mac-rosetta - - install-maven-mac-rosetta - - test-maven-snapshot-mac-rosetta +# - test-pip-snapshot-mac-rosetta +# - install-maven-mac-rosetta +# - test-maven-snapshot-mac-rosetta - install-dotnet-mac-rosetta - test-nuget-snapshot-mac-rosetta @@ -653,8 +656,8 @@ jobs: steps: - checkout - run: .circleci\windows\prepare.bat - - run: .circleci\windows\python\test_deploy_snapshot.bat - - run: .circleci\windows\java\test_deploy_snapshot.bat +# - run: .circleci\windows\python\test_deploy_snapshot.bat +# - run: .circleci\windows\java\test_deploy_snapshot.bat - run: .circleci\windows\csharp\test_deploy_snapshot.bat test-snapshot-any: diff --git a/.factory/automation.yml b/.factory/automation.yml index 07cdaefc62..2d387aa9df 100644 --- a/.factory/automation.yml +++ b/.factory/automation.yml @@ -447,42 +447,42 @@ build: # export TEST_SUCCESS=0 || export TEST_SUCCESS=1 # tool/test/stop-cloud-servers.sh # exit $TEST_SUCCESS - - test-csharp-integration-core: - image: vaticle-ubuntu-22.04 - dependencies: - - build - type: foreground - command: | - sudo apt-get update - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - tool/test/start-core-server.sh && - bazel test //csharp/Test/Integration/Data/... --test_output=streamed --jobs=1 && - bazel test //csharp/Test/Integration/Marshal/... --test_output=streamed --jobs=1 && - .factory/test-core.sh //csharp/Test/Integration/Examples/... --test_output=streamed --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-core-server.sh - exit $TEST_SUCCESS - - test-csharp-integration-cloud: - image: vaticle-ubuntu-22.04 - dependencies: - - build - type: foreground - command: | - export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME - export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD - bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh - bazel run @vaticle_dependencies//distribution/artifact:create-netrc - source tool/test/start-cloud-servers.sh && - .factory/test-cloud.sh //csharp/Test/Integration/Examples/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && - export TEST_SUCCESS=0 || export TEST_SUCCESS=1 - tool/test/stop-cloud-servers.sh - exit $TEST_SUCCESS - +# +# test-csharp-integration-core: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# type: foreground +# command: | +# sudo apt-get update +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# tool/test/start-core-server.sh && +# bazel test //csharp/Test/Integration/Data/... --test_output=streamed --jobs=1 && +# bazel test //csharp/Test/Integration/Marshal/... --test_output=streamed --jobs=1 && +# .factory/test-core.sh //csharp/Test/Integration/Examples/... --test_output=streamed --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-core-server.sh +# exit $TEST_SUCCESS +# +# test-csharp-integration-cloud: +# image: vaticle-ubuntu-22.04 +# dependencies: +# - build +# type: foreground +# command: | +# export ARTIFACT_USERNAME=$REPO_TYPEDB_USERNAME +# export ARTIFACT_PASSWORD=$REPO_TYPEDB_PASSWORD +# bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh +# bazel run @vaticle_dependencies//distribution/artifact:create-netrc +# source tool/test/start-cloud-servers.sh && +# .factory/test-cloud.sh //csharp/Test/Integration/Examples/... --test_env=ROOT_CA=$ROOT_CA --test_output=streamed --jobs=1 && +# export TEST_SUCCESS=0 || export TEST_SUCCESS=1 +# tool/test/stop-cloud-servers.sh +# exit $TEST_SUCCESS +# # test-csharp-behaviour-core: # image: vaticle-ubuntu-22.04 # dependencies: diff --git a/csharp/Test/Deployment/NugetApplicationTest.csproj b/csharp/Test/Deployment/NugetApplicationTest.csproj index 2d56ffbbfc..cc10d2beb7 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.csproj +++ b/csharp/Test/Deployment/NugetApplicationTest.csproj @@ -44,14 +44,13 @@ under the License. - - - - - - - - + + + + + + + From a1b6aae6c7dc8b186cf565777677ff8f99c87c5d Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 09:42:59 +0100 Subject: [PATCH 073/118] Fix circleci --- .circleci/config.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 9928b56cac..a7f5f9f4ae 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -370,16 +370,16 @@ commands: deploy-nuget-runtime-snapshot-unix: steps: - run: | - export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 + sudo apt-get install libicu-dev export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- snapshot deploy-nuget-snapshot-unix: steps: - run: | - export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 + sudo apt-get install libicu-dev export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push -- snapshot test-nuget-snapshot-unix: steps: @@ -402,16 +402,16 @@ commands: deploy-nuget-runtime-release-unix: steps: - run: | - export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 + sudo apt-get install libicu-dev export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push -- release deploy-nuget-release-unix: steps: - run: | - export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 + sudo apt-get install libicu-dev export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(git rev-parse HEAD) //csharp:driver-csharp-push -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push -- release ######################### # Rust deployment steps # From bcbcc3bd8229bcaebb26fd8db83d819a64e07081 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 09:46:40 +0100 Subject: [PATCH 074/118] Fix circleci by removing sudo --- .circleci/config.yml | 8 ++++---- .circleci/windows/csharp/deploy_snapshot.bat | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index a7f5f9f4ae..812fc62dce 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -370,14 +370,14 @@ commands: deploy-nuget-runtime-snapshot-unix: steps: - run: | - sudo apt-get install libicu-dev + apt install libicu-dev export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- snapshot deploy-nuget-snapshot-unix: steps: - run: | - sudo apt-get install libicu-dev + apt install libicu-dev export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push -- snapshot @@ -402,14 +402,14 @@ commands: deploy-nuget-runtime-release-unix: steps: - run: | - sudo apt-get install libicu-dev + apt install libicu-dev export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push -- release deploy-nuget-release-unix: steps: - run: | - sudo apt-get install libicu-dev + apt install libicu-dev export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push -- release diff --git a/.circleci/windows/csharp/deploy_snapshot.bat b/.circleci/windows/csharp/deploy_snapshot.bat index a21972283b..b6e7a86d4c 100644 --- a/.circleci/windows/csharp/deploy_snapshot.bat +++ b/.circleci/windows/csharp/deploy_snapshot.bat @@ -24,5 +24,5 @@ SET DEPLOY_NUGET_API_KEY=%REPO_TYPEDB_PASSWORD% git rev-parse HEAD > version_snapshot.txt set /p VER= Date: Wed, 3 Apr 2024 09:51:49 +0100 Subject: [PATCH 075/118] Return globalization envvar export --- .circleci/config.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 812fc62dce..3e13090c84 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -370,16 +370,16 @@ commands: deploy-nuget-runtime-snapshot-unix: steps: - run: | - apt install libicu-dev + export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- snapshot + DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- snapshot deploy-nuget-snapshot-unix: steps: - run: | - apt install libicu-dev + export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push -- snapshot + DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push -- snapshot test-nuget-snapshot-unix: steps: @@ -402,16 +402,16 @@ commands: deploy-nuget-runtime-release-unix: steps: - run: | - apt install libicu-dev + export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push -- release + DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push -- release deploy-nuget-release-unix: steps: - run: | - apt install libicu-dev + export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push -- release + DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push -- release ######################### # Rust deployment steps # From 9a5ed6240e617e376213e5a15c716015c8fb4eee Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 10:22:13 +0100 Subject: [PATCH 076/118] Pass action env to bazel run --- .circleci/config.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 3e13090c84..d0b3484f09 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -372,14 +372,14 @@ commands: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=$DOTNET_SYSTEM_GLOBALIZATION_INVARIANT //csharp:driver-csharp-runtime-push -- snapshot deploy-nuget-snapshot-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=$DOTNET_SYSTEM_GLOBALIZATION_INVARIANT //csharp:driver-csharp-push -- snapshot test-nuget-snapshot-unix: steps: @@ -404,14 +404,14 @@ commands: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push -- release + bazel run --jobs=8 --define version=$(cat VERSION) --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=$DOTNET_SYSTEM_GLOBALIZATION_INVARIANT //csharp:driver-csharp-runtime-push -- release deploy-nuget-release-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push -- release + bazel run --jobs=8 --define version=$(cat VERSION) --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=$DOTNET_SYSTEM_GLOBALIZATION_INVARIANT //csharp:driver-csharp-push -- release ######################### # Rust deployment steps # From e876f477e11fd42d734aabdb49481ad72a256db1 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 10:32:48 +0100 Subject: [PATCH 077/118] Temporarily disable win and mac builds --- .circleci/config.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index d0b3484f09..fd205790f7 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -372,14 +372,14 @@ commands: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=$DOTNET_SYSTEM_GLOBALIZATION_INVARIANT //csharp:driver-csharp-runtime-push -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot deploy-nuget-snapshot-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=$DOTNET_SYSTEM_GLOBALIZATION_INVARIANT //csharp:driver-csharp-push -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot test-nuget-snapshot-unix: steps: @@ -404,14 +404,14 @@ commands: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=$DOTNET_SYSTEM_GLOBALIZATION_INVARIANT //csharp:driver-csharp-runtime-push -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release deploy-nuget-release-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=$DOTNET_SYSTEM_GLOBALIZATION_INVARIANT //csharp:driver-csharp-push -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release ######################### # Rust deployment steps # @@ -819,9 +819,9 @@ workflows: requires: - deploy-snapshot-linux-arm64 - deploy-snapshot-linux-x86_64 - - deploy-snapshot-mac-arm64 - - deploy-snapshot-mac-x86_64 - - deploy-snapshot-windows-x86_64 +# - deploy-snapshot-mac-arm64 +# - deploy-snapshot-mac-x86_64 +# - deploy-snapshot-windows-x86_64 - test-snapshot-linux-arm64: filters: From 2d07d5aec09c0a343cd7adb8f5525e053361f20c Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 10:34:49 +0100 Subject: [PATCH 078/118] Disable windows builds --- .circleci/config.yml | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index fd205790f7..980731db93 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -807,10 +807,10 @@ workflows: filters: branches: only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - - deploy-snapshot-windows-x86_64: - filters: - branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# - deploy-snapshot-windows-x86_64: +# filters: +# branches: +# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - deploy-snapshot-any: filters: @@ -819,8 +819,8 @@ workflows: requires: - deploy-snapshot-linux-arm64 - deploy-snapshot-linux-x86_64 -# - deploy-snapshot-mac-arm64 -# - deploy-snapshot-mac-x86_64 + - deploy-snapshot-mac-arm64 + - deploy-snapshot-mac-x86_64 # - deploy-snapshot-windows-x86_64 - test-snapshot-linux-arm64: @@ -851,13 +851,13 @@ workflows: requires: - deploy-snapshot-mac-x86_64 - deploy-snapshot-any - - test-snapshot-windows-x86_64: - filters: - branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: - - deploy-snapshot-windows-x86_64 - - deploy-snapshot-any +# - test-snapshot-windows-x86_64: +# filters: +# branches: +# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# requires: +# - deploy-snapshot-windows-x86_64 +# - deploy-snapshot-any - test-snapshot-any: filters: From 7fb7d28875c9c55e288776ae0b4fda41e2272650 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 10:55:35 +0100 Subject: [PATCH 079/118] Try to fix linux build by host_action_env --- .circleci/config.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 980731db93..45bfe503bb 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -372,14 +372,14 @@ commands: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot deploy-nuget-snapshot-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot test-nuget-snapshot-unix: steps: @@ -404,14 +404,14 @@ commands: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release deploy-nuget-release-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release ######################### # Rust deployment steps # From 173f75edc0ea282a15d05f45342d961193975b33 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 11:09:15 +0100 Subject: [PATCH 080/118] Connect host_action_env with action_env --- .circleci/config.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 45bfe503bb..eed543c1d6 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -372,14 +372,14 @@ commands: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot deploy-nuget-snapshot-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot test-nuget-snapshot-unix: steps: @@ -404,14 +404,14 @@ commands: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release deploy-nuget-release-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release ######################### # Rust deployment steps # From 8dad32e6a5cfcad4a61580449b918d40d2858ec1 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 11:33:45 +0100 Subject: [PATCH 081/118] Update readme. Disable linux temp --- .circleci/config.yml | 48 ++++++++++++++++++++++---------------------- csharp/README.md | 22 +++++++++++++++++--- 2 files changed, 43 insertions(+), 27 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index eed543c1d6..96fc0f5586 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -791,14 +791,14 @@ jobs: workflows: typedb-driver-snapshot: jobs: - - deploy-snapshot-linux-arm64: - filters: - branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - - deploy-snapshot-linux-x86_64: - filters: - branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# - deploy-snapshot-linux-arm64: +# filters: +# branches: +# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# - deploy-snapshot-linux-x86_64: +# filters: +# branches: +# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - deploy-snapshot-mac-arm64: filters: branches: @@ -817,26 +817,26 @@ workflows: branches: only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: - - deploy-snapshot-linux-arm64 - - deploy-snapshot-linux-x86_64 +# - deploy-snapshot-linux-arm64 +# - deploy-snapshot-linux-x86_64 - deploy-snapshot-mac-arm64 - deploy-snapshot-mac-x86_64 # - deploy-snapshot-windows-x86_64 - - test-snapshot-linux-arm64: - filters: - branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: - - deploy-snapshot-linux-arm64 - - deploy-snapshot-any - - test-snapshot-linux-x86_64: - filters: - branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: - - deploy-snapshot-linux-x86_64 - - deploy-snapshot-any +# - test-snapshot-linux-arm64: +# filters: +# branches: +# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# requires: +# - deploy-snapshot-linux-arm64 +# - deploy-snapshot-any +# - test-snapshot-linux-x86_64: +# filters: +# branches: +# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# requires: +# - deploy-snapshot-linux-x86_64 +# - deploy-snapshot-any - test-snapshot-mac-arm64: filters: branches: diff --git a/csharp/README.md b/csharp/README.md index 0c24494df6..fd5e4569e0 100644 --- a/csharp/README.md +++ b/csharp/README.md @@ -2,10 +2,25 @@ The C# driver is based on the cross-platform .NET 6 framework. ## Use TypeDB Driver for C# -The driver is distributed as a [Nuget](https://www.nuget.org/) package. Just choose the latest version +The driver is distributed as a series of [Nuget](https://www.nuget.org) packages. To use the driver, import the latest versions of [the driver](https://www.nuget.org/packages/TypeDB.Driver) and its [Pinvoke runtime](https://www.nuget.org/packages?q=TypeDB.Driver.Pinvoke) suitable for your platform. Here is an example from a `.csproj` for MacOS x86-64: +```xml + + +``` + +If you aim to build a platform-independent package, reference all the needed runtimes (it will affect the size of your application by downloading a respective set of platform-specific dynamic libraries): +```xml + + + + +... +``` + +See [Examples](#examples) and [API Reference](#api-reference) to set up your first application with the TypeDB driver. ## API Reference -To learn about the methods available for executing queries and retrieving their answers using Driver Java, refer to the [API Reference](https://typedb.com/docs/drivers/overview) in the next release. The general layout (of classes, their methods and intended usage) resembles the [Java Driver API](https://typedb.com/docs/drivers/java/api-reference). +To learn about the methods available for executing queries and retrieving their answers using the C# driver, refer to the [API Reference](https://typedb.com/docs/drivers/csharp/api-reference). ## Driver Architecture The C# driver is a thin wrapper around the TypeDB Rust driver, introducing classes for a more intuitive interface. Mostly each C# object holds a reference to the corresponding native Rust object, using an FFI ([SWIG for C#](https://www.swig.org/Doc4.2/SWIGDocumentation.html#CSharp)) for the native object wrappers generation and resource management. @@ -21,7 +36,8 @@ Any error encountered will throw a `TypeDBDriverException`. Note that methods wh ``` bazel build //csharp:driver-csharp ``` - The C# library will be produced at: `bazel-bin/csharp/driver-csharp/{target_framework}/driver-csharp.dll` + All the needed C# libraries will be produced at: `bazel-bin/csharp/`, with the main one being: `bazel-bin/csharp/driver-csharp/{target_framework}/TypeDB.Driver.dll`. +3. Examples of building and using Bazel-based C# applications with the produced dependencies can be found in `csharp/Test/Integration/Examples`. ## Examples ### TypeDB Core From fb7816bf9ef051ee725a837e343c8c0ccb7d991d Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 12:43:54 +0100 Subject: [PATCH 082/118] Add envvar for the mac installation, fix linux installation --- .circleci/config.yml | 25 +++++++++++-------- .../Deployment/NugetApplicationTest.csproj | 14 +++++------ 2 files changed, 21 insertions(+), 18 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 96fc0f5586..b5f09552f9 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -355,17 +355,20 @@ commands: install-dotnet-mac: steps: - - run: brew install dotnet@6 + - run: | + brew install dotnet + export DOTNET_ROOT="/usr/local/opt/dotnet/libexec" install-dotnet-mac-rosetta: steps: - install-brew-rosetta - - run: /usr/local/bin/brew install dotnet@6 + - run: /usr/local/bin/brew install dotnet install-dotnet-linux: steps: - run: | - yum install -y dotnet-runtime-6.0 + rpm -Uvh https://packages.microsoft.com/config/centos/7/packages-microsoft-prod.rpm + yum install -y dotnet-sdk-7.0 deploy-nuget-runtime-snapshot-unix: steps: @@ -660,14 +663,14 @@ jobs: # - run: .circleci\windows\java\test_deploy_snapshot.bat - run: .circleci\windows\csharp\test_deploy_snapshot.bat - test-snapshot-any: - executor: linux-x86_64-ubuntu-2204 - steps: - - checkout - - install-bazel-apt: - bazel-arch: amd64 - - install-npm-apt - - test-npm-snapshot-unix +# test-snapshot-any: +# executor: linux-x86_64-ubuntu-2204 +# steps: +# - checkout +# - install-bazel-apt: +# bazel-arch: amd64 +# - install-npm-apt +# - test-npm-snapshot-unix ################ # Release jobs # diff --git a/csharp/Test/Deployment/NugetApplicationTest.csproj b/csharp/Test/Deployment/NugetApplicationTest.csproj index cc10d2beb7..f1f84f3ec6 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.csproj +++ b/csharp/Test/Deployment/NugetApplicationTest.csproj @@ -44,13 +44,13 @@ under the License. - - - - - - - + + + + + + + From 0bdb4e31ac89e6c3c4517192c1f4afa9b7aaeac3 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 12:47:45 +0100 Subject: [PATCH 083/118] Fix circleci --- .circleci/config.yml | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index b5f09552f9..4185667ff0 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -663,14 +663,14 @@ jobs: # - run: .circleci\windows\java\test_deploy_snapshot.bat - run: .circleci\windows\csharp\test_deploy_snapshot.bat -# test-snapshot-any: -# executor: linux-x86_64-ubuntu-2204 -# steps: -# - checkout -# - install-bazel-apt: -# bazel-arch: amd64 -# - install-npm-apt -# - test-npm-snapshot-unix + test-snapshot-any: + executor: linux-x86_64-ubuntu-2204 + steps: + - checkout + - install-bazel-apt: + bazel-arch: amd64 + - install-npm-apt + - test-npm-snapshot-unix ################ # Release jobs # @@ -862,12 +862,12 @@ workflows: # - deploy-snapshot-windows-x86_64 # - deploy-snapshot-any - - test-snapshot-any: - filters: - branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: - - deploy-snapshot-any +# - test-snapshot-any: +# filters: +# branches: +# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# requires: +# - deploy-snapshot-any release: jobs: From c72cc8856422ddc3c618f06ce40e8433a2ecf8a1 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 12:58:34 +0100 Subject: [PATCH 084/118] Fix linux build, uncomment steps --- .circleci/config.yml | 130 ++++++++++++++++++++++--------------------- 1 file changed, 66 insertions(+), 64 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 4185667ff0..26591200d2 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -370,21 +370,21 @@ commands: rpm -Uvh https://packages.microsoft.com/config/centos/7/packages-microsoft-prod.rpm yum install -y dotnet-sdk-7.0 - deploy-nuget-runtime-snapshot-unix: + deploy-dotnet-runtime-snapshot-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot - deploy-nuget-snapshot-unix: + deploy-dotnet-snapshot-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot - test-nuget-snapshot-unix: + test-dotnet-snapshot-unix: steps: - run: | tool/test/start-core-server.sh @@ -393,7 +393,7 @@ commands: (cd csharp/Test/Deployment && dotnet run NugetApplicationTest.csproj) tool/test/stop-core-server.sh - test-nuget-snapshot-mac-rosetta: + test-dotnet-snapshot-mac-rosetta: steps: - run: | tool/test/start-core-server.sh @@ -402,14 +402,14 @@ commands: (cd csharp/Test/Deployment && /usr/local/bin/dotnet run NugetApplicationTest.csproj) tool/test/stop-core-server.sh - deploy-nuget-runtime-release-unix: + deploy-dotnet-runtime-release-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release - deploy-nuget-release-unix: + deploy-dotnet-release-unix: steps: - run: | export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 @@ -497,7 +497,8 @@ jobs: # - test-cpp-assembly-linux: # target-arch: arm64 - - deploy-nuget-runtime-snapshot-unix + - install-dotnet-linux # Needed for libicu deps + - deploy-dotnet-runtime-snapshot-unix deploy-snapshot-linux-x86_64: executor: linux-x86_64-amazonlinux-2 @@ -518,7 +519,8 @@ jobs: # - test-cpp-assembly-linux: # target-arch: x86_64 - - deploy-nuget-runtime-snapshot-unix + - install-dotnet-linux # Needed for libicu deps + - deploy-dotnet-runtime-snapshot-unix deploy-snapshot-mac-arm64: executor: mac-arm64 @@ -541,7 +543,7 @@ jobs: # - test-cpp-assembly-mac: # target-arch: arm64 - - deploy-nuget-runtime-snapshot-unix + - deploy-dotnet-runtime-snapshot-unix deploy-snapshot-mac-x86_64: executor: mac-arm64 @@ -565,7 +567,7 @@ jobs: # - test-cpp-assembly-mac: # target-arch: x86_64 - - deploy-nuget-runtime-snapshot-unix + - deploy-dotnet-runtime-snapshot-unix deploy-snapshot-windows-x86_64: executor: @@ -599,7 +601,7 @@ jobs: # - deploy-maven-snapshot-unix # - install-npm-apt # - deploy-npm-snapshot-unix - - deploy-nuget-snapshot-unix + - deploy-dotnet-snapshot-unix test-snapshot-linux-arm64: executor: linux-arm64-amazonlinux-2 @@ -611,7 +613,7 @@ jobs: # - install-maven-linux # - test-maven-snapshot-unix - install-dotnet-linux - - test-nuget-snapshot-unix + - test-dotnet-snapshot-unix test-snapshot-linux-x86_64: executor: linux-x86_64-amazonlinux-2 @@ -623,7 +625,7 @@ jobs: # - install-maven-linux # - test-maven-snapshot-unix - install-dotnet-linux - - test-nuget-snapshot-unix + - test-dotnet-snapshot-unix test-snapshot-mac-arm64: executor: mac-arm64 @@ -635,7 +637,7 @@ jobs: # - install-maven-mac # - test-maven-snapshot-unix - install-dotnet-mac - - test-nuget-snapshot-unix + - test-dotnet-snapshot-unix test-snapshot-mac-x86_64: executor: mac-arm64 @@ -648,7 +650,7 @@ jobs: # - install-maven-mac-rosetta # - test-maven-snapshot-mac-rosetta - install-dotnet-mac-rosetta - - test-nuget-snapshot-mac-rosetta + - test-dotnet-snapshot-mac-rosetta test-snapshot-windows-x86_64: executor: @@ -686,7 +688,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-nuget-runtime-release-unix + - deploy-dotnet-runtime-release-unix deploy-release-linux-x86_64: executor: linux-x86_64-amazonlinux-2 @@ -698,7 +700,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-nuget-runtime-release-unix + - deploy-dotnet-runtime-release-unix deploy-release-mac-arm64: executor: mac-arm64 @@ -710,7 +712,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-nuget-runtime-release-unix + - deploy-dotnet-runtime-release-unix deploy-release-mac-x86_64: executor: mac-arm64 @@ -723,7 +725,7 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix - - deploy-nuget-runtime-release-unix + - deploy-dotnet-runtime-release-unix deploy-release-windows-x86_64: executor: @@ -750,7 +752,7 @@ jobs: - deploy-maven-release-unix - install-npm-apt - deploy-npm-release-unix - - deploy-nuget-release-unix + - deploy-dotnet-release-unix deploy-github: executor: linux-x86_64-ubuntu-2204 @@ -794,14 +796,14 @@ jobs: workflows: typedb-driver-snapshot: jobs: -# - deploy-snapshot-linux-arm64: -# filters: -# branches: -# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# - deploy-snapshot-linux-x86_64: -# filters: -# branches: -# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + - deploy-snapshot-linux-arm64: + filters: + branches: + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + - deploy-snapshot-linux-x86_64: + filters: + branches: + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - deploy-snapshot-mac-arm64: filters: branches: @@ -810,36 +812,36 @@ workflows: filters: branches: only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# - deploy-snapshot-windows-x86_64: -# filters: -# branches: -# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + - deploy-snapshot-windows-x86_64: + filters: + branches: + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - deploy-snapshot-any: filters: branches: only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: -# - deploy-snapshot-linux-arm64 -# - deploy-snapshot-linux-x86_64 + - deploy-snapshot-linux-arm64 + - deploy-snapshot-linux-x86_64 - deploy-snapshot-mac-arm64 - deploy-snapshot-mac-x86_64 -# - deploy-snapshot-windows-x86_64 - -# - test-snapshot-linux-arm64: -# filters: -# branches: -# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: -# - deploy-snapshot-linux-arm64 -# - deploy-snapshot-any -# - test-snapshot-linux-x86_64: -# filters: -# branches: -# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: -# - deploy-snapshot-linux-x86_64 -# - deploy-snapshot-any + - deploy-snapshot-windows-x86_64 + + - test-snapshot-linux-arm64: + filters: + branches: + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + requires: + - deploy-snapshot-linux-arm64 + - deploy-snapshot-any + - test-snapshot-linux-x86_64: + filters: + branches: + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + requires: + - deploy-snapshot-linux-x86_64 + - deploy-snapshot-any - test-snapshot-mac-arm64: filters: branches: @@ -854,20 +856,20 @@ workflows: requires: - deploy-snapshot-mac-x86_64 - deploy-snapshot-any -# - test-snapshot-windows-x86_64: -# filters: -# branches: -# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: -# - deploy-snapshot-windows-x86_64 -# - deploy-snapshot-any - -# - test-snapshot-any: -# filters: -# branches: -# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: -# - deploy-snapshot-any + - test-snapshot-windows-x86_64: + filters: + branches: + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + requires: + - deploy-snapshot-windows-x86_64 + - deploy-snapshot-any + + - test-snapshot-any: + filters: + branches: + only: [master] + requires: + - deploy-snapshot-any release: jobs: From 1317613f9d8de545f99892428814d2584ad2fd10 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 13:19:35 +0100 Subject: [PATCH 085/118] Change project descriptions --- csharp/TypeDB.Driver.Pinvoke.nuspec | 6 ++++-- csharp/TypeDB.Driver.nuspec | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/csharp/TypeDB.Driver.Pinvoke.nuspec b/csharp/TypeDB.Driver.Pinvoke.nuspec index 8069c980d5..37bfc1869b 100644 --- a/csharp/TypeDB.Driver.Pinvoke.nuspec +++ b/csharp/TypeDB.Driver.Pinvoke.nuspec @@ -27,9 +27,11 @@ under the License. TypeDB TypeDB Driver Runtime false - The TypeDB driver was developed by Vaticle to enable TypeDB support for C# software and developers. + Runtime part of the library for TypeDB C# support. TypeDB is a polymorphic database with a conceptual data model, a strong subtyping system, a symbolic reasoning engine, and a beautiful and elegant type-theoretic language: TypeQL. + This package contains a runtime library for the TypeDB driver: https://www.nuget.org/packages/TypeDB.Driver. + Check all the available platform-dependent runtime libraries here: https://www.nuget.org/packages?q=TypeDB.Driver.Pinvoke. https://typedb.com @@ -37,7 +39,7 @@ under the License. https://typedb.com/assets/logo/typedb.svg Database TypeDB TypeQL Runtime - See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver. TODO: Changelog? + See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver/releases. diff --git a/csharp/TypeDB.Driver.nuspec b/csharp/TypeDB.Driver.nuspec index 4e9ae09bf2..171b606a93 100644 --- a/csharp/TypeDB.Driver.nuspec +++ b/csharp/TypeDB.Driver.nuspec @@ -27,9 +27,11 @@ under the License. TypeDB TypeDB Driver false - The TypeDB driver was developed by Vaticle to enable TypeDB support for C# software and developers. + This package enables TypeDB support for C#. TypeDB is a polymorphic database with a conceptual data model, a strong subtyping system, a symbolic reasoning engine, and a beautiful and elegant type-theoretic language: TypeQL. + To use this package, include a runtime library TypeDB.Driver.Pinvoke for your platform into your project as well: https://www.nuget.org/packages?q=TypeDB.Driver.Pinvoke. + It is also possible to reference a number of runtime packages for the driver in order to build a platform-independent application. https://typedb.com @@ -37,7 +39,7 @@ under the License. https://typedb.com/assets/logo/typedb.svg Database TypeDB TypeQL - See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver. TODO: Changelog? + See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver/releases. From 47a6e34affb3e61ccc179719a4f60146049b147e Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 14:02:35 +0100 Subject: [PATCH 086/118] Fix linux deps --- .circleci/config.yml | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 26591200d2..ddd184681b 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -368,21 +368,19 @@ commands: steps: - run: | rpm -Uvh https://packages.microsoft.com/config/centos/7/packages-microsoft-prod.rpm - yum install -y dotnet-sdk-7.0 + yum install -y dotnet-sdk-6.0 deploy-dotnet-runtime-snapshot-unix: steps: - run: | - export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-runtime-push -- snapshot deploy-dotnet-snapshot-unix: steps: - run: | - export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD - bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -- snapshot + bazel run --jobs=8 --define version=0.0.0-$(git rev-parse HEAD) //csharp:driver-csharp-push -- snapshot test-dotnet-snapshot-unix: steps: @@ -405,16 +403,14 @@ commands: deploy-dotnet-runtime-release-unix: steps: - run: | - export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push --compilation_mode=opt -- release deploy-dotnet-release-unix: steps: - run: | - export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push --host_action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --action_env=DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 --compilation_mode=opt -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push --compilation_mode=opt -- release ######################### # Rust deployment steps # From a682e2262788525cd17e5a7f8b1fc375ab69fb5d Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 14:22:52 +0100 Subject: [PATCH 087/118] Add readme to the packages. Comment out windows temporarily --- .circleci/config.yml | 2 +- csharp/BUILD | 7 ++++++- csharp/Test/Deployment/NugetApplicationTest.csproj | 2 +- csharp/TypeDB.Driver.Pinvoke.nuspec | 3 +++ csharp/TypeDB.Driver.nuspec | 3 +++ 5 files changed, 14 insertions(+), 3 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index ddd184681b..e260f77f41 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -822,7 +822,7 @@ workflows: - deploy-snapshot-linux-x86_64 - deploy-snapshot-mac-arm64 - deploy-snapshot-mac-x86_64 - - deploy-snapshot-windows-x86_64 +# - deploy-snapshot-windows-x86_64 - test-snapshot-linux-arm64: filters: diff --git a/csharp/BUILD b/csharp/BUILD index b94df257a9..db0de1e0fe 100644 --- a/csharp/BUILD +++ b/csharp/BUILD @@ -61,11 +61,13 @@ csharp_library( swig_native_nuget_pack( name = "driver-csharp-runtime-pack", id = "TypeDB.Driver.Pinvoke", - files = {}, libs = { ":typedb_driver_pinvoke": "TypeDB.Driver.Pinvoke", }, native_libs = ["typedb_driver"], + files = { + "README.md": "README.md", + }, target_framework = target_framework, nuspec_template = "TypeDB.Driver.Pinvoke.nuspec", visibility= ["//visibility:public"], @@ -100,6 +102,9 @@ nuget_pack( "//csharp/Query:query": "TypeDB.Driver.Query", "//csharp/User:user": "TypeDB.Driver.User", }, + files = { + "README.md": "README.md", + }, target_framework = target_framework, nuspec_template = "TypeDB.Driver.nuspec", visibility = ["//visibility:public"], diff --git a/csharp/Test/Deployment/NugetApplicationTest.csproj b/csharp/Test/Deployment/NugetApplicationTest.csproj index f1f84f3ec6..2cf87c43e7 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.csproj +++ b/csharp/Test/Deployment/NugetApplicationTest.csproj @@ -50,7 +50,7 @@ under the License. - + diff --git a/csharp/TypeDB.Driver.Pinvoke.nuspec b/csharp/TypeDB.Driver.Pinvoke.nuspec index 37bfc1869b..a8a8caa8a7 100644 --- a/csharp/TypeDB.Driver.Pinvoke.nuspec +++ b/csharp/TypeDB.Driver.Pinvoke.nuspec @@ -41,8 +41,11 @@ under the License. See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver/releases. + docs/README.md + + diff --git a/csharp/TypeDB.Driver.nuspec b/csharp/TypeDB.Driver.nuspec index 171b606a93..f07cede901 100644 --- a/csharp/TypeDB.Driver.nuspec +++ b/csharp/TypeDB.Driver.nuspec @@ -41,6 +41,7 @@ under the License. See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver/releases. + docs/README.md @@ -48,6 +49,8 @@ under the License. + + From bf6c2cb257379b030c864864c437d9251eff4e9e Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 14:40:25 +0100 Subject: [PATCH 088/118] Fix windows build, return windows steps --- .circleci/config.yml | 2 +- .circleci/windows/clib/deploy_release.bat | 2 +- .circleci/windows/clib/deploy_snapshot.bat | 2 +- .circleci/windows/clib/test_assembly.bat | 4 ++-- .circleci/windows/cpp/deploy_release.bat | 2 +- .circleci/windows/cpp/deploy_snapshot.bat | 2 +- .circleci/windows/cpp/test_assembly.bat | 4 ++-- .circleci/windows/csharp/test_deploy_snapshot.bat | 2 +- .circleci/windows/java/test_deploy_snapshot.bat | 2 +- .circleci/windows/python/test_deploy_snapshot.bat | 2 +- csharp/Test/Deployment/NugetApplicationTest.csproj | 2 +- csharp/TypeDB.Driver.Pinvoke.nuspec | 2 +- csharp/TypeDB.Driver.nuspec | 2 +- 13 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index e260f77f41..ddd184681b 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -822,7 +822,7 @@ workflows: - deploy-snapshot-linux-x86_64 - deploy-snapshot-mac-arm64 - deploy-snapshot-mac-x86_64 -# - deploy-snapshot-windows-x86_64 + - deploy-snapshot-windows-x86_64 - test-snapshot-linux-arm64: filters: diff --git a/.circleci/windows/clib/deploy_release.bat b/.circleci/windows/clib/deploy_release.bat index 99ac3a37de..39178802a5 100644 --- a/.circleci/windows/clib/deploy_release.bat +++ b/.circleci/windows/clib/deploy_release.bat @@ -25,5 +25,5 @@ SET DEPLOY_ARTIFACT_USERNAME=%REPO_TYPEDB_USERNAME% SET DEPLOY_ARTIFACT_PASSWORD=%REPO_TYPEDB_PASSWORD% SET /p VER= version_snapshot.txt set /p VER= version_snapshot.txt set /p VER= version_temp.txt set /p VER= - + diff --git a/csharp/TypeDB.Driver.Pinvoke.nuspec b/csharp/TypeDB.Driver.Pinvoke.nuspec index a8a8caa8a7..d71b2069c4 100644 --- a/csharp/TypeDB.Driver.Pinvoke.nuspec +++ b/csharp/TypeDB.Driver.Pinvoke.nuspec @@ -36,7 +36,7 @@ under the License. https://typedb.com Apache-2.0 - https://typedb.com/assets/logo/typedb.svg + https://typedb.com/favicon.ico Database TypeDB TypeQL Runtime See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver/releases. diff --git a/csharp/TypeDB.Driver.nuspec b/csharp/TypeDB.Driver.nuspec index f07cede901..29ff8a2c2d 100644 --- a/csharp/TypeDB.Driver.nuspec +++ b/csharp/TypeDB.Driver.nuspec @@ -36,7 +36,7 @@ under the License. https://typedb.com Apache-2.0 - https://typedb.com/assets/logo/typedb.svg + https://typedb.com/favicon.ico Database TypeDB TypeQL See the latest changes, included in this release, at https://github.com/vaticle/typedb-driver/releases. From cc217c06f4ebe07452add67559ac09fbada7b143 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 15:10:09 +0100 Subject: [PATCH 089/118] Turn windows off again... --- .circleci/config.yml | 2 +- csharp/Test/Deployment/NugetApplicationTest.csproj | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index ddd184681b..8657103ab2 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -822,7 +822,7 @@ workflows: - deploy-snapshot-linux-x86_64 - deploy-snapshot-mac-arm64 - deploy-snapshot-mac-x86_64 - - deploy-snapshot-windows-x86_64 +# - deploy-snapshot-windows-x86_64 # TODO: Return - test-snapshot-linux-arm64: filters: diff --git a/csharp/Test/Deployment/NugetApplicationTest.csproj b/csharp/Test/Deployment/NugetApplicationTest.csproj index f1f84f3ec6..4153ea6ad9 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.csproj +++ b/csharp/Test/Deployment/NugetApplicationTest.csproj @@ -47,10 +47,9 @@ under the License. - + - From 8b332011011134204cedac4fd0e0237687955b6f Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 15:14:40 +0100 Subject: [PATCH 090/118] Change /bazel -> /b --- .circleci/windows/csharp/deploy_release.bat | 2 +- .circleci/windows/csharp/deploy_snapshot.bat | 2 +- .circleci/windows/java/deploy_release.bat | 2 +- .circleci/windows/java/deploy_snapshot.bat | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.circleci/windows/csharp/deploy_release.bat b/.circleci/windows/csharp/deploy_release.bat index e85dee98b5..ac4e57aee2 100644 --- a/.circleci/windows/csharp/deploy_release.bat +++ b/.circleci/windows/csharp/deploy_release.bat @@ -25,5 +25,5 @@ SET DEPLOY_NUGET_API_KEY=%REPO_TYPEDB_PASSWORD% @REM TODO: Add new key for nuget as a new variable! SET /p VER= version_snapshot.txt set /p VER= version_snapshot.txt set /p VER= Date: Wed, 3 Apr 2024 15:53:44 +0100 Subject: [PATCH 091/118] Enable windows to run python scripts. Update mac deps for dotnet --- .circleci/config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 8657103ab2..c08c986019 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -356,13 +356,13 @@ commands: install-dotnet-mac: steps: - run: | - brew install dotnet + brew install dotnet@6 export DOTNET_ROOT="/usr/local/opt/dotnet/libexec" install-dotnet-mac-rosetta: steps: - install-brew-rosetta - - run: /usr/local/bin/brew install dotnet + - run: /usr/local/bin/brew install dotnet@6 install-dotnet-linux: steps: From 1f8e67718e78422605fee1f76cd2cda89bcb4830 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 17:17:02 +0100 Subject: [PATCH 092/118] Try fixing macos and windows circleci --- .circleci/config.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index c08c986019..a3d8e6f277 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -357,12 +357,14 @@ commands: steps: - run: | brew install dotnet@6 - export DOTNET_ROOT="/usr/local/opt/dotnet/libexec" + ln -s /usr/local/share/dotnet/dotnet /usr/local/bin/ install-dotnet-mac-rosetta: steps: - install-brew-rosetta - - run: /usr/local/bin/brew install dotnet@6 + - run: | + /usr/local/bin/brew install dotnet@6 + ln -s /usr/local/share/dotnet/x64/dotnet /usr/local/bin/ install-dotnet-linux: steps: From 221935c5c11f9e5463fedc539fc4fc11b08f1332 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 22:16:43 +0100 Subject: [PATCH 093/118] Add a series of test changes for circleci --- .circleci/config.yml | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index a3d8e6f277..2df8ca73c3 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -357,14 +357,21 @@ commands: steps: - run: | brew install dotnet@6 + find / -name dotnet ln -s /usr/local/share/dotnet/dotnet /usr/local/bin/ + ln -s /opt/homebrew/opt/dotnet@6/dotnet /usr/local/bin/ + export DOTNET_ROOT="/opt/homebrew/opt/dotnet@6/libexec" install-dotnet-mac-rosetta: steps: - install-brew-rosetta - run: | /usr/local/bin/brew install dotnet@6 + find / -name dotnet ln -s /usr/local/share/dotnet/x64/dotnet /usr/local/bin/ + ln -s /usr/local/share/dotnet/dotnet /usr/local/bin/ + ln -s /usr/local/opt/dotnet@6/dotnet /usr/local/bin/ + export DOTNET_ROOT="/usr/local/opt/dotnet@6/libexec" install-dotnet-linux: steps: @@ -372,6 +379,12 @@ commands: rpm -Uvh https://packages.microsoft.com/config/centos/7/packages-microsoft-prod.rpm yum install -y dotnet-sdk-6.0 + install-libicu-linux: + steps: + - run: | +# rpm -Uvh https://packages.microsoft.com/config/centos/7/packages-microsoft-prod.rpm + yum install -y libicu60 + deploy-dotnet-runtime-snapshot-unix: steps: - run: | @@ -495,7 +508,8 @@ jobs: # - test-cpp-assembly-linux: # target-arch: arm64 - - install-dotnet-linux # Needed for libicu deps +# - install-dotnet-linux # Needed for libicu deps + - install-libicu-linux - deploy-dotnet-runtime-snapshot-unix deploy-snapshot-linux-x86_64: @@ -517,7 +531,8 @@ jobs: # - test-cpp-assembly-linux: # target-arch: x86_64 - - install-dotnet-linux # Needed for libicu deps +# - install-dotnet-linux # Needed for libicu deps + - install-libicu-linux - deploy-dotnet-runtime-snapshot-unix deploy-snapshot-mac-arm64: From 4b94322d0c5f9d983d63c6ad04f200933d7dc431 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 22:19:06 +0100 Subject: [PATCH 094/118] Fix circleci --- .circleci/config.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 2df8ca73c3..5a64aabfc4 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -381,9 +381,7 @@ commands: install-libicu-linux: steps: - - run: | -# rpm -Uvh https://packages.microsoft.com/config/centos/7/packages-microsoft-prod.rpm - yum install -y libicu60 + - run: yum install -y libicu60 deploy-dotnet-runtime-snapshot-unix: steps: From af1d63dd9758d96079070b6dd9509329cd97309e Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 22:59:43 +0100 Subject: [PATCH 095/118] Add another try for mac and linux --- .circleci/config.yml | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 5a64aabfc4..de4a49bfea 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -357,21 +357,21 @@ commands: steps: - run: | brew install dotnet@6 - find / -name dotnet - ln -s /usr/local/share/dotnet/dotnet /usr/local/bin/ - ln -s /opt/homebrew/opt/dotnet@6/dotnet /usr/local/bin/ - export DOTNET_ROOT="/opt/homebrew/opt/dotnet@6/libexec" +# find / -name dotnet +# ln -s /usr/local/share/dotnet/dotnet /usr/local/bin/ + ln -s /opt/homebrew/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ + +# export DOTNET_ROOT="/opt/homebrew/opt/dotnet@6/libexec" install-dotnet-mac-rosetta: steps: - install-brew-rosetta - run: | /usr/local/bin/brew install dotnet@6 - find / -name dotnet - ln -s /usr/local/share/dotnet/x64/dotnet /usr/local/bin/ - ln -s /usr/local/share/dotnet/dotnet /usr/local/bin/ - ln -s /usr/local/opt/dotnet@6/dotnet /usr/local/bin/ - export DOTNET_ROOT="/usr/local/opt/dotnet@6/libexec" +# find / -name dotnet +# ln -s /usr/local/share/dotnet/dotnet /usr/local/bin/ + ln -s /usr/local/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ +# export DOTNET_ROOT="/usr/local/opt/dotnet@6/libexec" install-dotnet-linux: steps: @@ -506,7 +506,6 @@ jobs: # - test-cpp-assembly-linux: # target-arch: arm64 -# - install-dotnet-linux # Needed for libicu deps - install-libicu-linux - deploy-dotnet-runtime-snapshot-unix @@ -529,7 +528,6 @@ jobs: # - test-cpp-assembly-linux: # target-arch: x86_64 -# - install-dotnet-linux # Needed for libicu deps - install-libicu-linux - deploy-dotnet-runtime-snapshot-unix @@ -624,6 +622,7 @@ jobs: # - install-maven-linux # - test-maven-snapshot-unix - install-dotnet-linux + - install-libicu-linux - test-dotnet-snapshot-unix test-snapshot-linux-x86_64: From 42c2f01fe445a16b728f8b224d7fb71d29a6d22b Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Wed, 3 Apr 2024 23:00:50 +0100 Subject: [PATCH 096/118] Fix config.yml --- .circleci/config.yml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index de4a49bfea..314ec65859 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -357,21 +357,14 @@ commands: steps: - run: | brew install dotnet@6 -# find / -name dotnet -# ln -s /usr/local/share/dotnet/dotnet /usr/local/bin/ ln -s /opt/homebrew/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ -# export DOTNET_ROOT="/opt/homebrew/opt/dotnet@6/libexec" - install-dotnet-mac-rosetta: steps: - install-brew-rosetta - run: | /usr/local/bin/brew install dotnet@6 -# find / -name dotnet -# ln -s /usr/local/share/dotnet/dotnet /usr/local/bin/ ln -s /usr/local/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ -# export DOTNET_ROOT="/usr/local/opt/dotnet@6/libexec" install-dotnet-linux: steps: From f4d6466ca77453ff908a67f660fe1322d2cfa85e Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 09:23:23 +0100 Subject: [PATCH 097/118] Add install script for mac dotnet for tests --- .circleci/config.yml | 52 ++++++++++++++++++++++++-------------------- 1 file changed, 29 insertions(+), 23 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 314ec65859..6c3926b969 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -356,14 +356,20 @@ commands: install-dotnet-mac: steps: - run: | - brew install dotnet@6 +# brew install dotnet@6 + curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" + chmod a+x dotnet-install.sh + ./dotnet-install.sh --version 6.0.125 ln -s /opt/homebrew/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ install-dotnet-mac-rosetta: steps: - install-brew-rosetta - run: | - /usr/local/bin/brew install dotnet@6 +# /usr/local/bin/brew install dotnet@6 + curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" + chmod a+x dotnet-install.sh + ./dotnet-install.sh --version 6.0.125 ln -s /usr/local/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ install-dotnet-linux: @@ -831,20 +837,20 @@ workflows: - deploy-snapshot-mac-x86_64 # - deploy-snapshot-windows-x86_64 # TODO: Return - - test-snapshot-linux-arm64: - filters: - branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: - - deploy-snapshot-linux-arm64 - - deploy-snapshot-any - - test-snapshot-linux-x86_64: - filters: - branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: - - deploy-snapshot-linux-x86_64 - - deploy-snapshot-any +# - test-snapshot-linux-arm64: +# filters: +# branches: +# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# requires: +# - deploy-snapshot-linux-arm64 +# - deploy-snapshot-any +# - test-snapshot-linux-x86_64: +# filters: +# branches: +# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# requires: +# - deploy-snapshot-linux-x86_64 +# - deploy-snapshot-any - test-snapshot-mac-arm64: filters: branches: @@ -859,13 +865,13 @@ workflows: requires: - deploy-snapshot-mac-x86_64 - deploy-snapshot-any - - test-snapshot-windows-x86_64: - filters: - branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: - - deploy-snapshot-windows-x86_64 - - deploy-snapshot-any +# - test-snapshot-windows-x86_64: +# filters: +# branches: +# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# requires: +# - deploy-snapshot-windows-x86_64 +# - deploy-snapshot-any - test-snapshot-any: filters: From fc29f90106ece8c4a88e55258f2eee23d75bea3b Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 09:24:50 +0100 Subject: [PATCH 098/118] Remove comments from config.yml for build fix --- .circleci/config.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 6c3926b969..59be1b3e37 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -356,7 +356,6 @@ commands: install-dotnet-mac: steps: - run: | -# brew install dotnet@6 curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" chmod a+x dotnet-install.sh ./dotnet-install.sh --version 6.0.125 @@ -366,7 +365,6 @@ commands: steps: - install-brew-rosetta - run: | -# /usr/local/bin/brew install dotnet@6 curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" chmod a+x dotnet-install.sh ./dotnet-install.sh --version 6.0.125 From fba3e500649119a37113248d348156131621d42d Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 10:00:34 +0100 Subject: [PATCH 099/118] Remove linux from builds, experiment with mac --- .circleci/config.yml | 24 +++++++++---------- .../Deployment/NugetApplicationTest.csproj | 4 ++-- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 59be1b3e37..dbd93f0e0d 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -359,8 +359,7 @@ commands: curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" chmod a+x dotnet-install.sh ./dotnet-install.sh --version 6.0.125 - ln -s /opt/homebrew/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ - + install-dotnet-mac-rosetta: steps: - install-brew-rosetta @@ -368,7 +367,6 @@ commands: curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" chmod a+x dotnet-install.sh ./dotnet-install.sh --version 6.0.125 - ln -s /usr/local/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ install-dotnet-linux: steps: @@ -803,14 +801,14 @@ jobs: workflows: typedb-driver-snapshot: jobs: - - deploy-snapshot-linux-arm64: - filters: - branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - - deploy-snapshot-linux-x86_64: - filters: - branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# - deploy-snapshot-linux-arm64: +# filters: +# branches: +# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# - deploy-snapshot-linux-x86_64: +# filters: +# branches: +# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - deploy-snapshot-mac-arm64: filters: branches: @@ -829,8 +827,8 @@ workflows: branches: only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: - - deploy-snapshot-linux-arm64 - - deploy-snapshot-linux-x86_64 +# - deploy-snapshot-linux-arm64 +# - deploy-snapshot-linux-x86_64 - deploy-snapshot-mac-arm64 - deploy-snapshot-mac-x86_64 # - deploy-snapshot-windows-x86_64 # TODO: Return diff --git a/csharp/Test/Deployment/NugetApplicationTest.csproj b/csharp/Test/Deployment/NugetApplicationTest.csproj index 4153ea6ad9..cb7d661e92 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.csproj +++ b/csharp/Test/Deployment/NugetApplicationTest.csproj @@ -46,10 +46,10 @@ under the License. - + - + From 5be83185c67c1549c24e65dd083bffb24618c8e2 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 10:04:00 +0100 Subject: [PATCH 100/118] Turn off everything except of dotnet mac --- .circleci/config.yml | 70 +++++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 33 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index dbd93f0e0d..dd5df00579 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -356,17 +356,21 @@ commands: install-dotnet-mac: steps: - run: | - curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" - chmod a+x dotnet-install.sh - ./dotnet-install.sh --version 6.0.125 + brew install dotnet@6 +# curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" +# chmod a+x dotnet-install.sh +# ./dotnet-install.sh --version 6.0.125 + ln -s /opt/homebrew/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ install-dotnet-mac-rosetta: steps: - install-brew-rosetta - run: | - curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" - chmod a+x dotnet-install.sh - ./dotnet-install.sh --version 6.0.125 + /usr/local/bin/brew install dotnet@6 +# curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" +# chmod a+x dotnet-install.sh +# ./dotnet-install.sh --version 6.0.125 + ln -s /usr/local/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ install-dotnet-linux: steps: @@ -809,29 +813,29 @@ workflows: # filters: # branches: # only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - - deploy-snapshot-mac-arm64: - filters: - branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - - deploy-snapshot-mac-x86_64: - filters: - branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - - deploy-snapshot-windows-x86_64: - filters: - branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - - - deploy-snapshot-any: - filters: - branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: -# - deploy-snapshot-linux-arm64 -# - deploy-snapshot-linux-x86_64 - - deploy-snapshot-mac-arm64 - - deploy-snapshot-mac-x86_64 -# - deploy-snapshot-windows-x86_64 # TODO: Return +# - deploy-snapshot-mac-arm64: +# filters: +# branches: +# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# - deploy-snapshot-mac-x86_64: +# filters: +# branches: +# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# - deploy-snapshot-windows-x86_64: +# filters: +# branches: +# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# +# - deploy-snapshot-any: +# filters: +# branches: +# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# requires: +## - deploy-snapshot-linux-arm64 +## - deploy-snapshot-linux-x86_64 +# - deploy-snapshot-mac-arm64 +# - deploy-snapshot-mac-x86_64 +## - deploy-snapshot-windows-x86_64 # TODO: Return # - test-snapshot-linux-arm64: # filters: @@ -852,15 +856,15 @@ workflows: branches: only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: - - deploy-snapshot-mac-arm64 - - deploy-snapshot-any +# - deploy-snapshot-mac-arm64 +# - deploy-snapshot-any - test-snapshot-mac-x86_64: filters: branches: only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment requires: - - deploy-snapshot-mac-x86_64 - - deploy-snapshot-any +# - deploy-snapshot-mac-x86_64 +# - deploy-snapshot-any # - test-snapshot-windows-x86_64: # filters: # branches: From ab1a2cae41e6fa1d3e70f3a507a0cf3c127ff53d Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 10:04:36 +0100 Subject: [PATCH 101/118] Test dotnet install for mac --- .circleci/config.yml | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index dd5df00579..02dfb168de 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -356,21 +356,17 @@ commands: install-dotnet-mac: steps: - run: | - brew install dotnet@6 -# curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" -# chmod a+x dotnet-install.sh -# ./dotnet-install.sh --version 6.0.125 - ln -s /opt/homebrew/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ + curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" + chmod a+x dotnet-install.sh + ./dotnet-install.sh --version 6.0.125 install-dotnet-mac-rosetta: steps: - install-brew-rosetta - run: | - /usr/local/bin/brew install dotnet@6 -# curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" -# chmod a+x dotnet-install.sh -# ./dotnet-install.sh --version 6.0.125 - ln -s /usr/local/Cellar/dotnet@6/6.0.125/bin/dotnet /usr/local/bin/ + curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" + chmod a+x dotnet-install.sh + ./dotnet-install.sh --version 6.0.125 install-dotnet-linux: steps: From a552b3a9d32090117f4e9f5ccece19ff0040d2c3 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 10:05:23 +0100 Subject: [PATCH 102/118] Turn test snapshot any off --- .circleci/config.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 02dfb168de..798d89a9fd 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -869,12 +869,12 @@ workflows: # - deploy-snapshot-windows-x86_64 # - deploy-snapshot-any - - test-snapshot-any: - filters: - branches: - only: [master] - requires: - - deploy-snapshot-any +# - test-snapshot-any: +# filters: +# branches: +# only: [master] +# requires: +# - deploy-snapshot-any release: jobs: From fe39c410c527044e42551859bc3a1ab1cd76012d Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 10:05:59 +0100 Subject: [PATCH 103/118] Fix build --- .circleci/config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 798d89a9fd..cbc131edfd 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -851,14 +851,14 @@ workflows: filters: branches: only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: +# requires: # - deploy-snapshot-mac-arm64 # - deploy-snapshot-any - test-snapshot-mac-x86_64: filters: branches: only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: +# requires: # - deploy-snapshot-mac-x86_64 # - deploy-snapshot-any # - test-snapshot-windows-x86_64: From fd2eed5b909cdba474c5b43e63d763031769f2ae Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 10:11:44 +0100 Subject: [PATCH 104/118] Add find dotnet for mac builds --- .circleci/config.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index cbc131edfd..6cdb27d50f 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -359,6 +359,7 @@ commands: curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" chmod a+x dotnet-install.sh ./dotnet-install.sh --version 6.0.125 + find / -name dotnet install-dotnet-mac-rosetta: steps: @@ -367,6 +368,7 @@ commands: curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" chmod a+x dotnet-install.sh ./dotnet-install.sh --version 6.0.125 + find / -name dotnet install-dotnet-linux: steps: From 80c72f6508a288ab1a2028a620ba162b924e00f2 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 10:17:17 +0100 Subject: [PATCH 105/118] Add ln for mac installation --- .circleci/config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 6cdb27d50f..1cffd14997 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -359,7 +359,7 @@ commands: curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" chmod a+x dotnet-install.sh ./dotnet-install.sh --version 6.0.125 - find / -name dotnet + ln -s /Users/distiller/.dotnet/dotnet /usr/local/bin/ install-dotnet-mac-rosetta: steps: @@ -368,7 +368,7 @@ commands: curl -OL "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh" chmod a+x dotnet-install.sh ./dotnet-install.sh --version 6.0.125 - find / -name dotnet + ln -s /Users/distiller/.dotnet/dotnet /usr/local/bin/ install-dotnet-linux: steps: From 5f4581e1d8802e8e3504c599ea699f3c1b1b8823 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 10:43:59 +0100 Subject: [PATCH 106/118] Add additional logs, fix versioning for tests --- .circleci/config.yml | 10 +++++----- csharp/Test/Deployment/NugetApplicationTest.csproj | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 1cffd14997..1949d3e517 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -863,11 +863,11 @@ workflows: # requires: # - deploy-snapshot-mac-x86_64 # - deploy-snapshot-any -# - test-snapshot-windows-x86_64: -# filters: -# branches: -# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: + - test-snapshot-windows-x86_64: + filters: + branches: + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + requires: # - deploy-snapshot-windows-x86_64 # - deploy-snapshot-any diff --git a/csharp/Test/Deployment/NugetApplicationTest.csproj b/csharp/Test/Deployment/NugetApplicationTest.csproj index cb7d661e92..ec36f9a9a8 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.csproj +++ b/csharp/Test/Deployment/NugetApplicationTest.csproj @@ -44,12 +44,12 @@ under the License. - - - - - - + + + + + + From d20707030def2ff5fcb90ad6aa90c47eb3b4e61f Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 10:44:48 +0100 Subject: [PATCH 107/118] Remove requires for windows --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 1949d3e517..bab2ade074 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -867,7 +867,7 @@ workflows: filters: branches: only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: +# requires: # - deploy-snapshot-windows-x86_64 # - deploy-snapshot-any From 6e6f13aebb50770026c377a0bf4a7645ad45458f Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 10:48:30 +0100 Subject: [PATCH 108/118] Return windows snapshot deploy --- .circleci/config.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index bab2ade074..6ec2383ab1 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -819,10 +819,10 @@ workflows: # filters: # branches: # only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# - deploy-snapshot-windows-x86_64: -# filters: -# branches: -# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + - deploy-snapshot-windows-x86_64: + filters: + branches: + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment # # - deploy-snapshot-any: # filters: @@ -867,9 +867,9 @@ workflows: filters: branches: only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: -# - deploy-snapshot-windows-x86_64 -# - deploy-snapshot-any + requires: + - deploy-snapshot-windows-x86_64 + - deploy-snapshot-any # - test-snapshot-any: # filters: From a54dfc4c78410043a4041c721b6160e835d53e46 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 10:49:33 +0100 Subject: [PATCH 109/118] Comment out excessive rules --- .circleci/config.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 6ec2383ab1..f52dc336e0 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -863,13 +863,13 @@ workflows: # requires: # - deploy-snapshot-mac-x86_64 # - deploy-snapshot-any - - test-snapshot-windows-x86_64: - filters: - branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment - requires: - - deploy-snapshot-windows-x86_64 - - deploy-snapshot-any +# - test-snapshot-windows-x86_64: +# filters: +# branches: +# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# requires: +# - deploy-snapshot-windows-x86_64 +# - deploy-snapshot-any # - test-snapshot-any: # filters: From 343f8f7e8283cec698aaa7219a0546f931bf66a5 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 11:25:51 +0100 Subject: [PATCH 110/118] Update ref with more runtimes --- .circleci/config.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index f52dc336e0..76d308ee1d 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -849,17 +849,17 @@ workflows: # requires: # - deploy-snapshot-linux-x86_64 # - deploy-snapshot-any - - test-snapshot-mac-arm64: - filters: - branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# - test-snapshot-mac-arm64: +# filters: +# branches: +# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment # requires: # - deploy-snapshot-mac-arm64 # - deploy-snapshot-any - - test-snapshot-mac-x86_64: - filters: - branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment +# - test-snapshot-mac-x86_64: +# filters: +# branches: +# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment # requires: # - deploy-snapshot-mac-x86_64 # - deploy-snapshot-any From 5b386b43b31809f5f99f2c5a07fa0ba2ce09c7e4 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 11:46:54 +0100 Subject: [PATCH 111/118] Return all the new build steps, update refs with fixes --- .circleci/config.yml | 148 +++++++++--------- .factory/automation.yml | 2 +- .../Deployment/NugetApplicationTest.csproj | 6 +- 3 files changed, 82 insertions(+), 74 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 76d308ee1d..67f531b58c 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -803,80 +803,88 @@ jobs: workflows: typedb-driver-snapshot: jobs: -# - deploy-snapshot-linux-arm64: -# filters: -# branches: -# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# - deploy-snapshot-linux-x86_64: -# filters: -# branches: -# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# - deploy-snapshot-mac-arm64: -# filters: -# branches: -# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# - deploy-snapshot-mac-x86_64: -# filters: -# branches: -# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + - deploy-snapshot-linux-arm64: + filters: + branches: + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + + - deploy-snapshot-linux-x86_64: + filters: + branches: + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + + - deploy-snapshot-mac-arm64: + filters: + branches: + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + + - deploy-snapshot-mac-x86_64: + filters: + branches: + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + - deploy-snapshot-windows-x86_64: filters: branches: only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# -# - deploy-snapshot-any: -# filters: -# branches: -# only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: -## - deploy-snapshot-linux-arm64 -## - deploy-snapshot-linux-x86_64 -# - deploy-snapshot-mac-arm64 -# - deploy-snapshot-mac-x86_64 -## - deploy-snapshot-windows-x86_64 # TODO: Return - -# - test-snapshot-linux-arm64: -# filters: -# branches: -# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: -# - deploy-snapshot-linux-arm64 -# - deploy-snapshot-any -# - test-snapshot-linux-x86_64: -# filters: -# branches: -# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: -# - deploy-snapshot-linux-x86_64 -# - deploy-snapshot-any -# - test-snapshot-mac-arm64: -# filters: -# branches: -# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: -# - deploy-snapshot-mac-arm64 -# - deploy-snapshot-any -# - test-snapshot-mac-x86_64: -# filters: -# branches: -# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: -# - deploy-snapshot-mac-x86_64 -# - deploy-snapshot-any -# - test-snapshot-windows-x86_64: -# filters: -# branches: -# only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment -# requires: -# - deploy-snapshot-windows-x86_64 -# - deploy-snapshot-any - -# - test-snapshot-any: -# filters: -# branches: -# only: [master] -# requires: -# - deploy-snapshot-any + + - deploy-snapshot-any: + filters: + branches: + only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + requires: + - deploy-snapshot-linux-arm64 + - deploy-snapshot-linux-x86_64 + - deploy-snapshot-mac-arm64 + - deploy-snapshot-mac-x86_64 + - deploy-snapshot-windows-x86_64 + + - test-snapshot-linux-arm64: + filters: + branches: + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + requires: + - deploy-snapshot-linux-arm64 + - deploy-snapshot-any + - + - test-snapshot-linux-x86_64: + filters: + branches: + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + requires: + - deploy-snapshot-linux-x86_64 + - deploy-snapshot-any + - + - test-snapshot-mac-arm64: + filters: + branches: + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + requires: + - deploy-snapshot-mac-arm64 + - deploy-snapshot-any + - + - test-snapshot-mac-x86_64: + filters: + branches: + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + requires: + - deploy-snapshot-mac-x86_64 + - deploy-snapshot-any + - + - test-snapshot-windows-x86_64: + filters: + branches: + only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + requires: + - deploy-snapshot-windows-x86_64 + - deploy-snapshot-any + + - test-snapshot-any: + filters: + branches: + only: [master] + requires: + - deploy-snapshot-any release: jobs: diff --git a/.factory/automation.yml b/.factory/automation.yml index 2d387aa9df..a7d0dbcbde 100644 --- a/.factory/automation.yml +++ b/.factory/automation.yml @@ -74,7 +74,7 @@ build: tool/docs/update.sh git add $DOCS_DIRS git diff --exit-code HEAD $DOCS_DIRS - +# TODO: Return tests before merging! # test-rust-unit-integration: # image: vaticle-ubuntu-20.04 # Ubuntu 20.04 has GLIBC version 2.31 (2020) which we should verify to compile against # dependencies: diff --git a/csharp/Test/Deployment/NugetApplicationTest.csproj b/csharp/Test/Deployment/NugetApplicationTest.csproj index ec36f9a9a8..323226a4d3 100644 --- a/csharp/Test/Deployment/NugetApplicationTest.csproj +++ b/csharp/Test/Deployment/NugetApplicationTest.csproj @@ -46,10 +46,10 @@ under the License. - - + + - + From 92784e30274b50159b18a01aae71a5914b769872 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 11:50:17 +0100 Subject: [PATCH 112/118] Fix config style --- .circleci/config.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 67f531b58c..de434641d4 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -799,7 +799,6 @@ jobs: apt install -y git git push --delete https://$REPO_GITHUB_TOKEN@github.com/vaticle/typedb-driver.git $CIRCLE_BRANCH - workflows: typedb-driver-snapshot: jobs: @@ -846,7 +845,7 @@ workflows: requires: - deploy-snapshot-linux-arm64 - deploy-snapshot-any - - + - test-snapshot-linux-x86_64: filters: branches: @@ -854,7 +853,7 @@ workflows: requires: - deploy-snapshot-linux-x86_64 - deploy-snapshot-any - - + - test-snapshot-mac-arm64: filters: branches: @@ -862,7 +861,7 @@ workflows: requires: - deploy-snapshot-mac-arm64 - deploy-snapshot-any - - + - test-snapshot-mac-x86_64: filters: branches: @@ -870,7 +869,7 @@ workflows: requires: - deploy-snapshot-mac-x86_64 - deploy-snapshot-any - - + - test-snapshot-windows-x86_64: filters: branches: From d6cdd18364e42fab03d3a423dce8f26c44ef4a2e Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 12:20:59 +0100 Subject: [PATCH 113/118] Fix windows runtime deployment scripts --- .circleci/windows/csharp/deploy_release.bat | 2 +- .circleci/windows/csharp/deploy_snapshot.bat | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.circleci/windows/csharp/deploy_release.bat b/.circleci/windows/csharp/deploy_release.bat index ac4e57aee2..5879c8fe8f 100644 --- a/.circleci/windows/csharp/deploy_release.bat +++ b/.circleci/windows/csharp/deploy_release.bat @@ -25,5 +25,5 @@ SET DEPLOY_NUGET_API_KEY=%REPO_TYPEDB_PASSWORD% @REM TODO: Add new key for nuget as a new variable! SET /p VER= version_snapshot.txt set /p VER= Date: Thu, 4 Apr 2024 12:21:48 +0100 Subject: [PATCH 114/118] Remove excessive spaces --- .circleci/config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index de434641d4..36fb24da4c 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -414,13 +414,13 @@ commands: steps: - run: | export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push --compilation_mode=opt -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push --compilation_mode=opt -- release deploy-dotnet-release-unix: steps: - run: | export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! - bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push --compilation_mode=opt -- release + bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push --compilation_mode=opt -- release ######################### # Rust deployment steps # From 3bc11e04954f7a8d73003f279f7089e48e606f3d Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 14:26:10 +0100 Subject: [PATCH 115/118] Add sleeps for the mac tests --- .circleci/config.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index 36fb24da4c..7c149a89f0 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -396,6 +396,7 @@ commands: steps: - run: | tool/test/start-core-server.sh + sleep 3 sed -i -e "s/DRIVER_CSHARP_VERSION_MARKER/0.0.0-$CIRCLE_SHA1/g" csharp/Test/Deployment/NugetApplicationTest.csproj cat csharp/Test/Deployment/NugetApplicationTest.csproj (cd csharp/Test/Deployment && dotnet run NugetApplicationTest.csproj) @@ -405,6 +406,7 @@ commands: steps: - run: | tool/test/start-core-server.sh + sleep 3 sed -i -e "s/DRIVER_CSHARP_VERSION_MARKER/0.0.0-$CIRCLE_SHA1/g" csharp/Test/Deployment/NugetApplicationTest.csproj cat csharp/Test/Deployment/NugetApplicationTest.csproj (cd csharp/Test/Deployment && /usr/local/bin/dotnet run NugetApplicationTest.csproj) From 6e6494047e207e606adab4955b53a3dc24dc16ce Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 14:47:21 +0100 Subject: [PATCH 116/118] Fix release config + fix issue #613 --- .circleci/config.yml | 4 ++++ python/typedb/api/concept/thing/thing.py | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 7c149a89f0..1a9300b343 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -697,6 +697,8 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix + + - install-libicu-linux - deploy-dotnet-runtime-release-unix deploy-release-linux-x86_64: @@ -709,6 +711,8 @@ jobs: - deploy-maven-jni-release-unix - deploy-clib-release-unix - deploy-cpp-release-unix + + - install-libicu-linux - deploy-dotnet-runtime-release-unix deploy-release-mac-arm64: diff --git a/python/typedb/api/concept/thing/thing.py b/python/typedb/api/concept/thing/thing.py index 49395db8f7..115fd23353 100644 --- a/python/typedb/api/concept/thing/thing.py +++ b/python/typedb/api/concept/thing/thing.py @@ -176,7 +176,7 @@ def get_has( pass @abstractmethod - def get_relations(self, transaction: TypeDBTransaction, role_types: list[RoleType] = None) -> Iterator[Relation]: + def get_relations(self, transaction: TypeDBTransaction, *role_types: RoleType) -> Iterator[Relation]: """ Retrieves all the ``Relation``\ s which this ``Thing`` plays a role in, optionally filtered by one or more given roles. From b40940d12ca9cfc82490c12ea11d53407ed7b46b Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 15:02:27 +0100 Subject: [PATCH 117/118] Fix docs for the updated method in python --- python/docs/data/Thing.adoc | 6 +++--- python/typedb/api/concept/thing/thing.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/python/docs/data/Thing.adoc b/python/docs/data/Thing.adoc index 5a26282d73..3635e10dd4 100644 --- a/python/docs/data/Thing.adoc +++ b/python/docs/data/Thing.adoc @@ -143,12 +143,12 @@ a| `transaction` a| The current transaction a| `TypeDBTransaction` a| thing.get_playing(transaction) ---- -[#_Thing_get_relations__transaction_TypeDBTransaction__role_types_list_RoleType_] +[#_Thing_get_relations__transaction_TypeDBTransaction__role_types_RoleType] ==== get_relations [source,python] ---- -get_relations(transaction: TypeDBTransaction, role_types: list[RoleType] = None) -> Iterator[Relation] +get_relations(transaction: TypeDBTransaction, *role_types: RoleType) -> Iterator[Relation] ---- Retrieves all the ``Relation``s which this ``Thing`` plays a role in, optionally filtered by one or more given roles. @@ -160,7 +160,7 @@ Retrieves all the ``Relation``s which this ``Thing`` plays a role in, optionally |=== |Name |Description |Type |Default Value a| `transaction` a| The current transaction a| `TypeDBTransaction` a| -a| `role_types` a| The list of roles to filter the relations by. a| `list[RoleType]` a| `None` +a| `role_types` a| 0 or more role types to filter the relations by. a| `RoleType` a| |=== [caption=""] diff --git a/python/typedb/api/concept/thing/thing.py b/python/typedb/api/concept/thing/thing.py index 115fd23353..eb376fec08 100644 --- a/python/typedb/api/concept/thing/thing.py +++ b/python/typedb/api/concept/thing/thing.py @@ -182,7 +182,7 @@ def get_relations(self, transaction: TypeDBTransaction, *role_types: RoleType) - optionally filtered by one or more given roles. :param transaction: The current transaction - :param role_types: The list of roles to filter the relations by. + :param role_types: 0 or more role types to filter the relations by. :return: From 035c7c3d6fdcf4314e31df80bdda8138e6361571 Mon Sep 17 00:00:00 2001 From: Georgii Novoselov Date: Thu, 4 Apr 2024 18:57:29 +0100 Subject: [PATCH 118/118] Return builds, fix comments and refs --- .circleci/config.yml | 176 ++-- .circleci/windows/csharp/deploy_release.bat | 3 +- .factory/automation.yml | 960 +++++++++--------- csharp/Api/BUILD | 4 - csharp/BUILD | 17 +- csharp/Common/BUILD | 3 - csharp/Concept/BUILD | 2 - csharp/Connection/BUILD | 2 - csharp/Logic/BUILD | 2 - csharp/Query/BUILD | 2 - csharp/README.md | 4 +- csharp/Test/BUILD | 1 - csharp/Test/Behaviour/BUILD | 1 - csharp/Test/Behaviour/Concept/BUILD | 1 - .../Behaviour/Concept/Thing/Attribute/BUILD | 4 - csharp/Test/Behaviour/Concept/Thing/BUILD | 2 - .../Test/Behaviour/Concept/Thing/Entity/BUILD | 4 - .../Behaviour/Concept/Thing/Relation/BUILD | 4 - .../Concept/Type/AttributeType/BUILD | 4 - .../Behaviour/Concept/Type/EntityType/BUILD | 3 - .../Behaviour/Concept/Type/RelationType/BUILD | 4 - .../Behaviour/Concept/Type/ThingType/BUILD | 2 - csharp/Test/Behaviour/Connection/BUILD | 3 - .../Test/Behaviour/Connection/Database/BUILD | 4 - .../Test/Behaviour/Connection/Session/BUILD | 4 - .../Behaviour/Connection/Transaction/BUILD | 4 - csharp/Test/Behaviour/Connection/User/BUILD | 3 - csharp/Test/Behaviour/Driver/BUILD | 1 - csharp/Test/Behaviour/Driver/Query/BUILD | 3 - csharp/Test/Behaviour/Query/BUILD | 2 - .../Behaviour/Query/Language/Define/BUILD | 3 - .../Behaviour/Query/Language/Delete/BUILD | 3 - .../Behaviour/Query/Language/Expression/BUILD | 3 - .../Test/Behaviour/Query/Language/Fetch/BUILD | 3 - .../Test/Behaviour/Query/Language/Get/BUILD | 3 - .../Behaviour/Query/Language/Insert/BUILD | 3 - .../Test/Behaviour/Query/Language/Match/BUILD | 3 - .../Behaviour/Query/Language/Modifiers/BUILD | 3 - .../Query/Language/RuleValidation/BUILD | 3 - .../Behaviour/Query/Language/Undefine/BUILD | 3 - .../Behaviour/Query/Language/Update/BUILD | 3 - .../Query/Reasoner/AttributeAttachment/BUILD | 3 - csharp/Test/Behaviour/Query/Reasoner/BUILD | 2 - .../Query/Reasoner/CompoundQueries/BUILD | 3 - .../Query/Reasoner/ConceptInequality/BUILD | 3 - .../Behaviour/Query/Reasoner/Negation/BUILD | 3 - .../Behaviour/Query/Reasoner/Recursion/BUILD | 3 - .../Query/Reasoner/RelationInference/BUILD | 3 - .../Query/Reasoner/RuleInteraction/BUILD | 3 - .../Query/Reasoner/SchemaQueries/BUILD | 3 - .../Query/Reasoner/TypeHierarchy/BUILD | 3 - .../Query/Reasoner/ValuePredicate/BUILD | 3 - .../Query/Reasoner/VariableRoles/BUILD | 3 - csharp/Test/Behaviour/Util/BUILD | 4 - csharp/Test/Deployment/BUILD | 1 - csharp/Test/Integration/BUILD | 1 - csharp/Test/Integration/Data/BUILD | 2 - csharp/Test/Integration/Examples/BUILD | 3 - csharp/Test/Integration/Marshal/BUILD | 2 - csharp/User/BUILD | 2 - csharp/nuget/BUILD | 1 - csharp/rules.bzl | 4 +- 62 files changed, 578 insertions(+), 739 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 1a9300b343..037e0d71df 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -415,13 +415,13 @@ commands: deploy-dotnet-runtime-release-unix: steps: - run: | - export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! + export DEPLOY_NUGET_API_KEY=$REPO_NUGET_TOKEN bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-runtime-push --compilation_mode=opt -- release deploy-dotnet-release-unix: steps: - run: | - export DEPLOY_NUGET_API_KEY=$REPO_TYPEDB_PASSWORD # TODO: Add new key for nuget as a new variable! + export DEPLOY_NUGET_API_KEY=$REPO_NUGET_TOKEN bazel run --jobs=8 --define version=$(cat VERSION) //csharp:driver-csharp-push --compilation_mode=opt -- release ######################### @@ -493,17 +493,17 @@ jobs: - install-bazel-yum: bazel-arch: arm64 -# - deploy-pip-snapshot-unix -# -# - deploy-maven-jni-snapshot-unix -# -# - deploy-clib-snapshot-unix -# - test-clib-assembly-linux: -# target-arch: arm64 -# -# - deploy-cpp-snapshot-unix -# - test-cpp-assembly-linux: -# target-arch: arm64 + - deploy-pip-snapshot-unix + + - deploy-maven-jni-snapshot-unix + + - deploy-clib-snapshot-unix + - test-clib-assembly-linux: + target-arch: arm64 + + - deploy-cpp-snapshot-unix + - test-cpp-assembly-linux: + target-arch: arm64 - install-libicu-linux - deploy-dotnet-runtime-snapshot-unix @@ -515,17 +515,17 @@ jobs: - install-bazel-yum: bazel-arch: amd64 -# - deploy-pip-snapshot-unix -# -# - deploy-maven-jni-snapshot-unix -# -# - deploy-clib-snapshot-unix -# - test-clib-assembly-linux: -# target-arch: x86_64 -# -# - deploy-cpp-snapshot-unix -# - test-cpp-assembly-linux: -# target-arch: x86_64 + - deploy-pip-snapshot-unix + + - deploy-maven-jni-snapshot-unix + + - deploy-clib-snapshot-unix + - test-clib-assembly-linux: + target-arch: x86_64 + + - deploy-cpp-snapshot-unix + - test-cpp-assembly-linux: + target-arch: x86_64 - install-libicu-linux - deploy-dotnet-runtime-snapshot-unix @@ -537,19 +537,19 @@ jobs: - install-bazel-brew: bazel-arch: arm64 -# - deploy-pip-snapshot-unix -# -# - deploy-maven-jni-snapshot-unix -# -# - run: brew install cmake -# -# - deploy-clib-snapshot-unix -# - test-clib-assembly-mac: -# target-arch: arm64 -# -# - deploy-cpp-snapshot-unix -# - test-cpp-assembly-mac: -# target-arch: arm64 + - deploy-pip-snapshot-unix + + - deploy-maven-jni-snapshot-unix + + - run: brew install cmake + + - deploy-clib-snapshot-unix + - test-clib-assembly-mac: + target-arch: arm64 + + - deploy-cpp-snapshot-unix + - test-cpp-assembly-mac: + target-arch: arm64 - deploy-dotnet-runtime-snapshot-unix @@ -561,19 +561,19 @@ jobs: - install-bazel-brew: bazel-arch: amd64 -# - deploy-pip-snapshot-unix -# -# - deploy-maven-jni-snapshot-unix -# -# - run: brew install cmake -# -# - deploy-clib-snapshot-unix -# - test-clib-assembly-mac: -# target-arch: x86_64 -# -# - deploy-cpp-snapshot-unix -# - test-cpp-assembly-mac: -# target-arch: x86_64 + - deploy-pip-snapshot-unix + + - deploy-maven-jni-snapshot-unix + + - run: brew install cmake + + - deploy-clib-snapshot-unix + - test-clib-assembly-mac: + target-arch: x86_64 + + - deploy-cpp-snapshot-unix + - test-cpp-assembly-mac: + target-arch: x86_64 - deploy-dotnet-runtime-snapshot-unix @@ -587,15 +587,15 @@ jobs: - checkout - run: .circleci\windows\prepare.bat -# - run: .circleci\windows\python\deploy_snapshot.bat -# -# - run: .circleci\windows\java\deploy_snapshot.bat -# -# - run: .circleci\windows\clib\deploy_snapshot.bat -# - run: .circleci\windows\clib\test_assembly.bat -# -# - run: .circleci\windows\cpp\deploy_snapshot.bat -# - run: .circleci\windows\cpp\test_assembly.bat + - run: .circleci\windows\python\deploy_snapshot.bat + + - run: .circleci\windows\java\deploy_snapshot.bat + + - run: .circleci\windows\clib\deploy_snapshot.bat + - run: .circleci\windows\clib\test_assembly.bat + + - run: .circleci\windows\cpp\deploy_snapshot.bat + - run: .circleci\windows\cpp\test_assembly.bat - run: .circleci\windows\csharp\deploy_snapshot.bat @@ -605,10 +605,10 @@ jobs: - checkout - install-bazel-apt: bazel-arch: amd64 -# - deploy-crate-snapshot-unix -# - deploy-maven-snapshot-unix -# - install-npm-apt -# - deploy-npm-snapshot-unix + - deploy-crate-snapshot-unix + - deploy-maven-snapshot-unix + - install-npm-apt + - deploy-npm-snapshot-unix - deploy-dotnet-snapshot-unix test-snapshot-linux-arm64: @@ -617,9 +617,9 @@ jobs: - checkout - install-bazel-yum: bazel-arch: arm64 -# - test-pip-snapshot-unix -# - install-maven-linux -# - test-maven-snapshot-unix + - test-pip-snapshot-unix + - install-maven-linux + - test-maven-snapshot-unix - install-dotnet-linux - install-libicu-linux - test-dotnet-snapshot-unix @@ -630,9 +630,9 @@ jobs: - checkout - install-bazel-yum: bazel-arch: amd64 -# - test-pip-snapshot-unix -# - install-maven-linux -# - test-maven-snapshot-unix + - test-pip-snapshot-unix + - install-maven-linux + - test-maven-snapshot-unix - install-dotnet-linux - test-dotnet-snapshot-unix @@ -642,9 +642,9 @@ jobs: - checkout - install-bazel-brew: bazel-arch: arm64 -# - test-pip-snapshot-unix -# - install-maven-mac -# - test-maven-snapshot-unix + - test-pip-snapshot-unix + - install-maven-mac + - test-maven-snapshot-unix - install-dotnet-mac - test-dotnet-snapshot-unix @@ -655,9 +655,9 @@ jobs: - checkout - install-bazel-brew: bazel-arch: amd64 -# - test-pip-snapshot-mac-rosetta -# - install-maven-mac-rosetta -# - test-maven-snapshot-mac-rosetta + - test-pip-snapshot-mac-rosetta + - install-maven-mac-rosetta + - test-maven-snapshot-mac-rosetta - install-dotnet-mac-rosetta - test-dotnet-snapshot-mac-rosetta @@ -670,8 +670,8 @@ jobs: steps: - checkout - run: .circleci\windows\prepare.bat -# - run: .circleci\windows\python\test_deploy_snapshot.bat -# - run: .circleci\windows\java\test_deploy_snapshot.bat + - run: .circleci\windows\python\test_deploy_snapshot.bat + - run: .circleci\windows\java\test_deploy_snapshot.bat - run: .circleci\windows\csharp\test_deploy_snapshot.bat test-snapshot-any: @@ -811,32 +811,32 @@ workflows: - deploy-snapshot-linux-arm64: filters: branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + only: [development, master] - deploy-snapshot-linux-x86_64: filters: branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + only: [development, master] - deploy-snapshot-mac-arm64: filters: branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + only: [development, master] - deploy-snapshot-mac-x86_64: filters: branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + only: [development, master] - deploy-snapshot-windows-x86_64: filters: branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + only: [development, master] - deploy-snapshot-any: filters: branches: - only: [development, master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + only: [development, master] requires: - deploy-snapshot-linux-arm64 - deploy-snapshot-linux-x86_64 @@ -847,7 +847,7 @@ workflows: - test-snapshot-linux-arm64: filters: branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + only: [master] requires: - deploy-snapshot-linux-arm64 - deploy-snapshot-any @@ -855,7 +855,7 @@ workflows: - test-snapshot-linux-x86_64: filters: branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + only: [master] requires: - deploy-snapshot-linux-x86_64 - deploy-snapshot-any @@ -863,7 +863,7 @@ workflows: - test-snapshot-mac-arm64: filters: branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + only: [master] requires: - deploy-snapshot-mac-arm64 - deploy-snapshot-any @@ -871,7 +871,7 @@ workflows: - test-snapshot-mac-x86_64: filters: branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + only: [master] requires: - deploy-snapshot-mac-x86_64 - deploy-snapshot-any @@ -879,7 +879,7 @@ workflows: - test-snapshot-windows-x86_64: filters: branches: - only: [master, csharp-docs-deployment] # TODO: Remove csharp-docs-deployment + only: [master] requires: - deploy-snapshot-windows-x86_64 - deploy-snapshot-any diff --git a/.circleci/windows/csharp/deploy_release.bat b/.circleci/windows/csharp/deploy_release.bat index 5879c8fe8f..0071cbcbcf 100644 --- a/.circleci/windows/csharp/deploy_release.bat +++ b/.circleci/windows/csharp/deploy_release.bat @@ -21,8 +21,7 @@ REM by Chocolatey in prepare.bat is accessible CALL refreshenv ECHO Building and deploying windows package... -SET DEPLOY_NUGET_API_KEY=%REPO_TYPEDB_PASSWORD% -@REM TODO: Add new key for nuget as a new variable! +SET DEPLOY_NUGET_API_KEY=%REPO_NUGET_TOKEN% SET /p VER= + + - -... ``` See [Examples](#examples) and [API Reference](#api-reference) to set up your first application with the TypeDB driver. diff --git a/csharp/Test/BUILD b/csharp/Test/BUILD index 1167e95f85..fa074942a8 100644 --- a/csharp/Test/BUILD +++ b/csharp/Test/BUILD @@ -17,7 +17,6 @@ load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/BUILD b/csharp/Test/Behaviour/BUILD index 1167e95f85..fa074942a8 100644 --- a/csharp/Test/Behaviour/BUILD +++ b/csharp/Test/Behaviour/BUILD @@ -17,7 +17,6 @@ load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Concept/BUILD b/csharp/Test/Behaviour/Concept/BUILD index 1167e95f85..fa074942a8 100644 --- a/csharp/Test/Behaviour/Concept/BUILD +++ b/csharp/Test/Behaviour/Concept/BUILD @@ -17,7 +17,6 @@ load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Concept/Thing/Attribute/BUILD b/csharp/Test/Behaviour/Concept/Thing/Attribute/BUILD index 2b96ccdcc5..67342cc6dc 100644 --- a/csharp/Test/Behaviour/Concept/Thing/Attribute/BUILD +++ b/csharp/Test/Behaviour/Concept/Thing/Attribute/BUILD @@ -22,14 +22,12 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["AttributeSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - csharp_behaviour_test( name = "test-core", test_files = ["AttributeTest.cs"], @@ -55,7 +53,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["AttributeTest.cs"], @@ -82,7 +79,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Concept/Thing/BUILD b/csharp/Test/Behaviour/Concept/Thing/BUILD index ed5cae0213..45a337bfef 100644 --- a/csharp/Test/Behaviour/Concept/Thing/BUILD +++ b/csharp/Test/Behaviour/Concept/Thing/BUILD @@ -20,14 +20,12 @@ package(default_visibility = ["//csharp/Test/Behaviour:__subpackages__"]) load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["ThingSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Concept/Thing/Entity/BUILD b/csharp/Test/Behaviour/Concept/Thing/Entity/BUILD index 72e299cf97..62d7ce2e32 100644 --- a/csharp/Test/Behaviour/Concept/Thing/Entity/BUILD +++ b/csharp/Test/Behaviour/Concept/Thing/Entity/BUILD @@ -22,14 +22,12 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["EntitySteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - csharp_behaviour_test( name = "test-core", test_files = ["EntityTest.cs"], @@ -56,7 +54,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["EntityTest.cs"], @@ -84,7 +81,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Concept/Thing/Relation/BUILD b/csharp/Test/Behaviour/Concept/Thing/Relation/BUILD index 4918d11ae4..8242e7f324 100644 --- a/csharp/Test/Behaviour/Concept/Thing/Relation/BUILD +++ b/csharp/Test/Behaviour/Concept/Thing/Relation/BUILD @@ -22,14 +22,12 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["RelationSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - csharp_behaviour_test( name = "test-core", test_files = ["RelationTest.cs"], @@ -58,7 +56,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["RelationTest.cs"], @@ -88,7 +85,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Concept/Type/AttributeType/BUILD b/csharp/Test/Behaviour/Concept/Type/AttributeType/BUILD index da14ba5ecb..d6cb81e5e4 100644 --- a/csharp/Test/Behaviour/Concept/Type/AttributeType/BUILD +++ b/csharp/Test/Behaviour/Concept/Type/AttributeType/BUILD @@ -22,14 +22,12 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["AttributeTypeSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - csharp_behaviour_test( name = "test-core", test_files = ["AttributeTypeTest.cs"], @@ -55,7 +53,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["AttributeTypeTest.cs"], @@ -82,7 +79,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Concept/Type/EntityType/BUILD b/csharp/Test/Behaviour/Concept/Type/EntityType/BUILD index ece6a6fac9..0fa8f8011e 100644 --- a/csharp/Test/Behaviour/Concept/Type/EntityType/BUILD +++ b/csharp/Test/Behaviour/Concept/Type/EntityType/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["EntityTypeTest.cs"], @@ -51,7 +50,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["EntityTypeTest.cs"], @@ -81,7 +79,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Concept/Type/RelationType/BUILD b/csharp/Test/Behaviour/Concept/Type/RelationType/BUILD index fa47118ffb..1988da08ca 100644 --- a/csharp/Test/Behaviour/Concept/Type/RelationType/BUILD +++ b/csharp/Test/Behaviour/Concept/Type/RelationType/BUILD @@ -22,14 +22,12 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["RelationTypeSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - csharp_behaviour_test( name = "test-core", test_files = ["RelationTypeTest.cs"], @@ -57,7 +55,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["RelationTypeTest.cs"], @@ -86,7 +83,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Concept/Type/ThingType/BUILD b/csharp/Test/Behaviour/Concept/Type/ThingType/BUILD index 64314f073d..250d2e6455 100644 --- a/csharp/Test/Behaviour/Concept/Type/ThingType/BUILD +++ b/csharp/Test/Behaviour/Concept/Type/ThingType/BUILD @@ -20,14 +20,12 @@ package(default_visibility = ["//csharp/Test/Behaviour:__subpackages__"]) load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["ThingTypeSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Connection/BUILD b/csharp/Test/Behaviour/Connection/BUILD index 60d403e805..0eda0948b3 100644 --- a/csharp/Test/Behaviour/Connection/BUILD +++ b/csharp/Test/Behaviour/Connection/BUILD @@ -21,21 +21,18 @@ load("//csharp:build_opts.bzl", "nullable_context", "target_frameworks", "target load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps-core", srcs = ["ConnectionStepsBase.cs", "ConnectionStepsCore.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - filegroup( name = "steps-cloud", srcs = ["ConnectionStepsBase.cs", "ConnectionStepsCloud.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Connection/Database/BUILD b/csharp/Test/Behaviour/Connection/Database/BUILD index 382edebbe7..52bbb4eecb 100644 --- a/csharp/Test/Behaviour/Connection/Database/BUILD +++ b/csharp/Test/Behaviour/Connection/Database/BUILD @@ -22,14 +22,12 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["DatabaseSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - csharp_behaviour_test( name = "test-core", test_files = ["DatabaseTest.cs"], @@ -47,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["DatabaseTest.cs"], @@ -66,7 +63,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Connection/Session/BUILD b/csharp/Test/Behaviour/Connection/Session/BUILD index 644929475c..bfde078ea6 100644 --- a/csharp/Test/Behaviour/Connection/Session/BUILD +++ b/csharp/Test/Behaviour/Connection/Session/BUILD @@ -21,14 +21,12 @@ load("//csharp:build_opts.bzl", "nullable_context", "target_frameworks", "target load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["SessionSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - csharp_behaviour_test( name = "test-core", test_files = ["SessionTest.cs"], @@ -51,7 +49,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["SessionTest.cs"], @@ -75,7 +72,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Connection/Transaction/BUILD b/csharp/Test/Behaviour/Connection/Transaction/BUILD index 4d688ed778..7878c7098f 100644 --- a/csharp/Test/Behaviour/Connection/Transaction/BUILD +++ b/csharp/Test/Behaviour/Connection/Transaction/BUILD @@ -21,14 +21,12 @@ load("//csharp:build_opts.bzl", "nullable_context", "target_frameworks", "target load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["TransactionSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - csharp_behaviour_test( name = "test-core", test_files = ["TransactionTest.cs"], @@ -52,7 +50,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["TransactionTest.cs"], @@ -77,7 +74,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Connection/User/BUILD b/csharp/Test/Behaviour/Connection/User/BUILD index 000159b4e5..d02110eca7 100644 --- a/csharp/Test/Behaviour/Connection/User/BUILD +++ b/csharp/Test/Behaviour/Connection/User/BUILD @@ -22,14 +22,12 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["UserSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - csharp_behaviour_test( name = "test-cloud", test_files = ["UserTest.cs"], @@ -54,7 +52,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Driver/BUILD b/csharp/Test/Behaviour/Driver/BUILD index cba912ca3b..ce0fb809be 100644 --- a/csharp/Test/Behaviour/Driver/BUILD +++ b/csharp/Test/Behaviour/Driver/BUILD @@ -19,7 +19,6 @@ package(default_visibility = ["//csharp/Test/Behaviour/Driver:__subpackages__"]) load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Driver/Query/BUILD b/csharp/Test/Behaviour/Driver/Query/BUILD index b3ee2d101c..af4d23b450 100644 --- a/csharp/Test/Behaviour/Driver/Query/BUILD +++ b/csharp/Test/Behaviour/Driver/Query/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["QueryTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["QueryTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/BUILD b/csharp/Test/Behaviour/Query/BUILD index 72f43a03c2..24f67ea720 100644 --- a/csharp/Test/Behaviour/Query/BUILD +++ b/csharp/Test/Behaviour/Query/BUILD @@ -20,14 +20,12 @@ package(default_visibility = ["//csharp/Test/Behaviour:__subpackages__"]) load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["QuerySteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Language/Define/BUILD b/csharp/Test/Behaviour/Query/Language/Define/BUILD index be83cfe9c7..ba61f33463 100644 --- a/csharp/Test/Behaviour/Query/Language/Define/BUILD +++ b/csharp/Test/Behaviour/Query/Language/Define/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["DefineTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["DefineTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Language/Delete/BUILD b/csharp/Test/Behaviour/Query/Language/Delete/BUILD index 5876a8bdfa..3bee7715ee 100644 --- a/csharp/Test/Behaviour/Query/Language/Delete/BUILD +++ b/csharp/Test/Behaviour/Query/Language/Delete/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["DeleteTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["DeleteTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Language/Expression/BUILD b/csharp/Test/Behaviour/Query/Language/Expression/BUILD index c25b2cccaa..3737c42626 100644 --- a/csharp/Test/Behaviour/Query/Language/Expression/BUILD +++ b/csharp/Test/Behaviour/Query/Language/Expression/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["ExpressionTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["ExpressionTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Language/Fetch/BUILD b/csharp/Test/Behaviour/Query/Language/Fetch/BUILD index 23f87881f9..23f31cafb8 100644 --- a/csharp/Test/Behaviour/Query/Language/Fetch/BUILD +++ b/csharp/Test/Behaviour/Query/Language/Fetch/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["FetchTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["FetchTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Language/Get/BUILD b/csharp/Test/Behaviour/Query/Language/Get/BUILD index 824e3baf4b..2554e979d6 100644 --- a/csharp/Test/Behaviour/Query/Language/Get/BUILD +++ b/csharp/Test/Behaviour/Query/Language/Get/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["GetTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["GetTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Language/Insert/BUILD b/csharp/Test/Behaviour/Query/Language/Insert/BUILD index 08b572dcbe..eb17cc35bf 100644 --- a/csharp/Test/Behaviour/Query/Language/Insert/BUILD +++ b/csharp/Test/Behaviour/Query/Language/Insert/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["InsertTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["InsertTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Language/Match/BUILD b/csharp/Test/Behaviour/Query/Language/Match/BUILD index 75dc37e1b4..9141bcfc3d 100644 --- a/csharp/Test/Behaviour/Query/Language/Match/BUILD +++ b/csharp/Test/Behaviour/Query/Language/Match/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["MatchTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["MatchTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Language/Modifiers/BUILD b/csharp/Test/Behaviour/Query/Language/Modifiers/BUILD index 5312efd605..7117aca9f1 100644 --- a/csharp/Test/Behaviour/Query/Language/Modifiers/BUILD +++ b/csharp/Test/Behaviour/Query/Language/Modifiers/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["ModifiersTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["ModifiersTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Language/RuleValidation/BUILD b/csharp/Test/Behaviour/Query/Language/RuleValidation/BUILD index 26fa7acd3d..e7821cdb16 100644 --- a/csharp/Test/Behaviour/Query/Language/RuleValidation/BUILD +++ b/csharp/Test/Behaviour/Query/Language/RuleValidation/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["RuleValidationTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["RuleValidationTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Language/Undefine/BUILD b/csharp/Test/Behaviour/Query/Language/Undefine/BUILD index 068553c0f6..94610db73b 100644 --- a/csharp/Test/Behaviour/Query/Language/Undefine/BUILD +++ b/csharp/Test/Behaviour/Query/Language/Undefine/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["UndefineTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["UndefineTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Language/Update/BUILD b/csharp/Test/Behaviour/Query/Language/Update/BUILD index fbb252d73f..8b567fa01c 100644 --- a/csharp/Test/Behaviour/Query/Language/Update/BUILD +++ b/csharp/Test/Behaviour/Query/Language/Update/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["UpdateTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["UpdateTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/AttributeAttachment/BUILD b/csharp/Test/Behaviour/Query/Reasoner/AttributeAttachment/BUILD index 7c68eba374..c520b33cac 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/AttributeAttachment/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/AttributeAttachment/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["AttributeAttachmentTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["AttributeAttachmentTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/BUILD b/csharp/Test/Behaviour/Query/Reasoner/BUILD index 7f2012fe3d..6f327fdf49 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/BUILD @@ -20,14 +20,12 @@ package(default_visibility = ["//csharp/Test/Behaviour:__subpackages__"]) load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - filegroup( name = "steps", srcs = ["ReasonerSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/CompoundQueries/BUILD b/csharp/Test/Behaviour/Query/Reasoner/CompoundQueries/BUILD index 532c2eec52..02a88489fd 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/CompoundQueries/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/CompoundQueries/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["CompoundQueriesTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["CompoundQueriesTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/ConceptInequality/BUILD b/csharp/Test/Behaviour/Query/Reasoner/ConceptInequality/BUILD index 59171f0f4a..32ee557bf8 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/ConceptInequality/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/ConceptInequality/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["ConceptInequalityTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["ConceptInequalityTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/Negation/BUILD b/csharp/Test/Behaviour/Query/Reasoner/Negation/BUILD index 59147dea31..511e28be77 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/Negation/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/Negation/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["NegationTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["NegationTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/Recursion/BUILD b/csharp/Test/Behaviour/Query/Reasoner/Recursion/BUILD index 69aa99ff85..a0b6b9d9a0 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/Recursion/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/Recursion/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["RecursionTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["RecursionTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/RelationInference/BUILD b/csharp/Test/Behaviour/Query/Reasoner/RelationInference/BUILD index e2d3a951cf..1e08e5ae07 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/RelationInference/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/RelationInference/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["RelationInferenceTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["RelationInferenceTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/RuleInteraction/BUILD b/csharp/Test/Behaviour/Query/Reasoner/RuleInteraction/BUILD index 5575037ffe..11e3b60aa5 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/RuleInteraction/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/RuleInteraction/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["RuleInteractionTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["RuleInteractionTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/SchemaQueries/BUILD b/csharp/Test/Behaviour/Query/Reasoner/SchemaQueries/BUILD index 5879543fc3..cea814ab4c 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/SchemaQueries/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/SchemaQueries/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["SchemaQueriesTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["SchemaQueriesTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/TypeHierarchy/BUILD b/csharp/Test/Behaviour/Query/Reasoner/TypeHierarchy/BUILD index a9b11e96bd..b4c460acd9 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/TypeHierarchy/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/TypeHierarchy/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["TypeHierarchyTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["TypeHierarchyTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/ValuePredicate/BUILD b/csharp/Test/Behaviour/Query/Reasoner/ValuePredicate/BUILD index cb889894fa..431e509852 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/ValuePredicate/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/ValuePredicate/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["ValuePredicateTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["ValuePredicateTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Query/Reasoner/VariableRoles/BUILD b/csharp/Test/Behaviour/Query/Reasoner/VariableRoles/BUILD index c80ec42bf2..93f77fa13a 100644 --- a/csharp/Test/Behaviour/Query/Reasoner/VariableRoles/BUILD +++ b/csharp/Test/Behaviour/Query/Reasoner/VariableRoles/BUILD @@ -22,7 +22,6 @@ load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") load("//csharp/Test:rules.bzl", "csharp_behaviour_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_behaviour_test( name = "test-core", test_files = ["VariableRolesTest.cs"], @@ -46,7 +45,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - csharp_behaviour_test( name = "test-cloud", test_files = ["VariableRolesTest.cs"], @@ -71,7 +69,6 @@ csharp_behaviour_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Behaviour/Util/BUILD b/csharp/Test/Behaviour/Util/BUILD index d810cede4a..25fe6d2c31 100644 --- a/csharp/Test/Behaviour/Util/BUILD +++ b/csharp/Test/Behaviour/Util/BUILD @@ -22,7 +22,6 @@ load("@rules_dotnet//dotnet:defs.bzl", "csharp_library") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") load("//csharp/Test:build_opts.bzl", "behaviour_tests_deps") - csharp_library( name = "util", srcs = glob(["*.cs"]), @@ -33,20 +32,17 @@ csharp_library( targeting_packs = targeting_packs, ) - exports_files( ["TestRunner.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - filegroup( name = "steps", srcs = ["UtilSteps.cs"], visibility = ["//csharp/Test/Behaviour:__subpackages__"], ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Deployment/BUILD b/csharp/Test/Deployment/BUILD index 1167e95f85..fa074942a8 100644 --- a/csharp/Test/Deployment/BUILD +++ b/csharp/Test/Deployment/BUILD @@ -17,7 +17,6 @@ load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Integration/BUILD b/csharp/Test/Integration/BUILD index 1167e95f85..fa074942a8 100644 --- a/csharp/Test/Integration/BUILD +++ b/csharp/Test/Integration/BUILD @@ -17,7 +17,6 @@ load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Integration/Data/BUILD b/csharp/Test/Integration/Data/BUILD index 812cbfe98a..7eaef35569 100644 --- a/csharp/Test/Integration/Data/BUILD +++ b/csharp/Test/Integration/Data/BUILD @@ -19,7 +19,6 @@ load("//csharp:build_opts.bzl", "nullable_context", "target_frameworks", "target load("//csharp/Test:rules.bzl", "csharp_integration_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_integration_test( name = "test", srcs = ["DataTest.cs"], @@ -33,7 +32,6 @@ csharp_integration_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Integration/Examples/BUILD b/csharp/Test/Integration/Examples/BUILD index c5faae655f..8dfd6b0efd 100644 --- a/csharp/Test/Integration/Examples/BUILD +++ b/csharp/Test/Integration/Examples/BUILD @@ -19,7 +19,6 @@ load("//csharp:build_opts.bzl", "nullable_context", "target_frameworks", "target load("//csharp/Test:rules.bzl", "csharp_integration_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_integration_test( name = "test-core", srcs = ["CoreExamplesTest.cs"], @@ -32,7 +31,6 @@ csharp_integration_test( targeting_packs = targeting_packs, ) - csharp_integration_test( name = "test-cloud", srcs = ["CloudExamplesTest.cs"], @@ -45,7 +43,6 @@ csharp_integration_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/Test/Integration/Marshal/BUILD b/csharp/Test/Integration/Marshal/BUILD index ebd9e6a1a3..674e805138 100644 --- a/csharp/Test/Integration/Marshal/BUILD +++ b/csharp/Test/Integration/Marshal/BUILD @@ -19,7 +19,6 @@ load("//csharp:build_opts.bzl", "nullable_context", "target_frameworks", "target load("//csharp/Test:rules.bzl", "csharp_integration_test") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_integration_test( name = "test", srcs = ["MarshalTest.cs"], @@ -32,7 +31,6 @@ csharp_integration_test( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/User/BUILD b/csharp/User/BUILD index 0633c46f7c..005264f4b3 100644 --- a/csharp/User/BUILD +++ b/csharp/User/BUILD @@ -21,7 +21,6 @@ load("@rules_dotnet//dotnet:defs.bzl", "csharp_library") load("//csharp:build_opts.bzl", "target_frameworks", "targeting_packs", "nullable_context") load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - csharp_library( name = "user", srcs = glob(["*.cs"], exclude=["test/**"]), @@ -36,7 +35,6 @@ csharp_library( targeting_packs = targeting_packs, ) - checkstyle_test( name = "checkstyle", include = glob(["*", "*/*"]), diff --git a/csharp/nuget/BUILD b/csharp/nuget/BUILD index 6f4de1bdeb..184e6ae3f9 100644 --- a/csharp/nuget/BUILD +++ b/csharp/nuget/BUILD @@ -17,7 +17,6 @@ load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") - checkstyle_test( name = "checkstyle", include = glob(["*"]), diff --git a/csharp/rules.bzl b/csharp/rules.bzl index dfedfd4c04..1cb6856254 100644 --- a/csharp/rules.bzl +++ b/csharp/rules.bzl @@ -18,7 +18,6 @@ load("@vaticle_dependencies//builder/swig:csharp.bzl", "swig_csharp") load("@vaticle_bazel_distribution//nuget:rules.bzl", "nuget_pack") - def swig_native_csharp_library(name, native_lib_name, namespace, nullable_context, target_frameworks, targeting_packs, visibility, tags=[], **kwargs): swig_csharp( name = "__" + name, @@ -37,9 +36,8 @@ def swig_native_csharp_library(name, native_lib_name, namespace, nullable_contex visibility = visibility, ) - def swig_native_nuget_pack(name, id, libs, native_libs, target_framework, nuspec_template, platforms, visibility, files={}, **kwargs): - # generate identical libraries with different maven coordinate tags, since we can't 'select' tags + # generate identical libraries with different platform names, since we can't 'select' it for platform in platforms.values(): nuget_pack( name = "_{}_as_{}_do_not_reference".format(name, platform),