├── VERSION ├── .bazelversion ├── http-ts ├── .npmrc ├── tool │ └── typedoc │ │ └── typedoc.json ├── tsup.config.ts └── tests │ └── behaviour │ └── README.md ├── docs ├── antora.yml ├── package-structure.png └── modules │ └── ROOT │ └── partials │ ├── rust │ ├── errors │ │ ├── DurationParseError.adoc │ │ ├── ServerError.adoc │ │ ├── AnalyzeError.adoc │ │ ├── ConceptError.adoc │ │ ├── InternalError.adoc │ │ ├── MigrationError.adoc │ │ └── Error.adoc │ ├── value │ │ ├── Struct.adoc │ │ ├── TimeZone.adoc │ │ ├── Offset.adoc │ │ └── Duration.adoc │ ├── answer │ │ ├── Node.adoc │ │ ├── Leaf.adoc │ │ ├── JSON.adoc │ │ ├── QueryType.adoc │ │ ├── ConceptDocumentHeader.adoc │ │ ├── ConceptRowHeader.adoc │ │ ├── Trait_Promise.adoc │ │ └── ConceptDocument.adoc │ ├── concept │ │ ├── Type.adoc │ │ ├── ConceptCategory.adoc │ │ └── Kind.adoc │ ├── analyze │ │ ├── Fetch.adoc │ │ ├── SortOrder.adoc │ │ ├── ReturnOperation.adoc │ │ ├── VariableAnnotations.adoc │ │ ├── ConstraintWithSpan.adoc │ │ ├── TypeAnnotations.adoc │ │ ├── VariableInfo.adoc │ │ ├── FetchLeaf.adoc │ │ ├── PipelineStage.adoc │ │ ├── SortVariable.adoc │ │ ├── ReduceAssignment.adoc │ │ ├── NamedRole.adoc │ │ ├── ConstraintExactness.adoc │ │ ├── ConjunctionID.adoc │ │ ├── ConstraintSpan.adoc │ │ ├── Reducer.adoc │ │ ├── Variable.adoc │ │ ├── ConstraintVertex.adoc │ │ ├── Constraint.adoc │ │ ├── Conjunction.adoc │ │ ├── Comparator.adoc │ │ ├── AnalyzedQuery.adoc │ │ └── Function.adoc │ ├── transaction │ │ └── TransactionType.adoc │ ├── schema │ │ ├── ValueType.adoc │ │ └── EntityType.adoc │ ├── connection │ │ └── ReplicaInfo.adoc │ └── data │ │ ├── Attribute.adoc │ │ └── Relation.adoc │ ├── http-ts │ ├── concept │ │ ├── Type.adoc │ │ ├── ValueKind.adoc │ │ ├── ConceptDocument.adoc │ │ ├── Concept.adoc │ │ ├── ThingKind.adoc │ │ ├── TypeKind.adoc │ │ ├── InstantiableType.adoc │ │ ├── RoleType.adoc │ │ ├── EdgeKind.adoc │ │ ├── EntityType.adoc │ │ ├── ValueType.adoc │ │ ├── RelationType.adoc │ │ ├── Entity.adoc │ │ ├── Value.adoc │ │ ├── Relation.adoc │ │ ├── AttributeType.adoc │ │ └── Attribute.adoc │ ├── analyze │ │ ├── VariableId.adoc │ │ ├── FunctionSingleReturnSelector.adoc │ │ ├── FetchAnnotationFieldEntry.adoc │ │ ├── VariableInfo.adoc │ │ ├── AnalyzeOptions.adoc │ │ ├── ConstraintVertexAny.adoc │ │ ├── Reducer.adoc │ │ ├── ConstraintOr.adoc │ │ ├── AnalyzedFetch.adoc │ │ ├── ConstraintNot.adoc │ │ ├── ConstraintSpan.adoc │ │ ├── ConstraintTry.adoc │ │ ├── ConjunctionAnnotations.adoc │ │ ├── ConstraintVertexLabel.adoc │ │ ├── ConstraintVertexVariable.adoc │ │ ├── VariableAnnotations.adoc │ │ ├── AnalyzedConjunction.adoc │ │ ├── ConstraintVertexNamedRole.adoc │ │ ├── ConstraintIid.adoc │ │ ├── ConstraintKind.adoc │ │ ├── ConstraintVertexValue.adoc │ │ ├── ConstraintLabel.adoc │ │ ├── ConstraintIs.adoc │ │ ├── AnalyzedPipeline.adoc │ │ ├── ConstraintHas.adoc │ │ ├── ConstraintIsa.adoc │ │ ├── ConstraintSub.adoc │ │ ├── ConstraintValue.adoc │ │ ├── FunctionReturnStructure.adoc │ │ ├── ConstraintOwns.adoc │ │ ├── ConstraintPlays.adoc │ │ ├── ConstraintIsaExact.adoc │ │ ├── ConstraintRelates.adoc │ │ ├── ConstraintSubExact.adoc │ │ ├── ConstraintComparison.adoc │ │ ├── ConstraintLinks.adoc │ │ ├── ConstraintExpression.adoc │ │ ├── ConstraintFunction.adoc │ │ ├── AnalyzedFunction.adoc │ │ ├── ConstraintAny.adoc │ │ ├── analyzeStaticFunctions.adoc │ │ └── PipelineStage.adoc │ ├── response │ │ ├── Answer.adoc │ │ ├── QueryType.adoc │ │ ├── AnswerType.adoc │ │ ├── Distribution.adoc │ │ ├── ApiResponse.adoc │ │ ├── QueryResponse.adoc │ │ ├── ConceptRow.adoc │ │ ├── SignInResponse.adoc │ │ ├── UsersListResponse.adoc │ │ ├── ApiOkResponse.adoc │ │ ├── ApiError.adoc │ │ ├── DatabasesListResponse.adoc │ │ ├── TransactionOpenResponse.adoc │ │ ├── ApiErrorResponse.adoc │ │ ├── ConceptRowAnswer.adoc │ │ ├── VersionResponse.adoc │ │ ├── QueryOptions.adoc │ │ ├── OkQueryResponse.adoc │ │ ├── AnalyzeResponse.adoc │ │ ├── QueryResponseBase.adoc │ │ ├── ConceptRowsQueryResponse.adoc │ │ └── ConceptDocumentsQueryResponse.adoc │ ├── connection │ │ ├── TransactionType.adoc │ │ ├── DriverParams.adoc │ │ ├── User.adoc │ │ ├── Database.adoc │ │ ├── TranslatedAddress.adoc │ │ ├── DriverParamsBasic.adoc │ │ ├── TransactionOptions.adoc │ │ └── DriverParamsTranslated.adoc │ └── legacy │ │ ├── QueryConjunctionLegacy.adoc │ │ ├── QueryStructureLegacy.adoc │ │ ├── ConstraintLinksLegacy.adoc │ │ ├── ConceptRowsQueryResponseLegacy.adoc │ │ ├── ConstraintExpressionLegacy.adoc │ │ └── legacyStaticFunctions.adoc │ ├── python │ ├── analyze │ │ ├── ReturnOperationCheck.adoc │ │ ├── DistinctStage.adoc │ │ ├── SortOrder.adoc │ │ ├── ConstraintExactness.adoc │ │ ├── FetchList.adoc │ │ ├── LimitStage.adoc │ │ ├── PutStage.adoc │ │ ├── OffsetStage.adoc │ │ ├── InsertStage.adoc │ │ ├── UpdateStage.adoc │ │ ├── Not.adoc │ │ ├── Try.adoc │ │ ├── MatchStage.adoc │ │ ├── SelectStage.adoc │ │ ├── SortStage.adoc │ │ ├── RequireStage.adoc │ │ ├── ReturnOperationStream.adoc │ │ ├── ReturnOperationReduce.adoc │ │ ├── FetchLeaf.adoc │ │ ├── Or.adoc │ │ ├── Span.adoc │ │ ├── SortVariable.adoc │ │ ├── Iid.adoc │ │ ├── Is.adoc │ │ ├── ReduceAssignment.adoc │ │ ├── Label.adoc │ │ ├── Kind.adoc │ │ ├── Value.adoc │ │ ├── FetchObject.adoc │ │ ├── Reducer.adoc │ │ ├── Comparator.adoc │ │ ├── DeleteStage.adoc │ │ ├── ReturnOperationSingle.adoc │ │ ├── ReduceStage.adoc │ │ ├── Isa.adoc │ │ ├── Has.adoc │ │ ├── Plays.adoc │ │ ├── Comparison.adoc │ │ ├── Owns.adoc │ │ ├── Sub.adoc │ │ ├── Relates.adoc │ │ ├── Expression.adoc │ │ ├── NamedRole.adoc │ │ └── FunctionCall.adoc │ ├── connection │ │ ├── Credentials.adoc │ │ ├── DriverOptions.adoc │ │ └── TypeDB.adoc │ ├── errors │ │ └── TypeDBDriverException.adoc │ ├── schema │ │ ├── Type.adoc │ │ └── EntityType.adoc │ └── answer │ │ ├── Promise.adoc │ │ └── OkQueryAnswer.adoc │ ├── java │ ├── analyze │ │ ├── PipelineStage.DistinctStage.adoc │ │ ├── Function.ReturnOperation.Check.adoc │ │ ├── Fetch.FetchList.adoc │ │ ├── Fetch.FetchLeaf.adoc │ │ ├── Constraint.Span.adoc │ │ ├── Fetch.FetchObject.adoc │ │ ├── Reducer.adoc │ │ ├── PipelineStage.ReduceStage.ReduceAssignment.adoc │ │ ├── PipelineStage.SortStage.SortVariable.adoc │ │ ├── NamedRole.adoc │ │ └── AnalyzedQuery.adoc │ ├── errors │ │ └── TypeDBDriverException.adoc │ └── connection │ │ └── Credentials.adoc │ ├── c │ ├── concept │ │ └── entity.adoc │ └── schema │ │ ├── transitivity.adoc │ │ └── valuetype.adoc │ ├── cpp │ ├── concept │ │ ├── Transitivity.adoc │ │ └── ConceptType.adoc │ ├── schema │ │ └── ValueType.adoc │ ├── answer │ │ ├── JSONType.adoc │ │ ├── Iterator.adoc │ │ ├── OwnerAttributePair.adoc │ │ ├── Future.adoc │ │ └── Explainable.adoc │ ├── session │ │ └── SessionType.adoc │ ├── transaction │ │ └── TransactionType.adoc │ └── data │ │ └── Entity.adoc │ ├── nodejs │ ├── answer │ │ ├── ConceptMapGroup.adoc │ │ ├── Explainable.adoc │ │ ├── ValueGroup.adoc │ │ └── Explanation.adoc │ ├── session │ │ └── SessionType.adoc │ ├── schema │ │ └── Transitivity.adoc │ ├── connection │ │ └── Replica.adoc │ └── transaction │ │ └── TransactionType.adoc │ └── csharp │ ├── session │ └── SessionType.adoc │ ├── transaction │ └── TransactionType.adoc │ ├── data │ └── ValueType.adoc │ ├── concept │ └── Transitivity.adoc │ ├── errors │ └── TypeDBDriverException.adoc │ └── answer │ └── IValueGroup.adoc ├── .github ├── CODEOWNERS ├── PULL_REQUEST_TEMPLATE.md └── ISSUE_TEMPLATE │ ├── REFACTOR.md │ ├── FEATURE_REQUEST.md │ ├── LANGUAGE_DRIVER_REQUEST.md │ └── BUG_REPORT.md ├── tool ├── test │ ├── resources │ │ └── encryption │ │ │ ├── int-zmq-private-key │ │ │ ├── int-zmq-public-key │ │ │ └── keystore.pkcs12 │ ├── stop-community-server.sh │ ├── stop-cluster-servers.sh │ └── EchoJavaHome.java ├── rust │ ├── sync.sh │ └── BUILD ├── release │ ├── create_notes.sh │ └── BUILD └── http-ts │ └── BUILD ├── nodejs ├── tool │ └── typedoc │ │ └── typedoc.json ├── test │ ├── deployment │ │ └── package.json │ ├── integration │ │ └── README.md │ └── behaviour │ │ ├── README.md │ │ └── driver │ │ └── BUILD └── .eslintignore ├── Cargo.toml ├── c ├── .clang-format ├── swig │ └── typedb_driver_go.swg └── tests │ └── integration │ └── test_driver.h ├── csharp ├── nuget │ └── paket.csharp_deps_extension.bzl ├── build_opts.bzl └── Test │ ├── BUILD │ ├── Behaviour │ ├── BUILD │ └── Concept │ │ └── BUILD │ ├── Deployment │ └── BUILD │ └── Integration │ └── BUILD ├── rust ├── tests │ ├── behaviour │ │ ├── config │ │ │ ├── Cargo.toml │ │ │ └── lib.rs │ │ └── defs.bzl │ └── integration │ │ ├── cluster │ │ └── mod.rs │ │ └── mod.rs ├── src │ ├── connection │ │ ├── database │ │ │ └── mod.rs │ │ └── network │ │ │ └── mod.rs │ ├── user │ │ └── mod.rs │ └── database │ │ └── mod.rs └── rustfmt.toml ├── .circleci └── windows │ └── git.patch ├── python ├── index.rst ├── tests │ ├── behaviour │ │ └── entry_point_behave.py │ └── deployment │ │ └── requirements.txt ├── conf.py ├── requirements_dev.txt ├── requirements.txt └── typedb │ ├── concept │ └── type │ │ ├── role_type.py │ │ └── entity_type.py │ └── api │ └── analyze │ └── variable.py ├── .gitattributes ├── dependencies ├── maven │ └── update.sh └── typedb │ └── BUILD ├── .factory ├── test-cluster.sh └── test-community.sh ├── java └── api │ └── analyze │ ├── Variable.java │ └── ConjunctionID.java ├── cpp ├── build_opts.bzl ├── lib │ └── common │ │ └── native.hpp └── test │ └── behaviour │ ├── BUILD │ ├── concept │ └── BUILD │ ├── driver │ └── BUILD │ └── query │ └── BUILD └── go ├── api ├── user │ └── User.go └── database │ └── DatabaseManager.go └── go_versions.bzl /VERSION: -------------------------------------------------------------------------------- 1 | 3.7.0 -------------------------------------------------------------------------------- /.bazelversion: -------------------------------------------------------------------------------- 1 | 6.2.0 2 | -------------------------------------------------------------------------------- /http-ts/.npmrc: -------------------------------------------------------------------------------- 1 | auto-install-peers=false 2 | -------------------------------------------------------------------------------- /docs/antora.yml: -------------------------------------------------------------------------------- 1 | name: external-typedb-driver 2 | version: 3.x 3 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | /* @dmitrii-ubskii @flyingsilverfin 2 | -------------------------------------------------------------------------------- /tool/test/resources/encryption/int-zmq-private-key: -------------------------------------------------------------------------------- 1 | kt{E*P89LL8uG6GxUAo?%baTE}9dEqXVTLabY==m -------------------------------------------------------------------------------- /tool/test/resources/encryption/int-zmq-public-key: -------------------------------------------------------------------------------- 1 | W-]2tG6]I]H}}t}1U9oa7wkw7t/4Wa[E8c/8N 3 | 4 | [source,typescript] 5 | ---- 6 | ApiResponse: ApiOkResponse | ApiErrorResponse 7 | ---- 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/ReturnOperationCheck.adoc: -------------------------------------------------------------------------------- 1 | [#_ReturnOperationCheck] 2 | === ReturnOperationCheck 3 | 4 | *Package*: `typedb.api.analyze.function` 5 | 6 | *Supertypes:* 7 | 8 | * `ReturnOperation` 9 | 10 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/concept/InstantiableType.adoc: -------------------------------------------------------------------------------- 1 | [#_InstantiableType] 2 | === InstantiableType 3 | 4 | [source,typescript] 5 | ---- 6 | InstantiableType: EntityType | RelationType | AttributeType 7 | ---- 8 | 9 | 10 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/REFACTOR.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Refactor 3 | about: Propose an architecture refactor here 4 | title: '' 5 | labels: refactor 6 | assignees: '' 7 | 8 | --- 9 | 10 | 11 | ## Problem to Solve 12 | 13 | 14 | ## Proposed Solution 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/FunctionSingleReturnSelector.adoc: -------------------------------------------------------------------------------- 1 | [#_FunctionSingleReturnSelector] 2 | === FunctionSingleReturnSelector 3 | 4 | [source,typescript] 5 | ---- 6 | FunctionSingleReturnSelector: "first" | "last" 7 | ---- 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/DistinctStage.adoc: -------------------------------------------------------------------------------- 1 | [#_DistinctStage] 2 | === DistinctStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents a ‘distinct’ stage. 11 | 12 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/FetchAnnotationFieldEntry.adoc: -------------------------------------------------------------------------------- 1 | [#_FetchAnnotationFieldEntry] 2 | === FetchAnnotationFieldEntry 3 | 4 | [source,typescript] 5 | ---- 6 | FetchAnnotationFieldEntry: AnalyzedFetch & { key: string } 7 | ---- 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/errors/ServerError.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_ServerError] 2 | === ServerError 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | * `Display` 9 | * `Eq` 10 | * `From` 11 | * `PartialEq` 12 | * `StructuralPartialEq` 13 | 14 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/connection/User.adoc: -------------------------------------------------------------------------------- 1 | [#_User] 2 | === User 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `username` a| `string` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/analyze/PipelineStage.DistinctStage.adoc: -------------------------------------------------------------------------------- 1 | [#_PipelineStage_DistinctStage] 2 | === PipelineStage.DistinctStage 3 | 4 | *Package*: `com.typedb.driver.api.analyze` 5 | 6 | *Superinterfaces:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents a "distinct" stage 11 | 12 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/connection/Database.adoc: -------------------------------------------------------------------------------- 1 | [#_Database] 2 | === Database 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `name` a| `string` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /csharp/nuget/paket.csharp_deps_extension.bzl: -------------------------------------------------------------------------------- 1 | "Generated by paket2bazel" 2 | 3 | load(":paket.csharp_deps.bzl", _csharp_deps = "csharp_deps") 4 | 5 | def _csharp_deps_impl(_ctx): 6 | _csharp_deps() 7 | 8 | csharp_deps_extension = module_extension( 9 | implementation = _csharp_deps_impl, 10 | ) 11 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/VariableInfo.adoc: -------------------------------------------------------------------------------- 1 | [#_VariableInfo] 2 | === VariableInfo 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `name` a| `string` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/QueryResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_QueryResponse] 2 | === QueryResponse 3 | 4 | [source,typescript] 5 | ---- 6 | QueryResponse: 7 | | OkQueryResponse 8 | | ConceptRowsQueryResponse 9 | | ConceptDocumentsQueryResponse 10 | | ConceptRowsQueryResponseLegacy 11 | ---- 12 | 13 | 14 | -------------------------------------------------------------------------------- /rust/tests/behaviour/config/Cargo.toml: -------------------------------------------------------------------------------- 1 | 2 | # Generated by TypeDB Cargo sync tool. 3 | # Do not modify this file. 4 | 5 | dependencies = {} 6 | 7 | [features] 8 | bazel = [] 9 | 10 | [package] 11 | name = "config" 12 | edition = "2021" 13 | version = "0.0.0" 14 | 15 | [lib] 16 | path = "lib.rs" 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/ConceptRow.adoc: -------------------------------------------------------------------------------- 1 | [#_ConceptRow] 2 | === ConceptRow 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `[varName: string]` a| `Concept` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/SignInResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_SignInResponse] 2 | === SignInResponse 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `token` a| `string` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/AnalyzeOptions.adoc: -------------------------------------------------------------------------------- 1 | [#_AnalyzeOptions] 2 | === AnalyzeOptions 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `include_plan` a| `boolean` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/UsersListResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_UsersListResponse] 2 | === UsersListResponse 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `users` a| `User` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintVertexAny.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintVertexAny] 2 | ==== ConstraintVertexAny 3 | 4 | [source,typescript] 5 | ---- 6 | ConstraintVertexAny: 7 | | ConstraintVertexVariable 8 | | ConstraintVertexLabel 9 | | ConstraintVertexValue 10 | | ConstraintVertexNamedRole 11 | ---- 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/ApiOkResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_ApiOkResponse_OK_RES] 2 | === ApiOkResponse 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `ok` a| `OK_RES` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/concept/RoleType.adoc: -------------------------------------------------------------------------------- 1 | [#_RoleType] 2 | === RoleType 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `kind` a| `"roleType"` a| 12 | a| `label` a| `string` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/ApiError.adoc: -------------------------------------------------------------------------------- 1 | [#_ApiError] 2 | === ApiError 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `code` a| `string` a| 12 | a| `message` a| `string` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/errors/AnalyzeError.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_AnalyzeError] 2 | === AnalyzeError 3 | 4 | [caption=""] 5 | .Enum variants 6 | // tag::enum_constants[] 7 | [cols=""] 8 | [options="header"] 9 | |=== 10 | |Variant 11 | a| `MissingResponseField` 12 | a| `UnknownEnumValue` 13 | |=== 14 | // end::enum_constants[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/Reducer.adoc: -------------------------------------------------------------------------------- 1 | [#_Reducer] 2 | === Reducer 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `arguments` a| `VariableId` a| 12 | a| `reducer` a| `string` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/errors/ConceptError.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_ConceptError] 2 | === ConceptError 3 | 4 | [caption=""] 5 | .Enum variants 6 | // tag::enum_constants[] 7 | [cols=""] 8 | [options="header"] 9 | |=== 10 | |Variant 11 | a| `UnavailableRowIndex` 12 | a| `UnavailableRowVariable` 13 | |=== 14 | // end::enum_constants[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintOr.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintOr] 2 | ==== ConstraintOr 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `branches` a| `number` a| 12 | a| `tag` a| `"or"` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/concept/EdgeKind.adoc: -------------------------------------------------------------------------------- 1 | [#_EdgeKind] 2 | === EdgeKind 3 | 4 | [source,typescript] 5 | ---- 6 | EdgeKind: 7 | | "isa" 8 | | "has" 9 | | "links" 10 | | "sub" 11 | | "owns" 12 | | "relates" 13 | | "plays" 14 | | "isaExact" 15 | | "subExact" 16 | | "assigned" 17 | | "argument" 18 | ---- 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/concept/EntityType.adoc: -------------------------------------------------------------------------------- 1 | [#_EntityType] 2 | === EntityType 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `kind` a| `"entityType"` a| 12 | a| `label` a| `string` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/concept/ValueType.adoc: -------------------------------------------------------------------------------- 1 | [#_ValueType] 2 | === ValueType 3 | 4 | [source,typescript] 5 | ---- 6 | ValueType: 7 | | "boolean" 8 | | "integer" 9 | | "double" 10 | | "decimal" 11 | | "date" 12 | | "datetime" 13 | | "datetime-tz" 14 | | "duration" 15 | | "string" 16 | | "struct" 17 | ---- 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/DatabasesListResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_DatabasesListResponse] 2 | === DatabasesListResponse 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `databases` a| `Database` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/answer/Node.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_Node] 2 | === Node 3 | 4 | [caption=""] 5 | .Enum variants 6 | // tag::enum_constants[] 7 | [cols=""] 8 | [options="header"] 9 | |=== 10 | |Variant 11 | a| `Leaf(Option)` 12 | a| `List(Vec)` 13 | a| `Map(HashMap)` 14 | |=== 15 | // end::enum_constants[] 16 | 17 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/AnalyzedFetch.adoc: -------------------------------------------------------------------------------- 1 | [#_AnalyzedFetch] 2 | === AnalyzedFetch 3 | 4 | [source,typescript] 5 | ---- 6 | AnalyzedFetch: 7 | | { elements: AnalyzedFetch; tag: "list" } 8 | | { possibleFields: FetchAnnotationFieldEntry[]; tag: "object" } 9 | | { tag: "value"; valueTypes: ValueType[] } 10 | ---- 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintNot.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintNot] 2 | ==== ConstraintNot 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `conjunction` a| `number` a| 12 | a| `tag` a| `"not"` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintSpan.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintSpan] 2 | ==== ConstraintSpan 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `begin` a| `number` a| 12 | a| `end` a| `number` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintTry.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintTry] 2 | ==== ConstraintTry 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `conjunction` a| `number` a| 12 | a| `tag` a| `"try"` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/concept/RelationType.adoc: -------------------------------------------------------------------------------- 1 | [#_RelationType] 2 | === RelationType 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `kind` a| `"relationType"` a| 12 | a| `label` a| `string` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/answer/Leaf.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_Leaf] 2 | === Leaf 3 | 4 | [caption=""] 5 | .Enum variants 6 | // tag::enum_constants[] 7 | [cols=""] 8 | [options="header"] 9 | |=== 10 | |Variant 11 | a| `Concept(Concept)` 12 | a| `Empty` 13 | a| `Kind(Kind)` 14 | a| `ValueType(ValueType)` 15 | |=== 16 | // end::enum_constants[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConjunctionAnnotations.adoc: -------------------------------------------------------------------------------- 1 | [#_ConjunctionAnnotations] 2 | === ConjunctionAnnotations 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `variableAnnotations` a| `string` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/legacy/QueryConjunctionLegacy.adoc: -------------------------------------------------------------------------------- 1 | [#_QueryConjunctionLegacy] 2 | === QueryConjunctionLegacy 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `constraints` a| `ConstraintAny` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/TransactionOpenResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_TransactionOpenResponse] 2 | === TransactionOpenResponse 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `transactionId` a| `string` a| 12 | |=== 13 | // end::properties[] 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/concept/Entity.adoc: -------------------------------------------------------------------------------- 1 | [#_Entity] 2 | === Entity 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `iid` a| `string` a| 12 | a| `kind` a| `"entity"` a| 13 | a| `type` a| `EntityType` a| 14 | |=== 15 | // end::properties[] 16 | 17 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/concept/Value.adoc: -------------------------------------------------------------------------------- 1 | [#_Value] 2 | === Value 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `kind` a| `"value"` a| 12 | a| `value` a| `any` a| 13 | a| `valueType` a| `ValueType` a| 14 | |=== 15 | // end::properties[] 16 | 17 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/ApiErrorResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_ApiErrorResponse] 2 | === ApiErrorResponse 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `err` a| `ApiError` a| 12 | a| `status` a| `number` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintVertexLabel.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintVertexLabel] 2 | ==== ConstraintVertexLabel 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `tag` a| `"label"` a| 12 | a| `type` a| `Type` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/concept/Relation.adoc: -------------------------------------------------------------------------------- 1 | [#_Relation] 2 | === Relation 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `iid` a| `string` a| 12 | a| `kind` a| `"relation"` a| 13 | a| `type` a| `RelationType` a| 14 | |=== 15 | // end::properties[] 16 | 17 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/connection/TranslatedAddress.adoc: -------------------------------------------------------------------------------- 1 | [#_TranslatedAddress] 2 | === TranslatedAddress 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `external` a| `string` a| 12 | a| `internal` a| `string` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/ConceptRowAnswer.adoc: -------------------------------------------------------------------------------- 1 | [#_ConceptRowAnswer] 2 | === ConceptRowAnswer 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `data` a| `ConceptRow` a| 12 | a| `involvedBlocks` a| `number` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/VersionResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_VersionResponse] 2 | === VersionResponse 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `distribution` a| `Distribution` a| 12 | a| `version` a| `string` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/connection/Credentials.adoc: -------------------------------------------------------------------------------- 1 | [#_Credentials] 2 | === Credentials 3 | 4 | *Package*: `typedb.api.connection.credentials` 5 | 6 | User credentials and TLS encryption settings for connecting to TypeDB Server. 7 | 8 | [caption=""] 9 | .Examples 10 | [source,python] 11 | ---- 12 | credentials = Credentials(username, password) 13 | ---- 14 | 15 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: Request a feature here, or visit forum.typedb.com for ideas and questions 4 | title: '' 5 | labels: feature 6 | assignees: '' 7 | 8 | --- 9 | 10 | ## Problem to Solve 11 | 12 | 13 | ## Current Workaround 14 | 15 | 16 | ## Proposed Solution 17 | 18 | 19 | ## Additional Information 20 | 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintVertexVariable.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintVertexVariable] 2 | ==== ConstraintVertexVariable 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `id` a| `string` a| 12 | a| `tag` a| `"variable"` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/VariableAnnotations.adoc: -------------------------------------------------------------------------------- 1 | [#_VariableAnnotations] 2 | === VariableAnnotations 3 | 4 | [source,typescript] 5 | ---- 6 | VariableAnnotations: { isOptional: boolean } & ( 7 | | { annotations: Type[]; tag: "instance" } 8 | | { annotations: Type[]; tag: "type" } 9 | | { tag: "value"; valueTypes: ValueType[] } 10 | ) 11 | ---- 12 | 13 | 14 | -------------------------------------------------------------------------------- /nodejs/test/integration/README.md: -------------------------------------------------------------------------------- 1 | ## TypeDB Driver for Node.js: Integration Tests 2 | 3 | These JavaScript tests verify the correctness of connection, Concept and Query methods. 4 | 5 | The only prerequisite to run them locally is that you must have `npm` or `yarn` installed, and a TypeDB server running in the background. 6 | 7 | To run all tests, run: 8 | ``` 9 | npm test 10 | ``` -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/c/concept/entity.adoc: -------------------------------------------------------------------------------- 1 | [#_methods_concept_entity] 2 | === entity 3 | 4 | [#_entity_get_type] 5 | ==== entity_get_type 6 | 7 | [source,cpp] 8 | ---- 9 | struct Concept* entity_get_type(const struct Concept* entity) 10 | ---- 11 | 12 | 13 | 14 | Retrieves the type which this ``Entity`` belongs to. 15 | 16 | [caption=""] 17 | .Returns 18 | `struct Concept*` 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/concept/AttributeType.adoc: -------------------------------------------------------------------------------- 1 | [#_AttributeType] 2 | === AttributeType 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `kind` a| `"attributeType"` a| 12 | a| `label` a| `string` a| 13 | a| `valueType` a| `ValueType` a| 14 | |=== 15 | // end::properties[] 16 | 17 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/concept/Type.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_Type] 2 | === Type 3 | 4 | [caption=""] 5 | .Enum variants 6 | // tag::enum_constants[] 7 | [cols=""] 8 | [options="header"] 9 | |=== 10 | |Variant 11 | a| `AttributeType(AttributeType)` 12 | a| `EntityType(EntityType)` 13 | a| `RelationType(RelationType)` 14 | a| `RoleType(RoleType)` 15 | |=== 16 | // end::enum_constants[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/AnalyzedConjunction.adoc: -------------------------------------------------------------------------------- 1 | [#_AnalyzedConjunction] 2 | === AnalyzedConjunction 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `annotations` a| `ConjunctionAnnotations` a| 12 | a| `constraints` a| `ConstraintAny` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/analyze/Function.ReturnOperation.Check.adoc: -------------------------------------------------------------------------------- 1 | [#_Function_ReturnOperation_Check] 2 | === Function.ReturnOperation.Check 3 | 4 | *Package*: `com.typedb.driver.api.analyze` 5 | 6 | *Superinterfaces:* 7 | 8 | * `Function.ReturnOperation` 9 | 10 | Indicates the function returns a boolean - true if the body had answers, false otherwise. e.g. ``return check;`` 11 | 12 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/SortOrder.adoc: -------------------------------------------------------------------------------- 1 | [#_SortOrder] 2 | === SortOrder 3 | 4 | *Package*: `typedb.common.enums` 5 | 6 | An enumeration. 7 | 8 | [caption=""] 9 | .Enum constants 10 | // tag::enum_constants[] 11 | [cols=","] 12 | [options="header"] 13 | |=== 14 | |Name |Value 15 | a| `Ascending` a| `0` 16 | a| `Descending` a| `1` 17 | |=== 18 | // end::enum_constants[] 19 | 20 | -------------------------------------------------------------------------------- /.circleci/windows/git.patch: -------------------------------------------------------------------------------- 1 | diff --git a/WORKSPACE b/WORKSPACE 2 | index a6df7ba2..420f8397 100644 3 | --- a/WORKSPACE 4 | +++ b/WORKSPACE 5 | @@ -15,7 +15,7 @@ 6 | # specific language governing permissions and limitations 7 | # under the License. 8 | 9 | -workspace(name = "typedb_driver") 10 | +workspace(name = "v") 11 | 12 | ############################## 13 | # Load @typedb_dependencies # 14 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/connection/DriverParamsBasic.adoc: -------------------------------------------------------------------------------- 1 | [#_DriverParamsBasic] 2 | ==== DriverParamsBasic 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `addresses` a| `string` a| 12 | a| `password` a| `string` a| 13 | a| `username` a| `string` a| 14 | |=== 15 | // end::properties[] 16 | 17 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/value/TimeZone.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_TimeZone] 2 | === TimeZone 3 | 4 | TimeZone for datetime-tz. Can be represented as an IANA Tz or as a FixedOffset. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Fixed(FixedOffset)` 14 | a| `IANA(Tz)` 15 | |=== 16 | // end::enum_constants[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/connection/TransactionOptions.adoc: -------------------------------------------------------------------------------- 1 | [#_TransactionOptions] 2 | === TransactionOptions 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `schemaLockAcquireTimeoutMillis` a| `number` a| 12 | a| `transactionTimeoutMillis` a| `number` a| 13 | |=== 14 | // end::properties[] 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/Fetch.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_Fetch] 2 | === Fetch 3 | 4 | A representation of the ‘fetch’ stage of a query 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Leaf(FetchLeaf)` 14 | a| `List(Box)` 15 | a| `Object(HashMap)` 16 | |=== 17 | // end::enum_constants[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/SortOrder.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_SortOrder] 2 | === SortOrder 3 | 4 | The order of a variable being sorted on in a PipelineStage::Sort 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Ascending = 0` 14 | a| `Descending = 1` 15 | |=== 16 | // end::enum_constants[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/transaction/TransactionType.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_TransactionType] 2 | === TransactionType 3 | 4 | This enum is used to specify the type of transaction. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Read = 0` 14 | a| `Schema = 2` 15 | a| `Write = 1` 16 | |=== 17 | // end::enum_constants[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/value/Offset.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_Offset] 2 | === Offset 3 | 4 | Offset for datetime-tz. Can be retrieved from an IANA Tz or a FixedOffset. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Fixed(FixedOffset)` 14 | a| `IANA(::Offset)` 15 | |=== 16 | // end::enum_constants[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintVertexNamedRole.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintVertexNamedRole] 2 | ==== ConstraintVertexNamedRole 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `name` a| `string` a| 12 | a| `tag` a| `"namedRole"` a| 13 | a| `variable` a| `string` a| 14 | |=== 15 | // end::properties[] 16 | 17 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/legacy/QueryStructureLegacy.adoc: -------------------------------------------------------------------------------- 1 | [#_QueryStructureLegacy] 2 | === QueryStructureLegacy 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `blocks` a| `QueryConjunctionLegacy` a| 12 | a| `outputs` a| `string` a| 13 | a| `variables` a| `string` a| 14 | |=== 15 | // end::properties[] 16 | 17 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/QueryOptions.adoc: -------------------------------------------------------------------------------- 1 | [#_QueryOptions] 2 | === QueryOptions 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `answerCountLimit` a| `number` a| 12 | a| `includeInstanceTypes` a| `boolean` a| 13 | a| `includeQueryStructure` a| `boolean` a| 14 | |=== 15 | // end::properties[] 16 | 17 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/ConstraintExactness.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintExactness] 2 | === ConstraintExactness 3 | 4 | *Package*: `typedb.common.enums` 5 | 6 | An enumeration. 7 | 8 | [caption=""] 9 | .Enum constants 10 | // tag::enum_constants[] 11 | [cols=","] 12 | [options="header"] 13 | |=== 14 | |Name |Value 15 | a| `Exact` a| `0` 16 | a| `Subtypes` a| `1` 17 | |=== 18 | // end::enum_constants[] 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/ReturnOperation.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_ReturnOperation] 2 | === ReturnOperation 3 | 4 | A representation of the return operation of the function 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Check` 14 | a| `Reduce` 15 | a| `Single` 16 | a| `Stream` 17 | |=== 18 | // end::enum_constants[] 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/answer/JSON.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_JSON] 2 | === JSON 3 | 4 | [caption=""] 5 | .Enum variants 6 | // tag::enum_constants[] 7 | [cols=""] 8 | [options="header"] 9 | |=== 10 | |Variant 11 | a| `Array(Vec)` 12 | a| `Boolean(bool)` 13 | a| `Null` 14 | a| `Number(f64)` 15 | a| `Object(HashMap, JSON>)` 16 | a| `String(Cow<'static, str>)` 17 | |=== 18 | // end::enum_constants[] 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/answer/QueryType.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_QueryType] 2 | === QueryType 3 | 4 | This enum is used to specify the type of the query resulted in this answer. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `ReadQuery = 0` 14 | a| `SchemaQuery = 2` 15 | a| `WriteQuery = 1` 16 | |=== 17 | // end::enum_constants[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/errors/InternalError.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_InternalError] 2 | === InternalError 3 | 4 | [caption=""] 5 | .Enum variants 6 | // tag::enum_constants[] 7 | [cols=""] 8 | [options="header"] 9 | |=== 10 | |Variant 11 | a| `EnumOutOfBounds` 12 | a| `RecvError` 13 | a| `SendError` 14 | a| `UnexpectedRequestType` 15 | a| `UnexpectedResponseType` 16 | a| `UnknownServer` 17 | |=== 18 | // end::enum_constants[] 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintIid.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintIid] 2 | ==== ConstraintIid 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `concept` a| `ConstraintVertexVariable` a| 12 | a| `iid` a| `string` a| 13 | a| `tag` a| `"iid"` a| 14 | a| `textSpan` a| `ConstraintSpan` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintKind.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintKind] 2 | ==== ConstraintKind 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `kind` a| `string` a| 12 | a| `tag` a| `"kind"` a| 13 | a| `textSpan` a| `ConstraintSpan` a| 14 | a| `type` a| `ConstraintVertexVariable` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintVertexValue.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintVertexValue] 2 | ==== ConstraintVertexValue 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `kind` a| `"value"` a| 12 | a| `tag` a| `"value"` a| 13 | a| `value` a| `any` a| 14 | a| `valueType` a| `ValueType` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/connection/DriverParamsTranslated.adoc: -------------------------------------------------------------------------------- 1 | [#_DriverParamsTranslated] 2 | ==== DriverParamsTranslated 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `password` a| `string` a| 12 | a| `translatedAddresses` a| `TranslatedAddress` a| 13 | a| `username` a| `string` a| 14 | |=== 15 | // end::properties[] 16 | 17 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/OkQueryResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_OkQueryResponse] 2 | === OkQueryResponse 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `answerType` a| `"ok"` a| 12 | a| `comment` a| `string` a| 13 | a| `query` a| `AnalyzedPipeline` a| 14 | a| `queryType` a| `QueryType` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintLabel.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintLabel] 2 | ==== ConstraintLabel 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `label` a| `string` a| 12 | a| `tag` a| `"label"` a| 13 | a| `textSpan` a| `ConstraintSpan` a| 14 | a| `type` a| `ConstraintVertexVariable` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/concept/Attribute.adoc: -------------------------------------------------------------------------------- 1 | [#_Attribute] 2 | === Attribute 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `iid` a| `string` a| 12 | a| `kind` a| `"attribute"` a| 13 | a| `type` a| `AttributeType` a| 14 | a| `value` a| `any` a| 15 | a| `valueType` a| `ValueType` a| 16 | |=== 17 | // end::properties[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/analyze/Fetch.FetchList.adoc: -------------------------------------------------------------------------------- 1 | [#_Fetch_FetchList] 2 | === Fetch.FetchList 3 | 4 | *Package*: `com.typedb.driver.api.analyze` 5 | 6 | A ``List`` of ``Fetch`` documents. 7 | 8 | // tag::methods[] 9 | [#_Fetch_FetchList_element_] 10 | ==== element 11 | 12 | [source,java] 13 | ---- 14 | Fetch element() 15 | ---- 16 | 17 | 18 | 19 | [caption=""] 20 | .Returns 21 | `Fetch` 22 | 23 | // end::methods[] 24 | 25 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/concept/ConceptCategory.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_ConceptCategory] 2 | === ConceptCategory 3 | 4 | [caption=""] 5 | .Enum variants 6 | // tag::enum_constants[] 7 | [cols=""] 8 | [options="header"] 9 | |=== 10 | |Variant 11 | a| `Attribute` 12 | a| `AttributeType` 13 | a| `Entity` 14 | a| `EntityType` 15 | a| `Relation` 16 | a| `RelationType` 17 | a| `RoleType` 18 | a| `Value` 19 | |=== 20 | // end::enum_constants[] 21 | 22 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintIs.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintIs] 2 | ==== ConstraintIs 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `lhs` a| `ConstraintVertexVariable` a| 12 | a| `rhs` a| `ConstraintVertexVariable` a| 13 | a| `tag` a| `"is"` a| 14 | a| `textSpan` a| `ConstraintSpan` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/AnalyzeResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_AnalyzeResponse] 2 | === AnalyzeResponse 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `fetch` a| `AnalyzedFetch` a| 12 | a| `preamble` a| `AnalyzedFunction` a| 13 | a| `query` a| `AnalyzedPipeline` a| 14 | a| `source` a| `string` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/QueryResponseBase.adoc: -------------------------------------------------------------------------------- 1 | [#_QueryResponseBase] 2 | === QueryResponseBase 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `answerType` a| `AnswerType` a| 12 | a| `comment` a| `string` a| 13 | a| `query` a| `AnalyzedPipeline` a| 14 | a| `queryType` a| `QueryType` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/answer/ConceptDocumentHeader.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_ConceptDocumentHeader] 2 | === ConceptDocumentHeader 3 | 4 | *Implements traits:* 5 | 6 | * `Debug` 7 | * `PartialEq` 8 | * `StructuralPartialEq` 9 | 10 | [caption=""] 11 | .Fields 12 | // tag::properties[] 13 | [cols=",,"] 14 | [options="header"] 15 | |=== 16 | |Name |Type |Description 17 | a| `query_type` a| `QueryType` a| 18 | |=== 19 | // end::properties[] 20 | 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/AnalyzedPipeline.adoc: -------------------------------------------------------------------------------- 1 | [#_AnalyzedPipeline] 2 | === AnalyzedPipeline 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `conjunctions` a| `AnalyzedConjunction` a| 12 | a| `outputs` a| `string` a| 13 | a| `stages` a| `PipelineStage` a| 14 | a| `variables` a| `string` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/VariableAnnotations.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_VariableAnnotations] 2 | === VariableAnnotations 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | 9 | [caption=""] 10 | .Fields 11 | // tag::properties[] 12 | [cols=",,"] 13 | [options="header"] 14 | |=== 15 | |Name |Type |Description 16 | a| `types` a| `TypeAnnotations` a| The ``TypeAnnotations`` of this variable. 17 | |=== 18 | // end::properties[] 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintHas.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintHas] 2 | ==== ConstraintHas 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `attribute` a| `ConstraintVertexVariable` a| 12 | a| `owner` a| `ConstraintVertexVariable` a| 13 | a| `tag` a| `"has"` a| 14 | a| `textSpan` a| `ConstraintSpan` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintIsa.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintIsa] 2 | ==== ConstraintIsa 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `instance` a| `ConstraintVertexVariable` a| 12 | a| `tag` a| `"isa"` a| 13 | a| `textSpan` a| `ConstraintSpan` a| 14 | a| `type` a| `ConstraintVertexVariable` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintSub.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintSub] 2 | ==== ConstraintSub 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `subtype` a| `ConstraintVertexVariable` a| 12 | a| `supertype` a| `ConstraintVertexVariable` a| 13 | a| `tag` a| `"sub"` a| 14 | a| `textSpan` a| `ConstraintSpan` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintValue.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintValue] 2 | ==== ConstraintValue 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `attributeType` a| `ConstraintVertexVariable` a| 12 | a| `tag` a| `"value"` a| 13 | a| `textSpan` a| `ConstraintSpan` a| 14 | a| `valueType` a| `string` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/FunctionReturnStructure.adoc: -------------------------------------------------------------------------------- 1 | [#_FunctionReturnStructure] 2 | === FunctionReturnStructure 3 | 4 | [source,typescript] 5 | ---- 6 | FunctionReturnStructure: 7 | | { 8 | selector: FunctionSingleReturnSelector; 9 | tag: "single"; 10 | variables: VariableId[]; 11 | } 12 | | { tag: "stream"; variables: VariableId[] } 13 | | { tag: "check" } 14 | | { reducers: Reducer[]; tag: "reduce" } 15 | ---- 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/errors/TypeDBDriverException.adoc: -------------------------------------------------------------------------------- 1 | [#_TypeDBDriverException] 2 | === TypeDBDriverException 3 | 4 | *Package*: `typedb.common.exception` 5 | 6 | *Supertypes:* 7 | 8 | * `RuntimeError` 9 | 10 | Exceptions raised by the driver. 11 | 12 | [caption=""] 13 | .Examples 14 | [source,python] 15 | ---- 16 | try: 17 | transaction.commit() 18 | except TypeDBDriverException as err: 19 | print("Error:", err) 20 | ---- 21 | 22 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/ConstraintWithSpan.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_ConstraintWithSpan] 2 | === ConstraintWithSpan 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | 9 | [caption=""] 10 | .Fields 11 | // tag::properties[] 12 | [cols=",,"] 13 | [options="header"] 14 | |=== 15 | |Name |Type |Description 16 | a| `constraint` a| `Constraint` a| 17 | a| `span` a| `Option` a| 18 | |=== 19 | // end::properties[] 20 | 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintOwns.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintOwns] 2 | ==== ConstraintOwns 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `attribute` a| `ConstraintVertexVariable` a| 12 | a| `owner` a| `ConstraintVertexVariable` a| 13 | a| `tag` a| `"owns"` a| 14 | a| `textSpan` a| `ConstraintSpan` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintPlays.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintPlays] 2 | ==== ConstraintPlays 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `player` a| `ConstraintVertexVariable` a| 12 | a| `role` a| `ConstraintVertexVariable` a| 13 | a| `tag` a| `"plays"` a| 14 | a| `textSpan` a| `ConstraintSpan` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/TypeAnnotations.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_TypeAnnotations] 2 | === TypeAnnotations 3 | 4 | The category of a variable, and the possible types determined by type-inference. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Instance(Vec)` 14 | a| `Type(Vec)` 15 | a| `Value(ValueType)` 16 | |=== 17 | // end::enum_constants[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/cpp/concept/Transitivity.adoc: -------------------------------------------------------------------------------- 1 | [#_Transitivity] 2 | === Transitivity 3 | 4 | *Package*: `TypeDB` 5 | 6 | 7 | 8 | Used in ConceptAPI to specify whether to query only explicit schema constraints or also include transitive ones 9 | 10 | [caption=""] 11 | .Enum constants 12 | // tag::enum_constants[] 13 | [cols=""] 14 | [options="header"] 15 | |=== 16 | |Name 17 | a| `EXPLICIT` 18 | a| `TRANSITIVE` 19 | |=== 20 | // end::enum_constants[] 21 | 22 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintIsaExact.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintIsaExact] 2 | ==== ConstraintIsaExact 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `instance` a| `ConstraintVertexVariable` a| 12 | a| `tag` a| `"isa!"` a| 13 | a| `textSpan` a| `ConstraintSpan` a| 14 | a| `type` a| `ConstraintVertexVariable` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintRelates.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintRelates] 2 | ==== ConstraintRelates 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `relation` a| `ConstraintVertexVariable` a| 12 | a| `role` a| `ConstraintVertexVariable` a| 13 | a| `tag` a| `"relates"` a| 14 | a| `textSpan` a| `ConstraintSpan` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintSubExact.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintSubExact] 2 | ==== ConstraintSubExact 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `subtype` a| `ConstraintVertexVariable` a| 12 | a| `supertype` a| `ConstraintVertexVariable` a| 13 | a| `tag` a| `"sub!"` a| 14 | a| `textSpan` a| `ConstraintSpan` a| 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/VariableInfo.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_VariableInfo] 2 | === VariableInfo 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | 9 | Holds information about variables in a ``Pipeline``. 10 | 11 | [caption=""] 12 | .Fields 13 | // tag::properties[] 14 | [cols=",,"] 15 | [options="header"] 16 | |=== 17 | |Name |Type |Description 18 | a| `name` a| `String` a| The name of the variable, if any. 19 | |=== 20 | // end::properties[] 21 | 22 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/nodejs/answer/ConceptMapGroup.adoc: -------------------------------------------------------------------------------- 1 | [#_ConceptMapGroup] 2 | === ConceptMapGroup 3 | 4 | Contains an element of the group query result. 5 | 6 | [caption=""] 7 | .Fields 8 | // tag::properties[] 9 | [cols=",,"] 10 | [options="header"] 11 | |=== 12 | |Name |Type |Description 13 | a| `conceptMaps` a| `ConceptMap` a| The ConceptMaps of the group. 14 | a| `owner` a| `Concept` a| The concept that is the group owner. 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/answer/ConceptRowHeader.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_ConceptRowHeader] 2 | === ConceptRowHeader 3 | 4 | *Implements traits:* 5 | 6 | * `Debug` 7 | 8 | [caption=""] 9 | .Fields 10 | // tag::properties[] 11 | [cols=",,"] 12 | [options="header"] 13 | |=== 14 | |Name |Type |Description 15 | a| `column_names` a| `Vec` a| 16 | a| `query_structure` a| `Option` a| 17 | a| `query_type` a| `QueryType` a| 18 | |=== 19 | // end::properties[] 20 | 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/cpp/schema/ValueType.adoc: -------------------------------------------------------------------------------- 1 | [#_ValueType] 2 | === ValueType 3 | 4 | *Package*: `TypeDB` 5 | 6 | 7 | 8 | Represents the type of primitive value is held by a Value or Attribute. 9 | 10 | [caption=""] 11 | .Enum constants 12 | // tag::enum_constants[] 13 | [cols=""] 14 | [options="header"] 15 | |=== 16 | |Name 17 | a| `BOOLEAN` 18 | a| `DATETIME` 19 | a| `DOUBLE` 20 | a| `LONG` 21 | a| `OBJECT` 22 | a| `STRING` 23 | |=== 24 | // end::enum_constants[] 25 | 26 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/FetchList.adoc: -------------------------------------------------------------------------------- 1 | [#_FetchList] 2 | === FetchList 3 | 4 | *Package*: `typedb.api.analyze.fetch` 5 | 6 | *Supertypes:* 7 | 8 | * `Fetch` 9 | 10 | A list of Fetch documents. 11 | 12 | // tag::methods[] 13 | [#_FetchList_element_] 14 | ==== element 15 | 16 | [source,python] 17 | ---- 18 | element() -> Fetch 19 | ---- 20 | 21 | The element type of the list. 22 | 23 | [caption=""] 24 | .Returns 25 | `Fetch` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/cpp/answer/JSONType.adoc: -------------------------------------------------------------------------------- 1 | [#_JSONType] 2 | === JSONType 3 | 4 | *Package*: `TypeDB` 5 | 6 | 7 | 8 | Specifies the exact type of this JSON object 9 | 10 | [caption=""] 11 | .Enum constants 12 | // tag::enum_constants[] 13 | [cols=""] 14 | [options="header"] 15 | |=== 16 | |Name 17 | a| `ARRAY` 18 | a| `BOOLEAN` 19 | a| `DOUBLE` 20 | a| `INVALID` 21 | a| `LONG` 22 | a| `MAP` 23 | a| `NULL_VALUE` 24 | a| `STRING` 25 | |=== 26 | // end::enum_constants[] 27 | 28 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/LimitStage.adoc: -------------------------------------------------------------------------------- 1 | [#_LimitStage] 2 | === LimitStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents a ‘limit’ stage: limit <limit> 11 | 12 | // tag::methods[] 13 | [#_LimitStage_limit_] 14 | ==== limit 15 | 16 | [source,python] 17 | ---- 18 | limit() -> int 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `int` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/nodejs/answer/Explainable.adoc: -------------------------------------------------------------------------------- 1 | [#_Explainable] 2 | === Explainable 3 | 4 | Contains an explainable object. 5 | 6 | [caption=""] 7 | .Fields 8 | // tag::properties[] 9 | [cols=",,"] 10 | [options="header"] 11 | |=== 12 | |Name |Type |Description 13 | a| `conjunction` a| `string` a| The subquery of the original query that is actually being explained. 14 | a| `id` a| `number` a| A unique ID that identifies this Explainable. 15 | |=== 16 | // end::properties[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/PutStage.adoc: -------------------------------------------------------------------------------- 1 | [#_PutStage] 2 | === PutStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents a ‘put’ stage: put <block> 11 | 12 | // tag::methods[] 13 | [#_PutStage_block_] 14 | ==== block 15 | 16 | [source,python] 17 | ---- 18 | block() -> ConjunctionID 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConjunctionID` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/LANGUAGE_DRIVER_REQUEST.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Language Driver Request 3 | about: Request a new language driver here, or visit forum.typedb.com for ideas and questions 4 | --- 5 | 6 | Before raising this issue, check if there is an existing issue for the language driver you want. If there is, please upvote or comment on it, rather than raising a duplicate issue. If there isn't, submit this new issue with the title: "Language Driver Request for {language}". Finally, please remove this line. 7 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/OffsetStage.adoc: -------------------------------------------------------------------------------- 1 | [#_OffsetStage] 2 | === OffsetStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents an ‘offset’ stage: offset <offset> 11 | 12 | // tag::methods[] 13 | [#_OffsetStage_offset_] 14 | ==== offset 15 | 16 | [source,python] 17 | ---- 18 | offset() -> int 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `int` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/FetchLeaf.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_FetchLeaf] 2 | === FetchLeaf 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | 9 | Holds typing information about a leaf value in a ``Fetch`` document. 10 | 11 | [caption=""] 12 | .Fields 13 | // tag::properties[] 14 | [cols=",,"] 15 | [options="header"] 16 | |=== 17 | |Name |Type |Description 18 | a| `annotations` a| `Vec` a| The ``ValueType`` this value can be. 19 | |=== 20 | // end::properties[] 21 | 22 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/concept/Kind.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_Kind] 2 | === Kind 3 | 4 | Kind represents the base of a defined type to describe its capabilities. For example, “define entity person;” defines a type “person” of a kind “entity”. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Attribute = 1` 14 | a| `Entity = 0` 15 | a| `Relation = 2` 16 | a| `Role = 3` 17 | |=== 18 | // end::enum_constants[] 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/errors/MigrationError.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_MigrationError] 2 | === MigrationError 3 | 4 | [caption=""] 5 | .Enum variants 6 | // tag::enum_constants[] 7 | [cols=""] 8 | [options="header"] 9 | |=== 10 | |Variant 11 | a| `CannotCreateExportFile` 12 | a| `CannotDecodeImportedConcept` 13 | a| `CannotDecodeImportedConceptLength` 14 | a| `CannotEncodeExportedConcept` 15 | a| `CannotExportToTheSameFile` 16 | a| `CannotOpenImportFile` 17 | |=== 18 | // end::enum_constants[] 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintComparison.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintComparison] 2 | ==== ConstraintComparison 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `comparator` a| `string` a| 12 | a| `lhs` a| `ConstraintVertexVariable` a| 13 | a| `rhs` a| `ConstraintVertexVariable` a| 14 | a| `tag` a| `"comparison"` a| 15 | a| `textSpan` a| `ConstraintSpan` a| 16 | |=== 17 | // end::properties[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintLinks.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintLinks] 2 | ==== ConstraintLinks 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `player` a| `ConstraintVertexVariable` a| 12 | a| `relation` a| `ConstraintVertexVariable` a| 13 | a| `role` a| `ConstraintVertexVariable` a| 14 | a| `tag` a| `"links"` a| 15 | a| `textSpan` a| `ConstraintSpan` a| 16 | |=== 17 | // end::properties[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintExpression.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintExpression] 2 | ==== ConstraintExpression 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `arguments` a| `ConstraintVertexVariable` a| 12 | a| `assigned` a| `ConstraintVertexVariable` a| 13 | a| `tag` a| `"expression"` a| 14 | a| `text` a| `string` a| 15 | a| `textSpan` a| `ConstraintSpan` a| 16 | |=== 17 | // end::properties[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintFunction.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintFunction] 2 | ==== ConstraintFunction 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `arguments` a| `ConstraintVertexVariable` a| 12 | a| `assigned` a| `ConstraintVertexVariable` a| 13 | a| `name` a| `string` a| 14 | a| `tag` a| `"functionCall"` a| 15 | a| `textSpan` a| `ConstraintSpan` a| 16 | |=== 17 | // end::properties[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/ConceptRowsQueryResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_ConceptRowsQueryResponse] 2 | === ConceptRowsQueryResponse 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `answerType` a| `"conceptRows"` a| 12 | a| `answers` a| `ConceptRowAnswer` a| 13 | a| `comment` a| `string` a| 14 | a| `query` a| `AnalyzedPipeline` a| 15 | a| `queryType` a| `QueryType` a| 16 | |=== 17 | // end::properties[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/InsertStage.adoc: -------------------------------------------------------------------------------- 1 | [#_InsertStage] 2 | === InsertStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents an ‘insert’ stage: insert <block> 11 | 12 | // tag::methods[] 13 | [#_InsertStage_block_] 14 | ==== block 15 | 16 | [source,python] 17 | ---- 18 | block() -> ConjunctionID 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConjunctionID` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/UpdateStage.adoc: -------------------------------------------------------------------------------- 1 | [#_UpdateStage] 2 | === UpdateStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents an ‘update’ stage: update <block> 11 | 12 | // tag::methods[] 13 | [#_UpdateStage_block_] 14 | ==== block 15 | 16 | [source,python] 17 | ---- 18 | block() -> ConjunctionID 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConjunctionID` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/cpp/answer/Iterator.adoc: -------------------------------------------------------------------------------- 1 | [#_Iterator] 2 | === Iterator 3 | 4 | *Package*: `TypeDB` 5 | 6 | 7 | 8 | A structure emulating std::iterator, used for streaming of query results from the server. 9 | 10 | It is an ``input_iterator``, meaning it can only be consumed once. Valid operations are ``++it`` and ``*it`` 11 | 12 | Note that ``it++`` is deleted, and ``*it`` can only be called once per iterator position, owing to the move semantics of the returned data. 13 | 14 | Also see ``Iterable`` 15 | 16 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/response/ConceptDocumentsQueryResponse.adoc: -------------------------------------------------------------------------------- 1 | [#_ConceptDocumentsQueryResponse] 2 | === ConceptDocumentsQueryResponse 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `answerType` a| `"conceptDocuments"` a| 12 | a| `answers` a| `Object` a| 13 | a| `comment` a| `string` a| 14 | a| `query` a| `AnalyzedPipeline` a| 15 | a| `queryType` a| `QueryType` a| 16 | |=== 17 | // end::properties[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/cpp/session/SessionType.adoc: -------------------------------------------------------------------------------- 1 | [#_SessionType] 2 | === SessionType 3 | 4 | *Package*: `TypeDB` 5 | 6 | 7 | 8 | Used to specify the type of the session. 9 | 10 | 11 | [caption=""] 12 | .Examples 13 | [source,cpp] 14 | ---- 15 | driver.session(database, TypeDBSession.Type.SCHEMA); 16 | ---- 17 | 18 | [caption=""] 19 | .Enum constants 20 | // tag::enum_constants[] 21 | [cols=""] 22 | [options="header"] 23 | |=== 24 | |Name 25 | a| `DATA` 26 | a| `SCHEMA` 27 | |=== 28 | // end::enum_constants[] 29 | 30 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/AnalyzedFunction.adoc: -------------------------------------------------------------------------------- 1 | [#_AnalyzedFunction] 2 | === AnalyzedFunction 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `argumentAnnotations` a| `VariableAnnotations` a| 12 | a| `arguments` a| `string` a| 13 | a| `body` a| `AnalyzedPipeline` a| 14 | a| `returnAnnotations` a| `VariableAnnotations` a| 15 | a| `returns` a| `FunctionReturnStructure` a| 16 | |=== 17 | // end::properties[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/legacy/ConstraintLinksLegacy.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintLinksLegacy] 2 | ==== ConstraintLinksLegacy 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `player` a| `ConstraintVertexVariable` a| 12 | a| `relation` a| `ConstraintVertexVariable` a| 13 | a| `role` a| `ConstraintVertexVariable` a| 14 | a| `tag` a| `"links"` a| 15 | a| `textSpan` a| `ConstraintSpan` a| 16 | |=== 17 | // end::properties[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/cpp/transaction/TransactionType.adoc: -------------------------------------------------------------------------------- 1 | [#_TransactionType] 2 | === TransactionType 3 | 4 | *Package*: `TypeDB` 5 | 6 | 7 | 8 | Used to specify the type of transaction. 9 | 10 | 11 | [caption=""] 12 | .Examples 13 | [source,cpp] 14 | ---- 15 | session.transaction(TransactionType.READ); 16 | ---- 17 | 18 | [caption=""] 19 | .Enum constants 20 | // tag::enum_constants[] 21 | [cols=""] 22 | [options="header"] 23 | |=== 24 | |Name 25 | a| `READ` 26 | a| `WRITE` 27 | |=== 28 | // end::enum_constants[] 29 | 30 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/csharp/session/SessionType.adoc: -------------------------------------------------------------------------------- 1 | [#_SessionType] 2 | === SessionType 3 | 4 | *Package*: `TypeDB.Driver.Api` 5 | 6 | 7 | 8 | Used to specify the type of the session. 9 | 10 | 11 | [caption=""] 12 | .Examples 13 | [source,cs] 14 | ---- 15 | driver.Session(database, SessionType.Schema); 16 | ---- 17 | 18 | [caption=""] 19 | .Enum constants 20 | // tag::enum_constants[] 21 | [cols=""] 22 | [options="header"] 23 | |=== 24 | |Name 25 | a| `Data` 26 | a| `Schema` 27 | |=== 28 | // end::enum_constants[] 29 | 30 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/legacy/ConceptRowsQueryResponseLegacy.adoc: -------------------------------------------------------------------------------- 1 | [#_ConceptRowsQueryResponseLegacy] 2 | === ConceptRowsQueryResponseLegacy 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `answerType` a| `"conceptRows"` a| 12 | a| `answers` a| `ConceptRowAnswer` a| 13 | a| `comment` a| `string` a| 14 | a| `query` a| `QueryStructureLegacy` a| 15 | a| `queryType` a| `QueryType` a| 16 | |=== 17 | // end::properties[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/legacy/ConstraintExpressionLegacy.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintExpressionLegacy] 2 | ==== ConstraintExpressionLegacy 3 | 4 | [caption=""] 5 | .Fields 6 | // tag::properties[] 7 | [cols=",,"] 8 | [options="header"] 9 | |=== 10 | |Name |Type |Description 11 | a| `arguments` a| `ConstraintVertexVariable` a| 12 | a| `assigned` a| `ConstraintVertexVariable` a| 13 | a| `tag` a| `"expression"` a| 14 | a| `text` a| `string` a| 15 | a| `textSpan` a| `ConstraintSpan` a| 16 | |=== 17 | // end::properties[] 18 | 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Not.adoc: -------------------------------------------------------------------------------- 1 | [#_Not] 2 | === Not 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents a ‘not’ constraint: not { <conjunction> } 11 | 12 | // tag::methods[] 13 | [#_Not_conjunction_] 14 | ==== conjunction 15 | 16 | [source,python] 17 | ---- 18 | conjunction() -> ConjunctionID 19 | ---- 20 | 21 | Index into Pipeline.conjunctions 22 | 23 | [caption=""] 24 | .Returns 25 | `ConjunctionID` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Try.adoc: -------------------------------------------------------------------------------- 1 | [#_Try] 2 | === Try 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents a ‘try’ constraint: try { <conjunction> } 11 | 12 | // tag::methods[] 13 | [#_Try_conjunction_] 14 | ==== conjunction 15 | 16 | [source,python] 17 | ---- 18 | conjunction() -> ConjunctionID 19 | ---- 20 | 21 | Index into Pipeline.conjunctions 22 | 23 | [caption=""] 24 | .Returns 25 | `ConjunctionID` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/errors/Error.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_Error] 2 | === Error 3 | 4 | Represents errors encountered during operation. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Analyze(AnalyzeError)` 14 | a| `Concept(ConceptError)` 15 | a| `Connection(ConnectionError)` 16 | a| `Internal(InternalError)` 17 | a| `Migration(MigrationError)` 18 | a| `Other(String)` 19 | a| `Server(ServerError)` 20 | |=== 21 | // end::enum_constants[] 22 | 23 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/schema/ValueType.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_ValueType] 2 | === ValueType 3 | 4 | Represents the type of primitive value is held by a Value or Attribute. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Boolean` 14 | a| `Date` 15 | a| `Datetime` 16 | a| `DatetimeTZ` 17 | a| `Decimal` 18 | a| `Double` 19 | a| `Duration` 20 | a| `Integer` 21 | a| `String` 22 | a| `Struct(String)` 23 | |=== 24 | // end::enum_constants[] 25 | 26 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/PipelineStage.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_PipelineStage] 2 | === PipelineStage 3 | 4 | Representation of a stage in a Pipeline. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Delete` 14 | a| `Distinct` 15 | a| `Insert` 16 | a| `Limit` 17 | a| `Match` 18 | a| `Offset` 19 | a| `Put` 20 | a| `Reduce` 21 | a| `Require` 22 | a| `Select` 23 | a| `Sort` 24 | a| `Update` 25 | |=== 26 | // end::enum_constants[] 27 | 28 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/MatchStage.adoc: -------------------------------------------------------------------------------- 1 | [#_MatchStage] 2 | === MatchStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents a ‘match’ stage: match <block> 11 | 12 | // tag::methods[] 13 | [#_MatchStage_block_] 14 | ==== block 15 | 16 | [source,python] 17 | ---- 18 | block() -> ConjunctionID 19 | ---- 20 | 21 | The index into Pipeline.conjunctions. 22 | 23 | [caption=""] 24 | .Returns 25 | `ConjunctionID` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/SelectStage.adoc: -------------------------------------------------------------------------------- 1 | [#_SelectStage] 2 | === SelectStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents a ‘select’ stage: select <variables> 11 | 12 | // tag::methods[] 13 | [#_SelectStage_variables_] 14 | ==== variables 15 | 16 | [source,python] 17 | ---- 18 | variables() -> Iterator['Variable'] 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `Iterator['Variable']` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/SortStage.adoc: -------------------------------------------------------------------------------- 1 | [#_SortStage] 2 | === SortStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents a ‘sort’ stage: sort <variables-and-order> 11 | 12 | // tag::methods[] 13 | [#_SortStage_variables_] 14 | ==== variables 15 | 16 | [source,python] 17 | ---- 18 | variables() -> Iterator[SortVariable] 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `Iterator[SortVariable]` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/schema/Type.adoc: -------------------------------------------------------------------------------- 1 | [#_Type] 2 | === Type 3 | 4 | *Package*: `typedb.api.concept.type.type` 5 | 6 | *Supertypes:* 7 | 8 | * `Concept` 9 | 10 | // tag::methods[] 11 | [#_Type_is_type_] 12 | ==== is_type 13 | 14 | [source,python] 15 | ---- 16 | is_type() -> bool 17 | ---- 18 | 19 | Checks if the concept is a ``Type``. 20 | 21 | [caption=""] 22 | .Returns 23 | `bool` 24 | 25 | [caption=""] 26 | .Code examples 27 | [source,python] 28 | ---- 29 | type_.is_type() 30 | ---- 31 | 32 | // end::methods[] 33 | 34 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/csharp/transaction/TransactionType.adoc: -------------------------------------------------------------------------------- 1 | [#_TransactionType] 2 | === TransactionType 3 | 4 | *Package*: `TypeDB.Driver.Api` 5 | 6 | 7 | 8 | Used to specify the type of transaction. 9 | 10 | 11 | [caption=""] 12 | .Examples 13 | [source,cs] 14 | ---- 15 | session.Transaction(TransactionType.Read); 16 | ---- 17 | 18 | [caption=""] 19 | .Enum constants 20 | // tag::enum_constants[] 21 | [cols=""] 22 | [options="header"] 23 | |=== 24 | |Name 25 | a| `Read` 26 | a| `Write` 27 | |=== 28 | // end::enum_constants[] 29 | 30 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/RequireStage.adoc: -------------------------------------------------------------------------------- 1 | [#_RequireStage] 2 | === RequireStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents a ‘require’ stage: require <variables> 11 | 12 | // tag::methods[] 13 | [#_RequireStage_variables_] 14 | ==== variables 15 | 16 | [source,python] 17 | ---- 18 | variables() -> Iterator['Variable'] 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `Iterator['Variable']` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/SortVariable.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_SortVariable] 2 | === SortVariable 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | 9 | The variable being sorted on and the ordering of the sort, as used in a ``PipelineStage::Sort``, e.g. ``sort $v desc`` 10 | 11 | [caption=""] 12 | .Fields 13 | // tag::properties[] 14 | [cols=",,"] 15 | [options="header"] 16 | |=== 17 | |Name |Type |Description 18 | a| `order` a| `SortOrder` a| 19 | a| `variable` a| `Variable` a| 20 | |=== 21 | // end::properties[] 22 | 23 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/ReturnOperationStream.adoc: -------------------------------------------------------------------------------- 1 | [#_ReturnOperationStream] 2 | === ReturnOperationStream 3 | 4 | *Package*: `typedb.api.analyze.function` 5 | 6 | *Supertypes:* 7 | 8 | * `ReturnOperation` 9 | 10 | // tag::methods[] 11 | [#_ReturnOperationStream_variables_] 12 | ==== variables 13 | 14 | [source,python] 15 | ---- 16 | variables() -> Iterator['Variable'] 17 | ---- 18 | 19 | Gets the variables in the returned row. 20 | 21 | [caption=""] 22 | .Returns 23 | `Iterator['Variable']` 24 | 25 | // end::methods[] 26 | 27 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/ReduceAssignment.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_ReduceAssignment] 2 | === ReduceAssignment 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | 9 | Representation of an assignment from a reduction in a ``PipelineStage::Reduce``, such as ``reduce $c = sum($x);`` 10 | 11 | [caption=""] 12 | .Fields 13 | // tag::properties[] 14 | [cols=",,"] 15 | [options="header"] 16 | |=== 17 | |Name |Type |Description 18 | a| `assigned` a| `Variable` a| 19 | a| `reducer` a| `Reducer` a| 20 | |=== 21 | // end::properties[] 22 | 23 | -------------------------------------------------------------------------------- /python/index.rst: -------------------------------------------------------------------------------- 1 | .. typedb-driver documentation master file, created by 2 | sphinx-quickstart on Fri Sep 15 16:13:51 2023. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | Welcome to typedb-driver's documentation! 7 | ========================================= 8 | 9 | .. toctree:: 10 | :maxdepth: 2 11 | :caption: Contents: 12 | 13 | 14 | 15 | Indices and tables 16 | ================== 17 | 18 | * :ref:`genindex` 19 | * :ref:`modindex` 20 | * :ref:`search` 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/analyze/Fetch.FetchLeaf.adoc: -------------------------------------------------------------------------------- 1 | [#_Fetch_FetchLeaf] 2 | === Fetch.FetchLeaf 3 | 4 | *Package*: `com.typedb.driver.api.analyze` 5 | 6 | The leaf of a Fetch object. Holds information on the value it can hold. 7 | 8 | // tag::methods[] 9 | [#_Fetch_FetchLeaf_annotations_] 10 | ==== annotations 11 | 12 | [source,java] 13 | ---- 14 | java.util.stream.Stream annotations() 15 | ---- 16 | 17 | 18 | 19 | [caption=""] 20 | .Returns 21 | `java.util.stream.Stream` 22 | 23 | // end::methods[] 24 | 25 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/ReturnOperationReduce.adoc: -------------------------------------------------------------------------------- 1 | [#_ReturnOperationReduce] 2 | === ReturnOperationReduce 3 | 4 | *Package*: `typedb.api.analyze.function` 5 | 6 | *Supertypes:* 7 | 8 | * `ReturnOperation` 9 | 10 | // tag::methods[] 11 | [#_ReturnOperationReduce_reducers_] 12 | ==== reducers 13 | 14 | [source,python] 15 | ---- 16 | reducers() -> Iterator['Reducer'] 17 | ---- 18 | 19 | Gets the reducers used to compute the aggregations. 20 | 21 | [caption=""] 22 | .Returns 23 | `Iterator['Reducer']` 24 | 25 | // end::methods[] 26 | 27 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/NamedRole.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_NamedRole] 2 | === NamedRole 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | * `PartialEq` 9 | 10 | A ``NamedRole`` vertex is used in links & relates constraints, as multiple relations may have roles with the same name. 11 | 12 | [caption=""] 13 | .Fields 14 | // tag::properties[] 15 | [cols=",,"] 16 | [options="header"] 17 | |=== 18 | |Name |Type |Description 19 | a| `name` a| `String` a| 20 | a| `variable` a| `Variable` a| 21 | |=== 22 | // end::properties[] 23 | 24 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/FetchLeaf.adoc: -------------------------------------------------------------------------------- 1 | [#_FetchLeaf] 2 | === FetchLeaf 3 | 4 | *Package*: `typedb.api.analyze.fetch` 5 | 6 | *Supertypes:* 7 | 8 | * `Fetch` 9 | 10 | The leaf of a Fetch object. Holds information on the value it can hold. 11 | 12 | // tag::methods[] 13 | [#_FetchLeaf_annotations_] 14 | ==== annotations 15 | 16 | [source,python] 17 | ---- 18 | annotations() -> Iterator[str] 19 | ---- 20 | 21 | The possible ValueType(s) as strings. 22 | 23 | [caption=""] 24 | .Returns 25 | `Iterator[str]` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/nodejs/answer/ValueGroup.adoc: -------------------------------------------------------------------------------- 1 | [#_ValueGroup] 2 | === ValueGroup 3 | 4 | Contains an element of the group aggregate query result. 5 | 6 | [caption=""] 7 | .Fields 8 | // tag::properties[] 9 | [cols=",,"] 10 | [options="header"] 11 | |=== 12 | |Name |Type |Description 13 | a| `owner` a| `Concept` a| Retrieves the concept that is the group owner. Examples valueGroup.owner 14 | Copy 15 | a| `value` a| `Value` a| Retrieves the Value answer of the group, if there is one. Examples valueGroup.value 16 | Copy 17 | |=== 18 | // end::properties[] 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Or.adoc: -------------------------------------------------------------------------------- 1 | [#_Or] 2 | === Or 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents an ‘or’ constraint: { <branches[0]> } or { <branches[1]> } [or …] 11 | 12 | // tag::methods[] 13 | [#_Or_branches_] 14 | ==== branches 15 | 16 | [source,python] 17 | ---- 18 | branches() -> Iterator['ConjunctionID'] 19 | ---- 20 | 21 | Index into Pipeline.conjunctions 22 | 23 | [caption=""] 24 | .Returns 25 | `Iterator['ConjunctionID']` 26 | 27 | // end::methods[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/ConstraintExactness.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_ConstraintExactness] 2 | === ConstraintExactness 3 | 4 | Tells apart exact variants of constraints from the ones allowing subtype-polymorphism. e.g. isa! would be represented as an Constraint::Isa with its exactness field ConstraintExactness::Exact. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Exact = 0` 14 | a| `Subtypes = 1` 15 | |=== 16 | // end::enum_constants[] 17 | 18 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/cpp/concept/ConceptType.adoc: -------------------------------------------------------------------------------- 1 | [#_ConceptType] 2 | === ConceptType 3 | 4 | *Package*: `TypeDB` 5 | 6 | 7 | 8 | The exact type of a Concept object. Use for downcasting to the appropriate type. 9 | 10 | [caption=""] 11 | .Enum constants 12 | // tag::enum_constants[] 13 | [cols=""] 14 | [options="header"] 15 | |=== 16 | |Name 17 | a| `ATTRIBUTE` 18 | a| `ATTRIBUTE_TYPE` 19 | a| `ENTITY` 20 | a| `ENTITY_TYPE` 21 | a| `RELATION` 22 | a| `RELATION_TYPE` 23 | a| `ROLE_TYPE` 24 | a| `ROOT_THING_TYPE` 25 | a| `VALUE` 26 | |=== 27 | // end::enum_constants[] 28 | 29 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/ConjunctionID.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_ConjunctionID] 2 | === ConjunctionID 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Copy` 8 | * `Debug` 9 | * `PartialEq` 10 | * `StructuralPartialEq` 11 | 12 | Holds the index of the conjunction in a ``Pipeline``’s ``conjunctions`` field. Used as indirection in the representation of a pipeline. 13 | 14 | [caption=""] 15 | .Fields 16 | // tag::properties[] 17 | [cols=",,"] 18 | [options="header"] 19 | |=== 20 | |Name |Type |Description 21 | a| `0` a| `usize` a| 22 | |=== 23 | // end::properties[] 24 | 25 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/ConstraintSpan.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_ConstraintSpan] 2 | === ConstraintSpan 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | 9 | The span of a constraint in the ``source`` of the ``AnalyzedQuery``. 10 | 11 | [caption=""] 12 | .Fields 13 | // tag::properties[] 14 | [cols=",,"] 15 | [options="header"] 16 | |=== 17 | |Name |Type |Description 18 | a| `begin` a| `usize` a| The offset of the first character in the span 19 | a| `end` a| `usize` a| The offset after the last character in the span 20 | |=== 21 | // end::properties[] 22 | 23 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/Reducer.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_Reducer] 2 | === Reducer 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | 9 | Representation of a reducer used either in a ``PipelineStage::Reduce`` or in a function’s ``ReturnOperation``. 10 | 11 | [caption=""] 12 | .Fields 13 | // tag::properties[] 14 | [cols=",,"] 15 | [options="header"] 16 | |=== 17 | |Name |Type |Description 18 | a| `arguments` a| `Vec` a| The arguments to the reducer. 19 | a| `reducer` a| `String` a| The reduce operation applied 20 | |=== 21 | // end::properties[] 22 | 23 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/Variable.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_Variable] 2 | === Variable 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | * `Eq` 9 | * `Hash` 10 | * `PartialEq` 11 | * `StructuralPartialEq` 12 | 13 | Uniquely identifies a variable in a ``Pipeline``pipeline. Its name (if any) can be retrieved from the ``variable_names`` field in ``Pipeline`` 14 | 15 | [caption=""] 16 | .Fields 17 | // tag::properties[] 18 | [cols=",,"] 19 | [options="header"] 20 | |=== 21 | |Name |Type |Description 22 | a| `0` a| `u32` a| 23 | |=== 24 | // end::properties[] 25 | 26 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/ConstraintVertex.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_ConstraintVertex] 2 | === ConstraintVertex 3 | 4 | The answer to a TypeDB query is a set of concepts which satisfy the Constraints in the query. A ConstraintVertex is either a variable, or some identifier of the concept. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Label(Type)` 14 | a| `NamedRole(NamedRole)` 15 | a| `Value(Value)` 16 | a| `Variable(Variable)` 17 | |=== 18 | // end::enum_constants[] 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/cpp/answer/OwnerAttributePair.adoc: -------------------------------------------------------------------------------- 1 | [#_OwnerAttributePair] 2 | === OwnerAttributePair 3 | 4 | *Package*: `TypeDB` 5 | 6 | 7 | 8 | Simple class holding the owner concept & owned attribute identifying an explainable ownership. 9 | 10 | [caption=""] 11 | .Fields 12 | // tag::properties[] 13 | [cols=",,"] 14 | [options="header"] 15 | |=== 16 | |Name |Type |Description 17 | a| `attribute` a| `std::string TypeDB::OwnerAttributePair` a| The owned attribute. 18 | a| `owner` a| `std::string TypeDB::OwnerAttributePair` a| The owner concept. 19 | |=== 20 | // end::properties[] 21 | 22 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/Constraint.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_Constraint] 2 | === Constraint 3 | 4 | A representation of a TypeQL constraint. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Comparison` 14 | a| `Expression` 15 | a| `FunctionCall` 16 | a| `Has` 17 | a| `Iid` 18 | a| `Is` 19 | a| `Isa` 20 | a| `Kind` 21 | a| `Label` 22 | a| `Links` 23 | a| `Not` 24 | a| `Or` 25 | a| `Owns` 26 | a| `Plays` 27 | a| `Relates` 28 | a| `Sub` 29 | a| `Try` 30 | a| `Value` 31 | |=== 32 | // end::enum_constants[] 33 | 34 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/csharp/data/ValueType.adoc: -------------------------------------------------------------------------------- 1 | [#_ValueType] 2 | === ValueType 3 | 4 | *Package*: `TypeDB.Driver.Api.IValue` 5 | 6 | 7 | 8 | Used to specify the type of the value. 9 | 10 | 11 | [caption=""] 12 | .Examples 13 | [source,cs] 14 | ---- 15 | thingType.GetOwns(transaction, IValue.ValueType.String); 16 | ---- 17 | 18 | [caption=""] 19 | .Enum constants 20 | // tag::enum_constants[] 21 | [cols=""] 22 | [options="header"] 23 | |=== 24 | |Name 25 | a| `Bool` 26 | a| `DateTime` 27 | a| `Double` 28 | a| `Long` 29 | a| `Object` 30 | a| `String` 31 | |=== 32 | // end::enum_constants[] 33 | 34 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/analyze/Constraint.Span.adoc: -------------------------------------------------------------------------------- 1 | [#_Constraint_Span] 2 | === Constraint.Span 3 | 4 | *Package*: `com.typedb.driver.api.analyze` 5 | 6 | The span of a constraint in the source query 7 | 8 | // tag::methods[] 9 | [#_Constraint_Span_begin_] 10 | ==== begin 11 | 12 | [source,java] 13 | ---- 14 | long begin() 15 | ---- 16 | 17 | 18 | 19 | [caption=""] 20 | .Returns 21 | `long` 22 | 23 | [#_Constraint_Span_end_] 24 | ==== end 25 | 26 | [source,java] 27 | ---- 28 | long end() 29 | ---- 30 | 31 | 32 | 33 | [caption=""] 34 | .Returns 35 | `long` 36 | 37 | // end::methods[] 38 | 39 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/connection/DriverOptions.adoc: -------------------------------------------------------------------------------- 1 | [#_DriverOptions] 2 | === DriverOptions 3 | 4 | *Package*: `typedb.api.connection.driver_options` 5 | 6 | User credentials and TLS encryption settings for connecting to TypeDB Server. Arguments: 1) is_tls_enabled: Specify whether the connection to TypeDB must be done over TLS. 2) tls_root_ca_path: Path to the CA certificate to use for authenticating server certificates. 7 | 8 | [caption=""] 9 | .Examples 10 | [source,python] 11 | ---- 12 | driver_options = DriverOptions(is_tls_enabled=True, tls_root_ca_path="path/to/ca-certificate.pem") 13 | ---- 14 | 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/csharp/concept/Transitivity.adoc: -------------------------------------------------------------------------------- 1 | [#_Transitivity] 2 | === Transitivity 3 | 4 | *Package*: `TypeDB.Driver.Api.IConcept` 5 | 6 | 7 | 8 | This class is used for specifying whether we need explicit or transitive subtyping, instances, etc. 9 | 10 | 11 | [caption=""] 12 | .Examples 13 | [source,cs] 14 | ---- 15 | attributeType.GetOwners(transaction, annotation, Explicit); 16 | ---- 17 | 18 | [caption=""] 19 | .Enum constants 20 | // tag::enum_constants[] 21 | [cols=""] 22 | [options="header"] 23 | |=== 24 | |Name 25 | a| `Explicit` 26 | a| `Transitive` 27 | |=== 28 | // end::enum_constants[] 29 | 30 | -------------------------------------------------------------------------------- /http-ts/tsup.config.ts: -------------------------------------------------------------------------------- 1 | import type { Options } from "tsup"; 2 | 3 | const env = process.env.NODE_ENV; 4 | 5 | const tsup: Options = { 6 | splitting: true, 7 | sourcemap: true, 8 | clean: true, 9 | dts: true, 10 | format: ["cjs", "esm"], 11 | outExtension({ format }) { 12 | return { 13 | js: format === "esm" ? ".mjs" : ".cjs", 14 | }; 15 | }, 16 | minify: false, 17 | bundle: true, 18 | skipNodeModulesBundle: true, 19 | watch: false, 20 | target: "es2020", 21 | outDir: "dist", 22 | entry: ["src/index.ts"], 23 | }; 24 | 25 | export default tsup; 26 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Span.adoc: -------------------------------------------------------------------------------- 1 | [#_Span] 2 | === Span 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | The span of a constraint in the source query. 7 | 8 | // tag::methods[] 9 | [#_Span_begin_] 10 | ==== begin 11 | 12 | [source,python] 13 | ---- 14 | begin() -> int 15 | ---- 16 | 17 | The offset of the first character. 18 | 19 | [caption=""] 20 | .Returns 21 | `int` 22 | 23 | [#_Span_end_] 24 | ==== end 25 | 26 | [source,python] 27 | ---- 28 | end() -> int 29 | ---- 30 | 31 | The offset after the last character. 32 | 33 | [caption=""] 34 | .Returns 35 | `int` 36 | 37 | // end::methods[] 38 | 39 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/SortVariable.adoc: -------------------------------------------------------------------------------- 1 | [#_SortVariable] 2 | === SortVariable 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage.SortStage` 5 | 6 | A variable and its sort order. 7 | 8 | // tag::methods[] 9 | [#_SortVariable_order_] 10 | ==== order 11 | 12 | [source,python] 13 | ---- 14 | order() -> SortOrder 15 | ---- 16 | 17 | 18 | 19 | [caption=""] 20 | .Returns 21 | `SortOrder` 22 | 23 | [#_SortVariable_variable_] 24 | ==== variable 25 | 26 | [source,python] 27 | ---- 28 | variable() -> Variable 29 | ---- 30 | 31 | 32 | 33 | [caption=""] 34 | .Returns 35 | `Variable` 36 | 37 | // end::methods[] 38 | 39 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/ConstraintAny.adoc: -------------------------------------------------------------------------------- 1 | [#_ConstraintAny] 2 | ==== ConstraintAny 3 | 4 | [source,typescript] 5 | ---- 6 | ConstraintAny: 7 | | ConstraintIsa 8 | | ConstraintIsaExact 9 | | ConstraintHas 10 | | ConstraintLinks 11 | | ConstraintSub 12 | | ConstraintSubExact 13 | | ConstraintOwns 14 | | ConstraintRelates 15 | | ConstraintPlays 16 | | ConstraintExpression 17 | | ConstraintFunction 18 | | ConstraintComparison 19 | | ConstraintIs 20 | | ConstraintIid 21 | | ConstraintKind 22 | | ConstraintValue 23 | | ConstraintLabel 24 | | ConstraintOr 25 | | ConstraintNot 26 | | ConstraintTry 27 | ---- 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Iid.adoc: -------------------------------------------------------------------------------- 1 | [#_Iid] 2 | === Iid 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents an IID constraint: <concept> iid <iid> 11 | 12 | // tag::methods[] 13 | [#_Iid_iid_] 14 | ==== iid 15 | 16 | [source,python] 17 | ---- 18 | iid() -> str 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `str` 26 | 27 | [#_Iid_variable_] 28 | ==== variable 29 | 30 | [source,python] 31 | ---- 32 | variable() -> ConstraintVertex 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintVertex` 40 | 41 | // end::methods[] 42 | 43 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Is.adoc: -------------------------------------------------------------------------------- 1 | [#_Is] 2 | === Is 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents an ‘is’ constraint: <lhs> is <rhs> 11 | 12 | // tag::methods[] 13 | [#_Is_lhs_] 14 | ==== lhs 15 | 16 | [source,python] 17 | ---- 18 | lhs() -> ConstraintVertex 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConstraintVertex` 26 | 27 | [#_Is_rhs_] 28 | ==== rhs 29 | 30 | [source,python] 31 | ---- 32 | rhs() -> ConstraintVertex 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintVertex` 40 | 41 | // end::methods[] 42 | 43 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/c/schema/transitivity.adoc: -------------------------------------------------------------------------------- 1 | [#_methods_schema_transitivity] 2 | === transitivity 3 | 4 | [#_Struct_Transitivity] 5 | ==== Struct Transitivity 6 | 7 | 8 | 9 | Used for specifying whether we need explicit or transitive subtyping, instances, etc. 10 | 11 | 12 | [#_Enum_Transitivity] 13 | ==== Enum Transitivity 14 | 15 | 16 | 17 | Used for specifying whether we need explicit or transitive subtyping, instances, etc. 18 | 19 | 20 | [caption=""] 21 | .Enum constants 22 | // tag::enum_constants[] 23 | [cols=""] 24 | [options="header"] 25 | |=== 26 | |Name 27 | a| `Explicit` 28 | a| `Transitive` 29 | |=== 30 | // end::enum_constants[] 31 | 32 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/c/schema/valuetype.adoc: -------------------------------------------------------------------------------- 1 | [#_methods_schema_valuetype] 2 | === valuetype 3 | 4 | [#_Struct_ValueType] 5 | ==== Struct ValueType 6 | 7 | 8 | 9 | Represents the type of primitive value is held by a Value or Attribute. 10 | 11 | [#_Enum_ValueType] 12 | ==== Enum ValueType 13 | 14 | 15 | 16 | Represents the type of primitive value is held by a Value or Attribute. 17 | 18 | [caption=""] 19 | .Enum constants 20 | // tag::enum_constants[] 21 | [cols=""] 22 | [options="header"] 23 | |=== 24 | |Name 25 | a| `Boolean` 26 | a| `DateTime` 27 | a| `Double` 28 | a| `Long` 29 | a| `Object` 30 | a| `String` 31 | |=== 32 | // end::enum_constants[] 33 | 34 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/Conjunction.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_Conjunction] 2 | === Conjunction 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | 9 | A representation of the constraints involved in the query, and types inferred for each variable. 10 | 11 | [caption=""] 12 | .Fields 13 | // tag::properties[] 14 | [cols=",,"] 15 | [options="header"] 16 | |=== 17 | |Name |Type |Description 18 | a| `constraints` a| `Vec` a| The ``Constraint``s in the conjunction. 19 | a| `variable_annotations` a| `HashMap` a| The annotations of each variable in the conjunction. 20 | |=== 21 | // end::properties[] 22 | 23 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/ReduceAssignment.adoc: -------------------------------------------------------------------------------- 1 | [#_ReduceAssignment] 2 | === ReduceAssignment 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage.ReduceStage` 5 | 6 | An assignment of a reducer to a variable. 7 | 8 | // tag::methods[] 9 | [#_ReduceAssignment_assigned_] 10 | ==== assigned 11 | 12 | [source,python] 13 | ---- 14 | assigned() -> Variable 15 | ---- 16 | 17 | 18 | 19 | [caption=""] 20 | .Returns 21 | `Variable` 22 | 23 | [#_ReduceAssignment_reducer_] 24 | ==== reducer 25 | 26 | [source,python] 27 | ---- 28 | reducer() -> Reducer 29 | ---- 30 | 31 | 32 | 33 | [caption=""] 34 | .Returns 35 | `Reducer` 36 | 37 | // end::methods[] 38 | 39 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Label.adoc: -------------------------------------------------------------------------------- 1 | [#_Label] 2 | === Label 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents a label constraint: <type> label <label> 11 | 12 | // tag::methods[] 13 | [#_Label_label_] 14 | ==== label 15 | 16 | [source,python] 17 | ---- 18 | label() -> str 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `str` 26 | 27 | [#_Label_variable_] 28 | ==== variable 29 | 30 | [source,python] 31 | ---- 32 | variable() -> ConstraintVertex 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintVertex` 40 | 41 | // end::methods[] 42 | 43 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/legacy/legacyStaticFunctions.adoc: -------------------------------------------------------------------------------- 1 | [#_legacyStaticFunctions] 2 | === Static Functions 3 | 4 | // tag::methods[] 5 | [#_isQueryResponseLegacy_isQueryResponseLegacy_res_ConceptRowsQueryResponse] 6 | ==== isQueryResponseLegacy 7 | 8 | [source,typescript] 9 | ---- 10 | isQueryResponseLegacy( res: ConceptRowsQueryResponse | ConceptRowsQueryResponseLegacy, ): boolean 11 | ---- 12 | 13 | 14 | 15 | [caption=""] 16 | .Input parameters 17 | [cols=",,"] 18 | [options="header"] 19 | |=== 20 | |Name |Description |Type 21 | a| `res` a| a| `ConceptRowsQueryResponse` 22 | |=== 23 | 24 | [caption=""] 25 | .Returns 26 | `boolean` 27 | 28 | // end::methods[] 29 | 30 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Kind.adoc: -------------------------------------------------------------------------------- 1 | [#_Kind] 2 | === Kind 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents a kind constraint: <kind> <type> 11 | 12 | // tag::methods[] 13 | [#_Kind_kind_] 14 | ==== kind 15 | 16 | [source,python] 17 | ---- 18 | kind() -> typedb.common.enums.Kind 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `typedb.common.enums.Kind` 26 | 27 | [#_Kind_type_] 28 | ==== type 29 | 30 | [source,python] 31 | ---- 32 | type() -> ConstraintVertex 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintVertex` 40 | 41 | // end::methods[] 42 | 43 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/answer/Trait_Promise.adoc: -------------------------------------------------------------------------------- 1 | [#_trait_Promise] 2 | === Trait Promise 3 | 4 | [tabs] 5 | ==== 6 | async:: 7 | + 8 | -- 9 | Async promise, an alias for Rust’s built-in Future. A ``BoxPromise`` is an alias for Rust’s built-in BoxFuture. 10 | 11 | [caption=""] 12 | .Examples 13 | [source,rust] 14 | ---- 15 | promise.await 16 | ---- 17 | 18 | -- 19 | 20 | sync:: 21 | + 22 | -- 23 | A resolvable promise that can be resolved at a later time. a ``BoxPromise`` is in practical terms a ``Box<dyn Promise>`` and resolves with ``.resolve()``. 24 | 25 | [caption=""] 26 | .Examples 27 | [source,rust] 28 | ---- 29 | promise.resolve() 30 | ---- 31 | 32 | -- 33 | ==== 34 | 35 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/BUG_REPORT.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report 3 | about: Report a bug here, or visit forum.typedb.com for troubleshooting discussions 4 | title: '' 5 | labels: bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | ## Description 11 | 12 | 13 | ## Environment 14 | 15 | 1. TypeDB distribution: Core/Cloud 16 | 2. TypeDB version: 17 | 3. Environment: Linux/Mac/Windows/TypeDB Cloud/Google Cloud/AWS/Azure 18 | 4. Studio version: 19 | 5. Other details: 20 | 21 | ## Reproducible Steps 22 | 23 | 1. Set up 24 | 25 | 26 | 2. Execute 27 | 28 | 29 | 3. Unexpected result 30 | 31 | 32 | 33 | ## Expected result 34 | 35 | 36 | ## Additional information 37 | 38 | Relevant logs from TypeDB or Driver: 39 | 40 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Value.adoc: -------------------------------------------------------------------------------- 1 | [#_Value] 2 | === Value 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents a value constraint: <attribute_type> value <value_type> 11 | 12 | // tag::methods[] 13 | [#_Value_attribute_type_] 14 | ==== attribute_type 15 | 16 | [source,python] 17 | ---- 18 | attribute_type() -> ConstraintVertex 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConstraintVertex` 26 | 27 | [#_Value_value_type_] 28 | ==== value_type 29 | 30 | [source,python] 31 | ---- 32 | value_type() -> str 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `str` 40 | 41 | // end::methods[] 42 | 43 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/analyze/Fetch.FetchObject.adoc: -------------------------------------------------------------------------------- 1 | [#_Fetch_FetchObject] 2 | === Fetch.FetchObject 3 | 4 | *Package*: `com.typedb.driver.api.analyze` 5 | 6 | A mapping of string keys to ``Fetch`` documents. 7 | 8 | // tag::methods[] 9 | [#_Fetch_FetchObject_get_java_lang_String] 10 | ==== get 11 | 12 | [source,java] 13 | ---- 14 | Fetch get​(java.lang.String key) 15 | ---- 16 | 17 | 18 | 19 | [caption=""] 20 | .Returns 21 | `Fetch` 22 | 23 | [#_Fetch_FetchObject_keys_] 24 | ==== keys 25 | 26 | [source,java] 27 | ---- 28 | java.util.stream.Stream keys() 29 | ---- 30 | 31 | 32 | 33 | [caption=""] 34 | .Returns 35 | `java.util.stream.Stream` 36 | 37 | // end::methods[] 38 | 39 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/FetchObject.adoc: -------------------------------------------------------------------------------- 1 | [#_FetchObject] 2 | === FetchObject 3 | 4 | *Package*: `typedb.api.analyze.fetch` 5 | 6 | *Supertypes:* 7 | 8 | * `Fetch` 9 | 10 | A mapping of string keys to Fetch documents. 11 | 12 | // tag::methods[] 13 | [#_FetchObject_get_] 14 | ==== get 15 | 16 | [source,python] 17 | ---- 18 | get(key: str) -> Fetch 19 | ---- 20 | 21 | The Fetch object for the given key. 22 | 23 | [caption=""] 24 | .Returns 25 | `Fetch` 26 | 27 | [#_FetchObject_keys_] 28 | ==== keys 29 | 30 | [source,python] 31 | ---- 32 | keys() -> Iterator[str] 33 | ---- 34 | 35 | The available keys of this Fetch document. 36 | 37 | [caption=""] 38 | .Returns 39 | `Iterator[str]` 40 | 41 | // end::methods[] 42 | 43 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/analyze/Reducer.adoc: -------------------------------------------------------------------------------- 1 | [#_Reducer] 2 | === Reducer 3 | 4 | *Package*: `com.typedb.driver.api.analyze` 5 | 6 | Representation of a reducer used either in a ``PipelineStage::Reduce`` or in a function's ``ReturnOperation``. 7 | 8 | // tag::methods[] 9 | [#_Reducer_arguments_] 10 | ==== arguments 11 | 12 | [source,java] 13 | ---- 14 | java.util.stream.Stream arguments() 15 | ---- 16 | 17 | 18 | 19 | [caption=""] 20 | .Returns 21 | `java.util.stream.Stream` 22 | 23 | [#_Reducer_name_] 24 | ==== name 25 | 26 | [source,java] 27 | ---- 28 | java.lang.String name() 29 | ---- 30 | 31 | 32 | 33 | [caption=""] 34 | .Returns 35 | `java.lang.String` 36 | 37 | // end::methods[] 38 | 39 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Reducer.adoc: -------------------------------------------------------------------------------- 1 | [#_Reducer] 2 | === Reducer 3 | 4 | *Package*: `typedb.api.analyze.reducer` 5 | 6 | Representation of a reducer used either in a PipelineStage::Reduce or in a function’s ReturnOperation. 7 | 8 | // tag::methods[] 9 | [#_Reducer_arguments_] 10 | ==== arguments 11 | 12 | [source,python] 13 | ---- 14 | arguments() -> Iterator['Variable'] 15 | ---- 16 | 17 | The arguments to the reducer. 18 | 19 | [caption=""] 20 | .Returns 21 | `Iterator['Variable']` 22 | 23 | [#_Reducer_name_] 24 | ==== name 25 | 26 | [source,python] 27 | ---- 28 | name() -> str 29 | ---- 30 | 31 | The reduce operation applied (e.g. ‘sum’, ‘count’). 32 | 33 | [caption=""] 34 | .Returns 35 | `str` 36 | 37 | // end::methods[] 38 | 39 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/analyzeStaticFunctions.adoc: -------------------------------------------------------------------------------- 1 | [#_analyzeStaticFunctions] 2 | === Static Functions 3 | 4 | // tag::methods[] 5 | [#_getVariableName_getVariableName_structure_AnalyzedPipeline_variable_ConstraintVertexVariable] 6 | ==== getVariableName 7 | 8 | [source,typescript] 9 | ---- 10 | getVariableName( structure: AnalyzedPipeline | QueryStructureLegacy, variable: ConstraintVertexVariable, ): string 11 | ---- 12 | 13 | 14 | 15 | [caption=""] 16 | .Input parameters 17 | [cols=",,"] 18 | [options="header"] 19 | |=== 20 | |Name |Description |Type 21 | a| `structure` a| a| `AnalyzedPipeline` 22 | a| `variable` a| a| `ConstraintVertexVariable` 23 | |=== 24 | 25 | [caption=""] 26 | .Returns 27 | `string` 28 | 29 | // end::methods[] 30 | 31 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Comparator.adoc: -------------------------------------------------------------------------------- 1 | [#_Comparator] 2 | === Comparator 3 | 4 | *Package*: `typedb.common.enums` 5 | 6 | An enumeration. 7 | 8 | [caption=""] 9 | .Enum constants 10 | // tag::enum_constants[] 11 | [cols=","] 12 | [options="header"] 13 | |=== 14 | |Name |Value 15 | a| `Contains` a| `7` 16 | a| `Equal` a| `0` 17 | a| `Greater` a| `4` 18 | a| `GreaterOrEqual` a| `5` 19 | a| `LessOrEqual` a| `3` 20 | a| `LessThan` a| `2` 21 | a| `Like` a| `6` 22 | a| `NotEqual` a| `1` 23 | |=== 24 | // end::enum_constants[] 25 | 26 | // tag::methods[] 27 | [#_Comparator_symbol_] 28 | ==== symbol 29 | 30 | [source,python] 31 | ---- 32 | symbol() 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `` 40 | 41 | // end::methods[] 42 | 43 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/nodejs/answer/Explanation.adoc: -------------------------------------------------------------------------------- 1 | [#_Explanation] 2 | === Explanation 3 | 4 | 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. 5 | 6 | [caption=""] 7 | .Fields 8 | // tag::properties[] 9 | [cols=",,"] 10 | [options="header"] 11 | |=== 12 | |Name |Type |Description 13 | a| `conclusion` a| `ConceptMap` a| The Conclusion for this Explanation. 14 | a| `condition` a| `ConceptMap` a| The Condition for this Explanation. 15 | a| `rule` a| `Rule` a| Retrieves the Rule for this Explanation. 16 | a| `variableMapping` a| `Map` a| Retrieves the query variables for this Explanation. 17 | |=== 18 | // end::properties[] 19 | 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/nodejs/session/SessionType.adoc: -------------------------------------------------------------------------------- 1 | [#_SessionType] 2 | === SessionType 3 | 4 | This class is used to specify the type of the session. 5 | 6 | [caption=""] 7 | .Namespace variables 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Name 13 | a| `DATA` 14 | a| `SCHEMA` 15 | |=== 16 | // end::enum_constants[] 17 | 18 | // tag::methods[] 19 | [#_SessionType_isData_] 20 | ==== isData 21 | 22 | [source,nodejs] 23 | ---- 24 | isData(): boolean 25 | ---- 26 | 27 | 28 | 29 | [caption=""] 30 | .Returns 31 | `boolean` 32 | 33 | [#_SessionType_isSchema_] 34 | ==== isSchema 35 | 36 | [source,nodejs] 37 | ---- 38 | isSchema(): boolean 39 | ---- 40 | 41 | 42 | 43 | [caption=""] 44 | .Returns 45 | `boolean` 46 | 47 | // end::methods[] 48 | 49 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/DeleteStage.adoc: -------------------------------------------------------------------------------- 1 | [#_DeleteStage] 2 | === DeleteStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents a ‘delete’ stage. 11 | 12 | // tag::methods[] 13 | [#_DeleteStage_block_] 14 | ==== block 15 | 16 | [source,python] 17 | ---- 18 | block() -> ConjunctionID 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConjunctionID` 26 | 27 | [#_DeleteStage_deleted_variables_] 28 | ==== deleted_variables 29 | 30 | [source,python] 31 | ---- 32 | deleted_variables() -> Iterator['Variable'] 33 | ---- 34 | 35 | The variables for which the unified concepts are to be deleted. 36 | 37 | [caption=""] 38 | .Returns 39 | `Iterator['Variable']` 40 | 41 | // end::methods[] 42 | 43 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/connection/ReplicaInfo.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_ReplicaInfo] 2 | === ReplicaInfo 3 | 4 | *Implements traits:* 5 | 6 | * `Debug` 7 | 8 | The metadata and state of an individual raft replica of a database. 9 | 10 | [caption=""] 11 | .Fields 12 | // tag::properties[] 13 | [cols=",,"] 14 | [options="header"] 15 | |=== 16 | |Name |Type |Description 17 | a| `is_preferred` a| `bool` a| 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. 18 | a| `is_primary` a| `bool` a| Whether this is the primary replica of the raft cluster. 19 | a| `server` a| `Address` a| The server hosting this replica 20 | a| `term` a| `i64` a| The raft protocol ‘term’ of this replica. 21 | |=== 22 | // end::properties[] 23 | 24 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/nodejs/schema/Transitivity.adoc: -------------------------------------------------------------------------------- 1 | [#_Transitivity] 2 | === Transitivity 3 | 4 | [caption=""] 5 | .Namespace variables 6 | // tag::enum_constants[] 7 | [cols=""] 8 | [options="header"] 9 | |=== 10 | |Name 11 | a| `EXPLICIT` 12 | a| `TRANSITIVE` 13 | |=== 14 | // end::enum_constants[] 15 | 16 | // tag::methods[] 17 | [#_Transitivity_new_Transitivity_transitivity_TypeTransitivity] 18 | ==== new Transitivity 19 | 20 | [source,nodejs] 21 | ---- 22 | new Transitivity(transitivity): Transitivity 23 | ---- 24 | 25 | 26 | 27 | [caption=""] 28 | .Input parameters 29 | [cols=",,"] 30 | [options="header"] 31 | |=== 32 | |Name |Description |Type 33 | a| `transitivity` a| a| `TypeTransitivity` 34 | |=== 35 | 36 | [caption=""] 37 | .Returns 38 | `Transitivity` 39 | 40 | // end::methods[] 41 | 42 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/ReturnOperationSingle.adoc: -------------------------------------------------------------------------------- 1 | [#_ReturnOperationSingle] 2 | === ReturnOperationSingle 3 | 4 | *Package*: `typedb.api.analyze.function` 5 | 6 | *Supertypes:* 7 | 8 | * `ReturnOperation` 9 | 10 | // tag::methods[] 11 | [#_ReturnOperationSingle_selector_] 12 | ==== selector 13 | 14 | [source,python] 15 | ---- 16 | selector() -> str 17 | ---- 18 | 19 | Gets the selector that determines how the operation selects the row. 20 | 21 | [caption=""] 22 | .Returns 23 | `str` 24 | 25 | [#_ReturnOperationSingle_variables_] 26 | ==== variables 27 | 28 | [source,python] 29 | ---- 30 | variables() -> Iterator['Variable'] 31 | ---- 32 | 33 | Gets the variables in the returned row. 34 | 35 | [caption=""] 36 | .Returns 37 | `Iterator['Variable']` 38 | 39 | // end::methods[] 40 | 41 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/errors/TypeDBDriverException.adoc: -------------------------------------------------------------------------------- 1 | [#_TypeDBDriverException] 2 | === TypeDBDriverException 3 | 4 | *Package*: `com.typedb.driver.common.exception` 5 | 6 | Exceptions raised by the driver. 7 | 8 | // tag::methods[] 9 | [#_TypeDBDriverException_getErrorMessage_] 10 | ==== getErrorMessage 11 | 12 | [source,java] 13 | ---- 14 | @Nullable 15 | public com.typedb.driver.common.exception.ErrorMessage getErrorMessage() 16 | ---- 17 | 18 | 19 | 20 | [caption=""] 21 | .Returns 22 | `public com.typedb.driver.common.exception.ErrorMessage` 23 | 24 | [#_TypeDBDriverException_getName_] 25 | ==== getName 26 | 27 | [source,java] 28 | ---- 29 | public java.lang.String getName() 30 | ---- 31 | 32 | 33 | 34 | [caption=""] 35 | .Returns 36 | `public java.lang.String` 37 | 38 | // end::methods[] 39 | 40 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/data/Attribute.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_Attribute] 2 | === Attribute 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | * `PartialEq` 9 | * `StructuralPartialEq` 10 | 11 | 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. 12 | 13 | [caption=""] 14 | .Fields 15 | // tag::properties[] 16 | [cols=",,"] 17 | [options="header"] 18 | |=== 19 | |Name |Type |Description 20 | a| `iid` a| `IID` a| The unique id of this Attribute (internal use only) 21 | a| `type_` a| `Option` a| The type which this Attribute belongs to 22 | a| `value` a| `Value` a| The (dataful) value of this attribute 23 | |=== 24 | // end::properties[] 25 | 26 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/analyze/PipelineStage.ReduceStage.ReduceAssignment.adoc: -------------------------------------------------------------------------------- 1 | [#_PipelineStage_ReduceStage_ReduceAssignment] 2 | === PipelineStage.ReduceStage.ReduceAssignment 3 | 4 | *Package*: `com.typedb.driver.api.analyze` 5 | 6 | An assignment of a reducer to a variable 7 | 8 | // tag::methods[] 9 | [#_PipelineStage_ReduceStage_ReduceAssignment_assigned_] 10 | ==== assigned 11 | 12 | [source,java] 13 | ---- 14 | Variable assigned() 15 | ---- 16 | 17 | The variable being assigned to 18 | 19 | [caption=""] 20 | .Returns 21 | `Variable` 22 | 23 | [#_PipelineStage_ReduceStage_ReduceAssignment_reducer_] 24 | ==== reducer 25 | 26 | [source,java] 27 | ---- 28 | Reducer reducer() 29 | ---- 30 | 31 | The reducer being applied 32 | 33 | [caption=""] 34 | .Returns 35 | `Reducer` 36 | 37 | // end::methods[] 38 | 39 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/value/Duration.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_Duration] 2 | === Duration 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Copy` 8 | * `Debug` 9 | * `Display` 10 | * `Eq` 11 | * `FromStr` 12 | * `Hash` 13 | * `PartialEq` 14 | * `StructuralPartialEq` 15 | * `TryFrom` 16 | 17 | A relative duration, which contains months, days, and nanoseconds. Can be used for calendar-relative durations (eg 7 days forward), or for absolute durations using the nanosecond component When used as an absolute duration, convertible to chrono::Duration 18 | 19 | [caption=""] 20 | .Fields 21 | // tag::properties[] 22 | [cols=",,"] 23 | [options="header"] 24 | |=== 25 | |Name |Type |Description 26 | a| `days` a| `u32` a| 27 | a| `months` a| `u32` a| 28 | a| `nanos` a| `u64` a| 29 | |=== 30 | // end::properties[] 31 | 32 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/nodejs/connection/Replica.adoc: -------------------------------------------------------------------------------- 1 | [#_Replica] 2 | === Replica 3 | 4 | The metadata and state of an individual raft replica of a database. 5 | 6 | [caption=""] 7 | .Fields 8 | // tag::properties[] 9 | [cols=",,"] 10 | [options="header"] 11 | |=== 12 | |Name |Type |Description 13 | a| `databaseName` a| `string` a| The database for which this is a replica. 14 | a| `preferred` a| `boolean` a| 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. 15 | a| `primary` a| `boolean` a| Checks whether this is the primary replica of the raft cluster. 16 | a| `server` a| `string` a| The server hosting this replica 17 | a| `term` a| `number` a| The raft protocol ‘term’ of this replica. 18 | |=== 19 | // end::properties[] 20 | 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/analyze/PipelineStage.SortStage.SortVariable.adoc: -------------------------------------------------------------------------------- 1 | [#_PipelineStage_SortStage_SortVariable] 2 | === PipelineStage.SortStage.SortVariable 3 | 4 | *Package*: `com.typedb.driver.api.analyze` 5 | 6 | A variable and its sort order 7 | 8 | // tag::methods[] 9 | [#_PipelineStage_SortStage_SortVariable_order_] 10 | ==== order 11 | 12 | [source,java] 13 | ---- 14 | com.typedb.driver.jni.SortOrder order() 15 | ---- 16 | 17 | The sort order (ascending or descending) 18 | 19 | [caption=""] 20 | .Returns 21 | `com.typedb.driver.jni.SortOrder` 22 | 23 | [#_PipelineStage_SortStage_SortVariable_variable_] 24 | ==== variable 25 | 26 | [source,java] 27 | ---- 28 | Variable variable() 29 | ---- 30 | 31 | The variable to sort by 32 | 33 | [caption=""] 34 | .Returns 35 | `Variable` 36 | 37 | // end::methods[] 38 | 39 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/ReduceStage.adoc: -------------------------------------------------------------------------------- 1 | [#_ReduceStage] 2 | === ReduceStage 3 | 4 | *Package*: `typedb.api.analyze.pipeline_stage` 5 | 6 | *Supertypes:* 7 | 8 | * `PipelineStage` 9 | 10 | Represents a ‘reduce’ stage: reduce <reducers> groupby <groupby> 11 | 12 | // tag::methods[] 13 | [#_ReduceStage_group_by_] 14 | ==== group_by 15 | 16 | [source,python] 17 | ---- 18 | group_by() -> Iterator['Variable'] 19 | ---- 20 | 21 | The variables to group by. 22 | 23 | [caption=""] 24 | .Returns 25 | `Iterator['Variable']` 26 | 27 | [#_ReduceStage_reduce_assignments_] 28 | ==== reduce_assignments 29 | 30 | [source,python] 31 | ---- 32 | reduce_assignments() -> Iterator[ReduceAssignment] 33 | ---- 34 | 35 | The reducer assignments. 36 | 37 | [caption=""] 38 | .Returns 39 | `Iterator[ReduceAssignment]` 40 | 41 | // end::methods[] 42 | 43 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/Comparator.adoc: -------------------------------------------------------------------------------- 1 | [#_enum_Comparator] 2 | === Comparator 3 | 4 | A representation of the comparator used in a comparison constraint. 5 | 6 | [caption=""] 7 | .Enum variants 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Variant 13 | a| `Contains = 7` 14 | a| `Equal = 0` 15 | a| `Greater = 4` 16 | a| `GreaterOrEqual = 5` 17 | a| `LessOrEqual = 3` 18 | a| `LessThan = 2` 19 | a| `Like = 6` 20 | a| `NotEqual = 1` 21 | |=== 22 | // end::enum_constants[] 23 | 24 | // tag::methods[] 25 | [#_enum_Comparator_symbol_] 26 | ==== symbol 27 | 28 | [source,rust] 29 | ---- 30 | pub fn symbol(&self) -> &'static str 31 | ---- 32 | 33 | The symbol representing the comparator in TypeQL 34 | 35 | [caption=""] 36 | .Returns 37 | [source,rust] 38 | ---- 39 | &'static str 40 | ---- 41 | 42 | // end::methods[] 43 | 44 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/AnalyzedQuery.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_AnalyzedQuery] 2 | === AnalyzedQuery 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | 9 | An ``AnalyzedQuery`` contains the server’s representation of the query and preamble functions; as well as the result of types inferred for each variable by type-inference. 10 | 11 | [caption=""] 12 | .Fields 13 | // tag::properties[] 14 | [cols=",,"] 15 | [options="header"] 16 | |=== 17 | |Name |Type |Description 18 | a| `fetch` a| `Option` a| A representation of the ``Fetch`` stage of the query, if it has one 19 | a| `preamble` a| `Vec` a| A representation of the ``Function``s in the preamble of the query 20 | a| `query` a| `Pipeline` a| A representation of the query as a ``Pipeline`` 21 | a| `source` a| `String` a| The original TypeQL query string 22 | |=== 23 | // end::properties[] 24 | 25 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/csharp/errors/TypeDBDriverException.adoc: -------------------------------------------------------------------------------- 1 | [#_TypeDBDriverException] 2 | === TypeDBDriverException 3 | 4 | *Package*: `TypeDB.Driver.Common` 5 | 6 | 7 | 8 | Exceptions raised by the driver. 9 | 10 | // tag::methods[] 11 | [#_bool_TypeDB_Driver_Common_TypeDBDriverException_Contains_string_subString_] 12 | ==== Contains 13 | 14 | [source,cs] 15 | ---- 16 | bool Contains(string subString) 17 | ---- 18 | 19 | 20 | 21 | Checks whether a substring is a part of this exception's message. 22 | 23 | 24 | [caption=""] 25 | .Returns 26 | `bool` 27 | 28 | [caption=""] 29 | .Code examples 30 | [source,cs] 31 | ---- 32 | try 33 | { 34 | ... 35 | } 36 | catch (TypeDBDriverException e) 37 | { 38 | if (e.Contains("CSCO01")) 39 | { 40 | ... 41 | } 42 | else 43 | { 44 | ... 45 | } 46 | } 47 | ---- 48 | 49 | // end::methods[] 50 | 51 | -------------------------------------------------------------------------------- /nodejs/.eslintignore: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | node_modules 19 | dist 20 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | *.bat text eol=crlf 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/connection/TypeDB.adoc: -------------------------------------------------------------------------------- 1 | [#_TypeDB] 2 | === TypeDB 3 | 4 | *Package*: `typedb.driver` 5 | 6 | // tag::methods[] 7 | [#_TypeDB_driver_address_str_credentials_Credentials_driver_options_DriverOptions] 8 | ==== driver 9 | 10 | [source,python] 11 | ---- 12 | static driver(address: str, credentials: Credentials, driver_options: DriverOptions) -> Driver 13 | ---- 14 | 15 | Creates a connection to TypeDB. 16 | 17 | [caption=""] 18 | .Input parameters 19 | [cols=",,,"] 20 | [options="header"] 21 | |=== 22 | |Name |Description |Type |Default Value 23 | a| `address` a| Address of the TypeDB server. a| `str` a| 24 | a| `credentials` a| The credentials to connect with. a| `Credentials` a| 25 | a| `driver_options` a| The connection settings to connect with. a| `DriverOptions` a| 26 | |=== 27 | 28 | [caption=""] 29 | .Returns 30 | `Driver` 31 | 32 | // end::methods[] 33 | 34 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/nodejs/transaction/TransactionType.adoc: -------------------------------------------------------------------------------- 1 | [#_TransactionType] 2 | === TransactionType 3 | 4 | This class is used to specify the type of transaction. 5 | 6 | [caption=""] 7 | .Namespace variables 8 | // tag::enum_constants[] 9 | [cols=""] 10 | [options="header"] 11 | |=== 12 | |Name 13 | a| `READ` 14 | a| `WRITE` 15 | |=== 16 | // end::enum_constants[] 17 | 18 | // tag::methods[] 19 | [#_TransactionType_isRead_] 20 | ==== isRead 21 | 22 | [source,nodejs] 23 | ---- 24 | isRead(): boolean 25 | ---- 26 | 27 | Checks whether this is the READ TransactionType 28 | 29 | [caption=""] 30 | .Returns 31 | `boolean` 32 | 33 | [#_TransactionType_isWrite_] 34 | ==== isWrite 35 | 36 | [source,nodejs] 37 | ---- 38 | isWrite(): boolean 39 | ---- 40 | 41 | Checks whether this is the WRITE TransactionType 42 | 43 | [caption=""] 44 | .Returns 45 | `boolean` 46 | 47 | // end::methods[] 48 | 49 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Isa.adoc: -------------------------------------------------------------------------------- 1 | [#_Isa] 2 | === Isa 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents an ‘isa’ constraint: <instance> isa(!) <type> 11 | 12 | // tag::methods[] 13 | [#_Isa_exactness_] 14 | ==== exactness 15 | 16 | [source,python] 17 | ---- 18 | exactness() -> ConstraintExactness 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConstraintExactness` 26 | 27 | [#_Isa_instance_] 28 | ==== instance 29 | 30 | [source,python] 31 | ---- 32 | instance() -> ConstraintVertex 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintVertex` 40 | 41 | [#_Isa_type_] 42 | ==== type 43 | 44 | [source,python] 45 | ---- 46 | type() -> ConstraintVertex 47 | ---- 48 | 49 | 50 | 51 | [caption=""] 52 | .Returns 53 | `ConstraintVertex` 54 | 55 | // end::methods[] 56 | 57 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Has.adoc: -------------------------------------------------------------------------------- 1 | [#_Has] 2 | === Has 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents a ‘has’ constraint: <owner> has <attribute> 11 | 12 | // tag::methods[] 13 | [#_Has_attribute_] 14 | ==== attribute 15 | 16 | [source,python] 17 | ---- 18 | attribute() -> ConstraintVertex 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConstraintVertex` 26 | 27 | [#_Has_exactness_] 28 | ==== exactness 29 | 30 | [source,python] 31 | ---- 32 | exactness() -> ConstraintExactness 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintExactness` 40 | 41 | [#_Has_owner_] 42 | ==== owner 43 | 44 | [source,python] 45 | ---- 46 | owner() -> ConstraintVertex 47 | ---- 48 | 49 | 50 | 51 | [caption=""] 52 | .Returns 53 | `ConstraintVertex` 54 | 55 | // end::methods[] 56 | 57 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Plays.adoc: -------------------------------------------------------------------------------- 1 | [#_Plays] 2 | === Plays 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents a ‘plays’ constraint: <player> plays <role> 11 | 12 | // tag::methods[] 13 | [#_Plays_exactness_] 14 | ==== exactness 15 | 16 | [source,python] 17 | ---- 18 | exactness() -> ConstraintExactness 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConstraintExactness` 26 | 27 | [#_Plays_player_] 28 | ==== player 29 | 30 | [source,python] 31 | ---- 32 | player() -> ConstraintVertex 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintVertex` 40 | 41 | [#_Plays_role_] 42 | ==== role 43 | 44 | [source,python] 45 | ---- 46 | role() -> ConstraintVertex 47 | ---- 48 | 49 | 50 | 51 | [caption=""] 52 | .Returns 53 | `ConstraintVertex` 54 | 55 | // end::methods[] 56 | 57 | -------------------------------------------------------------------------------- /rust/tests/integration/cluster/mod.rs: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Comparison.adoc: -------------------------------------------------------------------------------- 1 | [#_Comparison] 2 | === Comparison 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents a comparison: <lhs> <comparator> <rhs> 11 | 12 | // tag::methods[] 13 | [#_Comparison_comparator_] 14 | ==== comparator 15 | 16 | [source,python] 17 | ---- 18 | comparator() -> Comparator 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `Comparator` 26 | 27 | [#_Comparison_lhs_] 28 | ==== lhs 29 | 30 | [source,python] 31 | ---- 32 | lhs() -> ConstraintVertex 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintVertex` 40 | 41 | [#_Comparison_rhs_] 42 | ==== rhs 43 | 44 | [source,python] 45 | ---- 46 | rhs() -> ConstraintVertex 47 | ---- 48 | 49 | 50 | 51 | [caption=""] 52 | .Returns 53 | `ConstraintVertex` 54 | 55 | // end::methods[] 56 | 57 | -------------------------------------------------------------------------------- /rust/tests/behaviour/defs.bzl: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | crate_features_common = ["bazel"] 19 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Owns.adoc: -------------------------------------------------------------------------------- 1 | [#_Owns] 2 | === Owns 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents an ‘owns’ constraint: <owner> owns <attribute> 11 | 12 | // tag::methods[] 13 | [#_Owns_attribute_] 14 | ==== attribute 15 | 16 | [source,python] 17 | ---- 18 | attribute() -> ConstraintVertex 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConstraintVertex` 26 | 27 | [#_Owns_exactness_] 28 | ==== exactness 29 | 30 | [source,python] 31 | ---- 32 | exactness() -> ConstraintExactness 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintExactness` 40 | 41 | [#_Owns_owner_] 42 | ==== owner 43 | 44 | [source,python] 45 | ---- 46 | owner() -> ConstraintVertex 47 | ---- 48 | 49 | 50 | 51 | [caption=""] 52 | .Returns 53 | `ConstraintVertex` 54 | 55 | // end::methods[] 56 | 57 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Sub.adoc: -------------------------------------------------------------------------------- 1 | [#_Sub] 2 | === Sub 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents a ‘sub’ constraint: <subtype> sub(!) <supertype> 11 | 12 | // tag::methods[] 13 | [#_Sub_exactness_] 14 | ==== exactness 15 | 16 | [source,python] 17 | ---- 18 | exactness() -> ConstraintExactness 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConstraintExactness` 26 | 27 | [#_Sub_subtype_] 28 | ==== subtype 29 | 30 | [source,python] 31 | ---- 32 | subtype() -> ConstraintVertex 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintVertex` 40 | 41 | [#_Sub_supertype_] 42 | ==== supertype 43 | 44 | [source,python] 45 | ---- 46 | supertype() -> ConstraintVertex 47 | ---- 48 | 49 | 50 | 51 | [caption=""] 52 | .Returns 53 | `ConstraintVertex` 54 | 55 | // end::methods[] 56 | 57 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/answer/Promise.adoc: -------------------------------------------------------------------------------- 1 | [#_Promise] 2 | === Promise 3 | 4 | *Package*: `typedb.common.promise` 5 | 6 | A ``Promise`` represents an asynchronous network operation. 7 | 8 | The request it represents is performed immediately. The response is only retrieved once the ``Promise`` is ``resolve``d. 9 | 10 | // tag::methods[] 11 | [#_Promise_map_] 12 | ==== map 13 | 14 | [source,python] 15 | ---- 16 | classmethod map(ctor: Callable[[U], T], raw: Callable[[], U]) -> Promise[T] 17 | ---- 18 | 19 | 20 | 21 | [caption=""] 22 | .Returns 23 | `Promise[T]` 24 | 25 | [#_Promise_resolve_] 26 | ==== resolve 27 | 28 | [source,python] 29 | ---- 30 | resolve() -> T 31 | ---- 32 | 33 | Retrieves the result of the Promise. 34 | 35 | [caption=""] 36 | .Returns 37 | `T` 38 | 39 | [caption=""] 40 | .Code examples 41 | [source,python] 42 | ---- 43 | promise.resolve() 44 | ---- 45 | 46 | // end::methods[] 47 | 48 | -------------------------------------------------------------------------------- /rust/tests/integration/mod.rs: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | mod cluster; 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/http-ts/analyze/PipelineStage.adoc: -------------------------------------------------------------------------------- 1 | [#_PipelineStage] 2 | === PipelineStage 3 | 4 | [source,typescript] 5 | ---- 6 | PipelineStage: 7 | | { block: ConjunctionIndex; tag: "match" } 8 | | { block: ConjunctionIndex; tag: "insert" } 9 | | { 10 | block: ConjunctionIndex; 11 | deletedVariables: VariableId[]; 12 | tag: "delete"; 13 | } 14 | | { block: ConjunctionIndex; tag: "put" } 15 | | { block: ConjunctionIndex; tag: "update" } 16 | | { tag: "select"; variables: VariableId[] } 17 | | { 18 | tag: "sort"; 19 | variables: { tag: "Ascending" | "Descending"; variable: VariableId }[]; 20 | } 21 | | { tag: "require"; variables: VariableId } 22 | | { offset: number; tag: "offset" } 23 | | { limit: number; tag: "limit" } 24 | | { tag: "distinct" } 25 | | { 26 | groupby: VariableId[]; 27 | reducers: { assigned: VariableId; reducer: Reducer }[]; 28 | tag: "reduce"; 29 | } 30 | ---- 31 | 32 | 33 | -------------------------------------------------------------------------------- /c/swig/typedb_driver_go.swg: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | /* TODO: Implement */ 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Relates.adoc: -------------------------------------------------------------------------------- 1 | [#_Relates] 2 | === Relates 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents a ‘relates’ constraint: <relation> relates <role> 11 | 12 | // tag::methods[] 13 | [#_Relates_exactness_] 14 | ==== exactness 15 | 16 | [source,python] 17 | ---- 18 | exactness() -> ConstraintExactness 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `ConstraintExactness` 26 | 27 | [#_Relates_relation_] 28 | ==== relation 29 | 30 | [source,python] 31 | ---- 32 | relation() -> ConstraintVertex 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintVertex` 40 | 41 | [#_Relates_role_] 42 | ==== role 43 | 44 | [source,python] 45 | ---- 46 | role() -> ConstraintVertex 47 | ---- 48 | 49 | 50 | 51 | [caption=""] 52 | .Returns 53 | `ConstraintVertex` 54 | 55 | // end::methods[] 56 | 57 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/Expression.adoc: -------------------------------------------------------------------------------- 1 | [#_Expression] 2 | === Expression 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents an expression: let <assigned> = <expression> 11 | 12 | // tag::methods[] 13 | [#_Expression_arguments_] 14 | ==== arguments 15 | 16 | [source,python] 17 | ---- 18 | arguments() -> Iterator['ConstraintVertex'] 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `Iterator['ConstraintVertex']` 26 | 27 | [#_Expression_assigned_] 28 | ==== assigned 29 | 30 | [source,python] 31 | ---- 32 | assigned() -> ConstraintVertex 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `ConstraintVertex` 40 | 41 | [#_Expression_text_] 42 | ==== text 43 | 44 | [source,python] 45 | ---- 46 | text() -> str 47 | ---- 48 | 49 | 50 | 51 | [caption=""] 52 | .Returns 53 | `str` 54 | 55 | // end::methods[] 56 | 57 | -------------------------------------------------------------------------------- /dependencies/maven/update.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, 13 | # software distributed under the License is distributed on an 14 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | # KIND, either express or implied. See the License for the 16 | # specific language governing permissions and limitations 17 | # under the License. 18 | 19 | bazel run @typedb_dependencies//library/maven:update 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/cpp/data/Entity.adoc: -------------------------------------------------------------------------------- 1 | [#_Entity] 2 | === Entity 3 | 4 | *Package*: `TypeDB` 5 | 6 | *Supertypes:* 7 | 8 | * `TypeDB::Thing` 9 | * `TypeDB::Concept` 10 | 11 | 12 | 13 | Instance of data of an entity type, representing a standalone object that exists in the data model independently. 14 | 15 | Entity does not have a value. It is usually addressed by its ownership over attribute instances and/or roles played in relation instances. 16 | 17 | // tag::methods[] 18 | [#_stdunique_ptr_EntityType_TypeDBEntitygetType_] 19 | ==== getType 20 | 21 | [source,cpp] 22 | ---- 23 | std::unique_ptr< EntityType > TypeDB::Entity::getType() 24 | ---- 25 | 26 | 27 | 28 | Retrieves the type which this ``Entity`` belongs to. 29 | 30 | 31 | [caption=""] 32 | .Returns 33 | `std::unique_ptr< EntityType >` 34 | 35 | [caption=""] 36 | .Code examples 37 | [source,cpp] 38 | ---- 39 | entity.getType(); 40 | ---- 41 | 42 | // end::methods[] 43 | 44 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/NamedRole.adoc: -------------------------------------------------------------------------------- 1 | [#_NamedRole] 2 | === NamedRole 3 | 4 | *Package*: `typedb.api.analyze.named_role` 5 | 6 | ‘links’ & ‘relates’ constraints accept unscoped role names. Since an unscoped role-name does not uniquely identify a role-type, (Different role-types belonging to different relation types may share the same name) an internal variable is introduced to handle the ambiguity 7 | 8 | // tag::methods[] 9 | [#_NamedRole_name_] 10 | ==== name 11 | 12 | [source,python] 13 | ---- 14 | name() -> str 15 | ---- 16 | 17 | The unscoped role name specified in the query. 18 | 19 | [caption=""] 20 | .Returns 21 | `str` 22 | 23 | [#_NamedRole_variable_] 24 | ==== variable 25 | 26 | [source,python] 27 | ---- 28 | variable() -> Variable 29 | ---- 30 | 31 | The internal variable injected to handle ambiguity in unscoped role names. 32 | 33 | [caption=""] 34 | .Returns 35 | `Variable` 36 | 37 | // end::methods[] 38 | 39 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/analyze/NamedRole.adoc: -------------------------------------------------------------------------------- 1 | [#_NamedRole] 2 | === NamedRole 3 | 4 | *Package*: `com.typedb.driver.api.analyze` 5 | 6 | 'links' & 'relates' constraints accept unscoped role names. Since an unscoped role-name does not uniquely identify a role-type, (Different role-types belonging to different relation types may share the same name) an internal variable is introduced to handle the ambiguity 7 | 8 | // tag::methods[] 9 | [#_NamedRole_name_] 10 | ==== name 11 | 12 | [source,java] 13 | ---- 14 | java.lang.String name() 15 | ---- 16 | 17 | The unscoped role name specified in the query. 18 | 19 | [caption=""] 20 | .Returns 21 | `java.lang.String` 22 | 23 | [#_NamedRole_variable_] 24 | ==== variable 25 | 26 | [source,java] 27 | ---- 28 | Variable variable() 29 | ---- 30 | 31 | The internal variable injected to handle ambiguity in unscoped role names. 32 | 33 | [caption=""] 34 | .Returns 35 | `Variable` 36 | 37 | // end::methods[] 38 | 39 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/analyze/FunctionCall.adoc: -------------------------------------------------------------------------------- 1 | [#_FunctionCall] 2 | === FunctionCall 3 | 4 | *Package*: `typedb.api.analyze.constraint` 5 | 6 | *Supertypes:* 7 | 8 | * `Constraint` 9 | 10 | Represents a function call: let <assigned> = name(<arguments>) 11 | 12 | // tag::methods[] 13 | [#_FunctionCall_arguments_] 14 | ==== arguments 15 | 16 | [source,python] 17 | ---- 18 | arguments() -> Iterator['ConstraintVertex'] 19 | ---- 20 | 21 | 22 | 23 | [caption=""] 24 | .Returns 25 | `Iterator['ConstraintVertex']` 26 | 27 | [#_FunctionCall_assigned_] 28 | ==== assigned 29 | 30 | [source,python] 31 | ---- 32 | assigned() -> Iterator['ConstraintVertex'] 33 | ---- 34 | 35 | 36 | 37 | [caption=""] 38 | .Returns 39 | `Iterator['ConstraintVertex']` 40 | 41 | [#_FunctionCall_name_] 42 | ==== name 43 | 44 | [source,python] 45 | ---- 46 | name() -> str 47 | ---- 48 | 49 | 50 | 51 | [caption=""] 52 | .Returns 53 | `str` 54 | 55 | // end::methods[] 56 | 57 | -------------------------------------------------------------------------------- /nodejs/test/behaviour/README.md: -------------------------------------------------------------------------------- 1 | ## TypeDB Driver for Node.js: Behaviour Tests 2 | 3 | To develop the tests, simply run: 4 | ``` 5 | tsc 6 | ``` 7 | - If the `tsc` command isn't found, install it using `npm install -g typescript`. 8 | - If there are compiler errors, you may have a mismatched TypeScript version. Try `npm uninstall -g typescript; npm install -g typescript@{version}` where `{version}` is the version specified in root `package.json`. 9 | 10 | Running `tsc` will create the `dist` directory on your local machine, where all the BDD step implementations import typedb-driver symbols from. This allows your IDE to provide IntelliSense. 11 | 12 | > NOTE: When importing symbols in the test files, you must import everything from the 'dist' directory, or the tests will fail at runtime. This is because the Bazel test script compiles the driver's source files and puts them in a folder called 'dist'. 13 | 14 | The tests are all invoked via Bazel test targets, as in Driver Java. 15 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/connection/Credentials.adoc: -------------------------------------------------------------------------------- 1 | [#_Credentials] 2 | === Credentials 3 | 4 | *Package*: `com.typedb.driver.api` 5 | 6 | User credentials for connecting to TypeDB Server. 7 | 8 | 9 | [caption=""] 10 | .Examples 11 | [source,java] 12 | ---- 13 | Credential credentials = new Credential(username, password); 14 | ---- 15 | 16 | // tag::methods[] 17 | [#_Credentials_Credentials_java_lang_String_java_lang_String] 18 | ==== Credentials 19 | 20 | [source,java] 21 | ---- 22 | public Credentials​(java.lang.String username, 23 | java.lang.String password) 24 | ---- 25 | 26 | 27 | 28 | [caption=""] 29 | .Input parameters 30 | [cols=",,"] 31 | [options="header"] 32 | |=== 33 | |Name |Description |Type 34 | a| `username` a| The name of the user to connect as a| `java.lang.String` 35 | a| `password` a| The password for the user a| `java.lang.String` 36 | |=== 37 | 38 | [caption=""] 39 | .Returns 40 | `public` 41 | 42 | // end::methods[] 43 | 44 | -------------------------------------------------------------------------------- /http-ts/tests/behaviour/README.md: -------------------------------------------------------------------------------- 1 | ## TypeDB Driver for Node.js: Behaviour Tests 2 | 3 | To develop the tests, simply run: 4 | ``` 5 | tsc 6 | ``` 7 | - If the `tsc` command isn't found, install it using `npm install -g typescript`. 8 | - If there are compiler errors, you may have a mismatched TypeScript version. Try `npm uninstall -g typescript; npm install -g typescript@{version}` where `{version}` is the version specified in root `package.json`. 9 | 10 | Running `tsc` will create the `dist` directory on your local machine, where all the BDD step implementations import typedb-driver symbols from. This allows your IDE to provide IntelliSense. 11 | 12 | > NOTE: When importing symbols in the test files, you must import everything from the 'dist' directory, or the tests will fail at runtime. This is because the Bazel test script compiles the driver's source files and puts them in a folder called 'dist'. 13 | 14 | The tests are all invoked via Bazel test targets, as in Driver Java. 15 | -------------------------------------------------------------------------------- /rust/src/connection/database/mod.rs: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | pub(crate) mod export_stream; 21 | pub(crate) mod import_stream; 22 | -------------------------------------------------------------------------------- /tool/test/stop-community-server.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, 13 | # software distributed under the License is distributed on an 14 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | # KIND, either express or implied. See the License for the 16 | # specific language governing permissions and limitations 17 | # under the License. 18 | 19 | set -xe 20 | 21 | kill $(ps aux | awk '/typedb[_server_bin]/ {print $2}') 22 | -------------------------------------------------------------------------------- /tool/rust/sync.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, 13 | # software distributed under the License is distributed on an 14 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | # KIND, either express or implied. See the License for the 16 | # specific language governing permissions and limitations 17 | # under the License. 18 | 19 | bazel run @typedb_dependencies//tool/ide:rust_sync -- @typedb_driver_workspace_refs//:refs.json 20 | -------------------------------------------------------------------------------- /.factory/test-cluster.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, 13 | # software distributed under the License is distributed on an 14 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | # KIND, either express or implied. See the License for the 16 | # specific language governing permissions and limitations 17 | # under the License. 18 | 19 | set -ex 20 | bazel test $(bazel query "filter('^.*cluster.*$', kind(.*_test, $1))") "${@:2}" 21 | -------------------------------------------------------------------------------- /.factory/test-community.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, 13 | # software distributed under the License is distributed on an 14 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | # KIND, either express or implied. See the License for the 16 | # specific language governing permissions and limitations 17 | # under the License. 18 | 19 | set -ex 20 | bazel test $(bazel query "filter('^.*community.*$', kind(.*_test, $1))") "${@:2}" 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/analyze/Function.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_Function] 2 | === Function 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | 9 | Holds a representation of the function, and the result of type-inference for each variable. 10 | 11 | [caption=""] 12 | .Fields 13 | // tag::properties[] 14 | [cols=",,"] 15 | [options="header"] 16 | |=== 17 | |Name |Type |Description 18 | a| `argument_annotations` a| `Vec` a| The inferred type for each argument of the function. 19 | a| `argument_variables` a| `Vec` a| The ``Variable``s which are the arguments of the function. 20 | a| `body` a| `Pipeline` a| A representation of the ``Pipeline`` which forms the body of the function. 21 | a| `return_annotations` a| `Vec` a| The inferred type for each concept returned by the function. 22 | a| `return_operation` a| `ReturnOperation` a| A representation of the ``ReturnOperation`` of the function. 23 | |=== 24 | // end::properties[] 25 | 26 | -------------------------------------------------------------------------------- /rust/src/connection/network/mod.rs: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | mod channel; 21 | mod proto; 22 | mod stub; 23 | pub(super) mod transmitter; 24 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/schema/EntityType.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_EntityType] 2 | === EntityType 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | * `Display` 9 | * `Eq` 10 | * `PartialEq` 11 | * `StructuralPartialEq` 12 | 13 | Entity types represent the classification of independent objects in the data model of the business domain. 14 | 15 | [caption=""] 16 | .Fields 17 | // tag::properties[] 18 | [cols=",,"] 19 | [options="header"] 20 | |=== 21 | |Name |Type |Description 22 | a| `label` a| `String` a| 23 | |=== 24 | // end::properties[] 25 | 26 | // tag::methods[] 27 | [#_struct_EntityType_label_] 28 | ==== label 29 | 30 | [source,rust] 31 | ---- 32 | pub fn label(&self) -> &str 33 | ---- 34 | 35 | Retrieves the unique label of the ``EntityType``. 36 | 37 | [caption=""] 38 | .Returns 39 | [source,rust] 40 | ---- 41 | &str 42 | ---- 43 | 44 | [caption=""] 45 | .Code examples 46 | [source,rust] 47 | ---- 48 | entity_type.label() 49 | ---- 50 | 51 | // end::methods[] 52 | 53 | -------------------------------------------------------------------------------- /java/api/analyze/Variable.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | package com.typedb.driver.api.analyze; 21 | 22 | public interface Variable { 23 | } 24 | -------------------------------------------------------------------------------- /rust/rustfmt.toml: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | # 18 | 19 | imports_granularity = "Crate" 20 | group_imports = "StdExternalCrate" 21 | use_small_heuristics = "Max" 22 | max_width = 120 23 | -------------------------------------------------------------------------------- /rust/src/user/mod.rs: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | pub use self::{user::User, user_manager::UserManager}; 21 | 22 | mod user; 23 | mod user_manager; 24 | -------------------------------------------------------------------------------- /java/api/analyze/ConjunctionID.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | package com.typedb.driver.api.analyze; 21 | 22 | public interface ConjunctionID { 23 | } 24 | -------------------------------------------------------------------------------- /python/tests/behaviour/entry_point_behave.py: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | import sys 19 | 20 | from behave.__main__ import main 21 | 22 | if __name__ == "__main__": 23 | sys.exit(main()) 24 | -------------------------------------------------------------------------------- /cpp/build_opts.bzl: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | cxxopts = select({ 19 | "@typedb_bazel_distribution//platform:is_windows": ["/std:c++17"], 20 | "//conditions:default": ["-std=c++17"], 21 | }) 22 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/answer/OkQueryAnswer.adoc: -------------------------------------------------------------------------------- 1 | [#_OkQueryAnswer] 2 | === OkQueryAnswer 3 | 4 | *Package*: `typedb.api.answer.ok_query_answer` 5 | 6 | *Supertypes:* 7 | 8 | * `QueryAnswer` 9 | 10 | Represents a simple Ok message as a server answer. Doesn’t contain concepts. 11 | 12 | // tag::methods[] 13 | [#_OkQueryAnswer_as_ok_] 14 | ==== as_ok 15 | 16 | [source,python] 17 | ---- 18 | as_ok() -> OkQueryAnswer 19 | ---- 20 | 21 | Casts the query answer to ``OkQueryAnswer``. 22 | 23 | [caption=""] 24 | .Returns 25 | `OkQueryAnswer` 26 | 27 | [caption=""] 28 | .Code examples 29 | [source,python] 30 | ---- 31 | query_answer.as_ok() 32 | ---- 33 | 34 | [#_OkQueryAnswer_is_ok_] 35 | ==== is_ok 36 | 37 | [source,python] 38 | ---- 39 | is_ok() -> bool 40 | ---- 41 | 42 | Checks if the query answer is an ``Ok``. 43 | 44 | [caption=""] 45 | .Returns 46 | `bool` 47 | 48 | [caption=""] 49 | .Code examples 50 | [source,python] 51 | ---- 52 | query_answer.is_ok() 53 | ---- 54 | 55 | // end::methods[] 56 | 57 | -------------------------------------------------------------------------------- /python/tests/deployment/requirements.txt: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | --extra-index-url https://repo.typedb.com/public/public-snapshot/python/simple 19 | 20 | typedb-driver==DRIVER_PYTHON_VERSION_MARKER 21 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/cpp/answer/Future.adoc: -------------------------------------------------------------------------------- 1 | [#_Future] 2 | === Future 3 | 4 | *Package*: `TypeDB` 5 | 6 | 7 | 8 | A structure emulating std::future, used as result of an asynchronous call to the server. 9 | 10 | Note that a future must be evaluated for any server-side exceptions to be raised. 11 | 12 | // tag::methods[] 13 | [#_RETURN_TypeDBFuture_RETURN_NATIVE_PROMISE_HELPER_get_] 14 | ==== get 15 | 16 | [source,cpp] 17 | ---- 18 | RETURN TypeDB::Future< RETURN, NATIVE_PROMISE, HELPER >::get() 19 | ---- 20 | 21 | 22 | 23 | Waits for the call to complete and returns the result. 24 | 25 | [caption=""] 26 | .Returns 27 | `RETURN` 28 | 29 | [#_void_TypeDBFuture_RETURN_NATIVE_PROMISE_HELPER_wait_] 30 | ==== wait 31 | 32 | [source,cpp] 33 | ---- 34 | void TypeDB::Future< RETURN, NATIVE_PROMISE, HELPER >::wait() 35 | ---- 36 | 37 | 38 | 39 | Waits for the call to complete and ignores the result. Any exceptions will still be thrown. 40 | 41 | [caption=""] 42 | .Returns 43 | `void` 44 | 45 | // end::methods[] 46 | 47 | -------------------------------------------------------------------------------- /python/conf.py: -------------------------------------------------------------------------------- 1 | # Configuration file for the Sphinx documentation builder. 2 | # 3 | # For the full list of built-in configuration values, see the documentation: 4 | # https://www.sphinx-doc.org/en/master/usage/configuration.html 5 | 6 | # -- Project information ----------------------------------------------------- 7 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information 8 | 9 | project = 'typedb-driver' 10 | copyright = '2024 TypeDB' 11 | author = 'TypeDB' 12 | 13 | # -- General configuration --------------------------------------------------- 14 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration 15 | 16 | extensions = ['sphinx.ext.autodoc'] 17 | 18 | templates_path = ['_templates'] 19 | exclude_patterns = [] 20 | 21 | # -- Options for HTML output ------------------------------------------------- 22 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output 23 | 24 | html_theme = 'alabaster' 25 | html_static_path = ['_static'] 26 | -------------------------------------------------------------------------------- /tool/release/create_notes.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, 13 | # software distributed under the License is distributed on an 14 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | # KIND, either express or implied. See the License for the 16 | # specific language governing permissions and limitations 17 | # under the License. 18 | 19 | bazel run @typedb_dependencies//tool/release/notes:create -- typedb typedb-driver HEAD $(cat VERSION) ./RELEASE_TEMPLATE.md ./RELEASE_NOTES_LATEST.md 20 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/csharp/answer/IValueGroup.adoc: -------------------------------------------------------------------------------- 1 | [#_IValueGroup] 2 | === IValueGroup 3 | 4 | *Package*: `TypeDB.Driver.Api` 5 | 6 | 7 | 8 | Contains an element of the group aggregate query result. 9 | 10 | // tag::methods[] 11 | [#_IConcept_TypeDB_Driver_Api_IValueGroup_Owner] 12 | ==== Owner 13 | 14 | [source,cs] 15 | ---- 16 | IConcept TypeDB.Driver.Api.IValueGroup.Owner 17 | ---- 18 | 19 | 20 | 21 | Retrieves the concept that is the group owner. 22 | 23 | 24 | [caption=""] 25 | .Returns 26 | `IConcept` 27 | 28 | [caption=""] 29 | .Code examples 30 | [source,cs] 31 | ---- 32 | conceptMapGroup.Owner; 33 | ---- 34 | 35 | [#_IValue_TypeDB_Driver_Api_IValueGroup_Value] 36 | ==== Value 37 | 38 | [source,cs] 39 | ---- 40 | IValue? TypeDB.Driver.Api.IValueGroup.Value 41 | ---- 42 | 43 | 44 | 45 | Retrieves the ``Value`` answer of the group. 46 | 47 | 48 | [caption=""] 49 | .Returns 50 | `IValue?` 51 | 52 | [caption=""] 53 | .Code examples 54 | [source,cs] 55 | ---- 56 | valueGroup.Value; 57 | ---- 58 | 59 | // end::methods[] 60 | 61 | -------------------------------------------------------------------------------- /python/requirements_dev.txt: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | ## To install ALL dependencies, run: pip install -r requirements_dev.txt 19 | 20 | behave==1.2.6 21 | parse==1.18.0 22 | parse-type==0.6.2 23 | PyHamcrest==2.0.2 24 | six==1.16.0 25 | -------------------------------------------------------------------------------- /rust/src/database/mod.rs: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | pub use self::{database::Database, database_manager::DatabaseManager}; 21 | 22 | mod database; 23 | mod database_manager; 24 | pub(crate) mod migration; 25 | -------------------------------------------------------------------------------- /csharp/build_opts.bzl: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | nullable_context = "enable" 19 | target_framework = "net6.0" 20 | target_frameworks = [target_framework] 21 | targeting_packs = ["@paket.rules_dotnet_nuget_packages//microsoft.netcore.app.ref"] 22 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/java/analyze/AnalyzedQuery.adoc: -------------------------------------------------------------------------------- 1 | [#_AnalyzedQuery] 2 | === AnalyzedQuery 3 | 4 | *Package*: `com.typedb.driver.api.analyze` 5 | 6 | // tag::methods[] 7 | [#_AnalyzedQuery_fetch_] 8 | ==== fetch 9 | 10 | [source,java] 11 | ---- 12 | java.util.Optional fetch() 13 | ---- 14 | 15 | A representation of the ``Fetch`` stage of the query, if it has one 16 | 17 | [caption=""] 18 | .Returns 19 | `java.util.Optional` 20 | 21 | [#_AnalyzedQuery_pipeline_] 22 | ==== pipeline 23 | 24 | [source,java] 25 | ---- 26 | Pipeline pipeline() 27 | ---- 28 | 29 | A representation of the query as a ``Pipeline`` 30 | 31 | [caption=""] 32 | .Returns 33 | `Pipeline` 34 | 35 | [#_AnalyzedQuery_preamble_] 36 | ==== preamble 37 | 38 | [source,java] 39 | ---- 40 | java.util.stream.Stream preamble() 41 | ---- 42 | 43 | A representation of the ``Function``s in the preamble of the query 44 | 45 | [caption=""] 46 | .Returns 47 | `java.util.stream.Stream` 48 | 49 | // end::methods[] 50 | 51 | -------------------------------------------------------------------------------- /go/api/user/User.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | package user 21 | 22 | type User interface { 23 | Username() string 24 | PasswordExpirySeconds() (int64, bool) 25 | PasswordUpdate() (string, string) 26 | } 27 | -------------------------------------------------------------------------------- /csharp/Test/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | include = glob(["*"]), 23 | license_type = "apache-header", 24 | ) 25 | -------------------------------------------------------------------------------- /tool/test/stop-cluster-servers.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, 13 | # software distributed under the License is distributed on an 14 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | # KIND, either express or implied. See the License for the 16 | # specific language governing permissions and limitations 17 | # under the License. 18 | 19 | set -e 20 | 21 | procs=$(ps aux | awk '/TypeDBCloudServe[r]/ {print $2}' | paste -sd " " -) 22 | echo $procs 23 | if [ -n "$procs" ]; then 24 | kill $procs 25 | fi 26 | -------------------------------------------------------------------------------- /csharp/Test/Behaviour/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | include = glob(["*"]), 23 | license_type = "apache-header", 24 | ) 25 | -------------------------------------------------------------------------------- /csharp/Test/Deployment/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | include = glob(["*"]), 23 | license_type = "apache-header", 24 | ) 25 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/cpp/answer/Explainable.adoc: -------------------------------------------------------------------------------- 1 | [#_Explainable] 2 | === Explainable 3 | 4 | *Package*: `TypeDB` 5 | 6 | 7 | 8 | Contains an explainable object. 9 | 10 | // tag::methods[] 11 | [#_stdstring_TypeDBExplainableconjunction_] 12 | ==== conjunction 13 | 14 | [source,cpp] 15 | ---- 16 | std::string TypeDB::Explainable::conjunction() 17 | ---- 18 | 19 | 20 | 21 | Retrieves the subquery of the original query that is actually being explained. 22 | 23 | 24 | [caption=""] 25 | .Returns 26 | `std::string` 27 | 28 | [caption=""] 29 | .Code examples 30 | [source,cpp] 31 | ---- 32 | explainable.conjunction(); 33 | ---- 34 | 35 | [#_int64_t_TypeDBExplainableexplainableId_] 36 | ==== explainableId 37 | 38 | [source,cpp] 39 | ---- 40 | int64_t TypeDB::Explainable::explainableId() 41 | ---- 42 | 43 | 44 | 45 | Retrieves the unique ID that identifies this ``Explainable``. 46 | 47 | 48 | [caption=""] 49 | .Returns 50 | `int64_t` 51 | 52 | [caption=""] 53 | .Code examples 54 | [source,cpp] 55 | ---- 56 | explainable.id(); 57 | ---- 58 | 59 | // end::methods[] 60 | 61 | -------------------------------------------------------------------------------- /c/tests/integration/test_driver.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | bool test_database_management(); 21 | 22 | bool test_query_schema(); 23 | bool test_query_data(); 24 | 25 | bool test_concept_api_schema(); 26 | bool test_concept_api_data(); 27 | -------------------------------------------------------------------------------- /csharp/Test/Integration/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | include = glob(["*"]), 23 | license_type = "apache-header", 24 | ) 25 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/python/schema/EntityType.adoc: -------------------------------------------------------------------------------- 1 | [#_EntityType] 2 | === EntityType 3 | 4 | *Package*: `typedb.api.concept.type.entity_type` 5 | 6 | *Supertypes:* 7 | 8 | * `Type` 9 | 10 | Entity types represent the classification of independent objects in the data model of the business domain. 11 | 12 | // tag::methods[] 13 | [#_EntityType_as_entity_type_] 14 | ==== as_entity_type 15 | 16 | [source,python] 17 | ---- 18 | as_entity_type() -> EntityType 19 | ---- 20 | 21 | Casts the concept to ``EntityType``. 22 | 23 | [caption=""] 24 | .Returns 25 | `EntityType` 26 | 27 | [caption=""] 28 | .Code examples 29 | [source,python] 30 | ---- 31 | entity_type.as_entity_type() 32 | ---- 33 | 34 | [#_EntityType_is_entity_type_] 35 | ==== is_entity_type 36 | 37 | [source,python] 38 | ---- 39 | is_entity_type() -> bool 40 | ---- 41 | 42 | Checks if the concept is an ``EntityType``. 43 | 44 | [caption=""] 45 | .Returns 46 | `bool` 47 | 48 | [caption=""] 49 | .Code examples 50 | [source,python] 51 | ---- 52 | entity_type.is_entity_type() 53 | ---- 54 | 55 | // end::methods[] 56 | 57 | -------------------------------------------------------------------------------- /csharp/Test/Behaviour/Concept/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | include = glob(["*"]), 23 | license_type = "apache-header", 24 | ) 25 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/data/Relation.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_Relation] 2 | === Relation 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | * `Eq` 9 | * `PartialEq` 10 | * `StructuralPartialEq` 11 | 12 | Relation is an instance of a relation type and can be uniquely addressed by a combination of its type, owned attributes and role players. 13 | 14 | [caption=""] 15 | .Fields 16 | // tag::properties[] 17 | [cols=",,"] 18 | [options="header"] 19 | |=== 20 | |Name |Type |Description 21 | a| `iid` a| `IID` a| The unique id of this Relation 22 | a| `type_` a| `Option` a| The type which this Relation belongs to 23 | |=== 24 | // end::properties[] 25 | 26 | // tag::methods[] 27 | [#_struct_Relation_iid_] 28 | ==== iid 29 | 30 | [source,rust] 31 | ---- 32 | pub fn iid(&self) -> &IID 33 | ---- 34 | 35 | Retrieves the unique id of the ``Relation``. 36 | 37 | [caption=""] 38 | .Returns 39 | [source,rust] 40 | ---- 41 | &IID 42 | ---- 43 | 44 | [caption=""] 45 | .Code examples 46 | [source,rust] 47 | ---- 48 | relation.iid(); 49 | ---- 50 | 51 | // end::methods[] 52 | 53 | -------------------------------------------------------------------------------- /nodejs/test/behaviour/driver/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | include = glob(["*"]), 23 | license_type = "apache-header", 24 | ) 25 | -------------------------------------------------------------------------------- /python/requirements.txt: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | ## To install primary (not dev) dependencies, run: 19 | # pip install -r requirements.txt 20 | 21 | ## To install ALL (including dev) dependencies, run: 22 | # pip install -r requirements_dev.txt 23 | 24 | parse==1.18.0 25 | -------------------------------------------------------------------------------- /python/typedb/concept/type/role_type.py: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | from __future__ import annotations 19 | 20 | from typedb.api.concept.type.role_type import RoleType 21 | from typedb.concept.type.type import _Type 22 | 23 | 24 | class _RoleType(_Type, RoleType): 25 | pass 26 | -------------------------------------------------------------------------------- /tool/http-ts/BUILD: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, 13 | # software distributed under the License is distributed on an 14 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | # KIND, either express or implied. See the License for the 16 | # specific language governing permissions and limitations 17 | # under the License. 18 | 19 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 20 | 21 | checkstyle_test( 22 | name = "checkstyle", 23 | include = glob(["*"]), 24 | license_type = "apache-header", 25 | ) 26 | -------------------------------------------------------------------------------- /tool/release/BUILD: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, 13 | # software distributed under the License is distributed on an 14 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | # KIND, either express or implied. See the License for the 16 | # specific language governing permissions and limitations 17 | # under the License. 18 | 19 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 20 | 21 | checkstyle_test( 22 | name = "checkstyle", 23 | include = glob(["*"]), 24 | license_type = "apache-header", 25 | ) 26 | -------------------------------------------------------------------------------- /tool/rust/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | include = glob(["*"]), 23 | license_type = "apache-header", 24 | size = "small", 25 | ) 26 | -------------------------------------------------------------------------------- /docs/modules/ROOT/partials/rust/answer/ConceptDocument.adoc: -------------------------------------------------------------------------------- 1 | [#_struct_ConceptDocument] 2 | === ConceptDocument 3 | 4 | *Implements traits:* 5 | 6 | * `Clone` 7 | * `Debug` 8 | * `PartialEq` 9 | * `StructuralPartialEq` 10 | 11 | A single document of concepts representing substitutions for variables in the query. Contains a Header (query type), and the document of concepts. 12 | 13 | [caption=""] 14 | .Fields 15 | // tag::properties[] 16 | [cols=",,"] 17 | [options="header"] 18 | |=== 19 | |Name |Type |Description 20 | a| `root` a| `Option` a| 21 | |=== 22 | // end::properties[] 23 | 24 | // tag::methods[] 25 | [#_struct_ConceptDocument_get_query_type_] 26 | ==== get_query_type 27 | 28 | [source,rust] 29 | ---- 30 | pub fn get_query_type(&self) -> QueryType 31 | ---- 32 | 33 | Retrieve the executed query’s type (shared by all elements in this stream). 34 | 35 | [caption=""] 36 | .Returns 37 | [source,rust] 38 | ---- 39 | QueryType 40 | ---- 41 | 42 | [caption=""] 43 | .Code examples 44 | [source,rust] 45 | ---- 46 | concept_document.get_query_type() 47 | ---- 48 | 49 | // end::methods[] 50 | 51 | -------------------------------------------------------------------------------- /go/api/database/DatabaseManager.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | package database 21 | 22 | type DatabaseManager interface { 23 | Get(name string) Database 24 | Contains(name string) bool 25 | Create(name string) 26 | All() []Database 27 | } 28 | -------------------------------------------------------------------------------- /cpp/lib/common/native.hpp: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | #pragma once 21 | 22 | namespace TypeDB { 23 | 24 | namespace _native { 25 | 26 | extern "C" { 27 | #include "c/typedb_driver.h" 28 | } 29 | 30 | } // namespace _native 31 | 32 | } // namespace TypeDB 33 | -------------------------------------------------------------------------------- /cpp/test/behaviour/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | include = glob(["*"]), 23 | license_type = "apache-header", 24 | size = "small", 25 | ) 26 | -------------------------------------------------------------------------------- /dependencies/typedb/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | include = glob(["*"]), 23 | license_type = "apache-header", 24 | size = "small", 25 | ) 26 | -------------------------------------------------------------------------------- /python/typedb/api/analyze/variable.py: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | from __future__ import annotations 19 | 20 | from abc import ABC, abstractmethod 21 | from typing import TYPE_CHECKING, Iterator 22 | 23 | if TYPE_CHECKING: 24 | pass 25 | 26 | 27 | class Variable(ABC): 28 | pass 29 | -------------------------------------------------------------------------------- /python/typedb/concept/type/entity_type.py: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | from __future__ import annotations 19 | 20 | from typedb.api.concept.type.entity_type import EntityType 21 | from typedb.concept.type.type import _Type 22 | 23 | 24 | class _EntityType(EntityType, _Type): 25 | pass 26 | -------------------------------------------------------------------------------- /cpp/test/behaviour/concept/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | include = glob(["*"]), 23 | license_type = "apache-header", 24 | size = "small", 25 | ) 26 | -------------------------------------------------------------------------------- /cpp/test/behaviour/driver/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | include = glob(["*"]), 23 | license_type = "apache-header", 24 | size = "small", 25 | ) 26 | -------------------------------------------------------------------------------- /cpp/test/behaviour/query/BUILD: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@typedb_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test") 19 | 20 | checkstyle_test( 21 | name = "checkstyle", 22 | size = "small", 23 | include = glob(["*"]), 24 | license_type = "apache-header", 25 | ) 26 | -------------------------------------------------------------------------------- /go/go_versions.bzl: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | 18 | load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains") 19 | 20 | go_versions = [ 21 | "1.21.10", 22 | ] 23 | 24 | def register_all_toolchains(): 25 | for version in go_versions: 26 | go_register_toolchains(version=version) 27 | -------------------------------------------------------------------------------- /rust/tests/behaviour/config/lib.rs: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | pub fn is_cluster() -> bool { 21 | #[cfg(feature = "cluster")] 22 | { 23 | true 24 | } 25 | 26 | #[cfg(not(feature = "cluster"))] 27 | { 28 | false 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /tool/test/EchoJavaHome.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | package com.typedb.driver.tool.test; 21 | 22 | public class EchoJavaHome { 23 | public static void main(String[] args) { 24 | System.out.println(System.getProperty("java.home")); 25 | } 26 | } 27 | --------------------------------------------------------------------------------