TypeDB Client for Java

Client Architecture

To learn about the mechanism that a TypeDB Client uses to set up communication with databases running on the TypeDB Server, refer to TypeDB > Client API > Overview.

API Reference

To learn about the methods available for executing queries and retrieving their answers using Client Java, refer to TypeDB > Client API > Java > API Reference.

Concept API

To learn about the methods available on the concepts retrieved as the answers to TypeQL queries, refer to TypeDB > Concept API > Overview

Import TypeDB Client for Java through Maven

<repositories>
    <repository>
        <id>repo.vaticle.com</id>
        <url>https://repo.vaticle.com/repository/maven/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.vaticle.typedb</groupId>
        <artifactId>typedb-client</artifactId>
        <version>{version}</version>
    </dependency>
</dependencies>

Further documentation: https://docs.vaticle.com/docs/client-api/java

Build TypeDB Client for Java from Source

Note: You don't need to compile TypeDB Client from source if you just want to use it in your code. See the "Import TypeDB Client for Java" section above.

1. Make sure you have the following dependencies installed on your machine:

   • Java JDK 11 or higher
   • Bazel

2. Build the JAR:

   a) to build the native/raw JAR:

   bazel build //:client-java
   

   The Java library JAR will be produced at: bazel-bin/libclient-java.jar

   b) to build the JAR for a Maven application:

   bazel build //:assemble-maven
   

   The Maven JAR and POM will be produced at:

   bazel-bin/com.vaticle.typedb:api.jar
   bazel-bin/pom.xml
   

FAQs

Q: I see a large number of Netty and gRPC log messages. How can I disable them?

A: Create a Logback configuration file and set the minimum log level to ERROR. You can do so with the following steps:

1. Create a file in your resources path (src/main/resources by default in a Maven project) named logback.xml.
2. Copy the following document into logback.xml:

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="ERROR">
        <appender-ref ref="STDOUT"/>
    </root>

</configuration>