Skip to content

Commit

Permalink
doc: upgraded dependency versions and mentioned java driver in texts …
Browse files Browse the repository at this point in the history
…about it
  • Loading branch information
novoj committed Feb 13, 2024
1 parent 30b6c87 commit 3300122
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Each code block is then rendered as an individual tab within the `<CodeTabsBlock
<dependency>
<groupId>io.evitadb</groupId>
<artifactId>evita_test_support</artifactId>
<version>0.6-SNAPSHOT</version>
<version>2024.2.2</version>
<scope>test</scope>
</dependency>
```
Expand Down
23 changes: 21 additions & 2 deletions documentation/user/en/get-started/query-our-dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,26 @@ thousands of products.

## Connect the Java client

Open your Java IDE and create an <SourceClass>evita_external_api/evita_external_api_grpc/client/src/main/java/io/evitadb/driver/EvitaClient.java</SourceClass>
Open your Java IDE and add the following dependency to your project:

<CodeTabs>
<CodeTabsBlock>
```Maven
<dependency>
<groupId>io.evitadb</groupId>
<artifactId>evita_java_driver</artifactId>
<version>2024.2.2</version>
</dependency>
```
</CodeTabsBlock>
<CodeTabsBlock>
```Gradle
implementation 'io.evitadb:evita_java_driver:2024.2.2'
```
</CodeTabsBlock>
</CodeTabs>

Then, create an <SourceClass>evita_external_api/evita_external_api_grpc/client/src/main/java/io/evitadb/driver/EvitaClient.java</SourceClass>
instance:

<SourceCodeTabs langSpecificTabOnly local>
Expand Down Expand Up @@ -264,4 +283,4 @@ If you need more hints for querying the data, try [the query API chapter](../use

</Note>

</LS>
</LS>
16 changes: 8 additions & 8 deletions documentation/user/en/get-started/run-evitadb.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,14 @@ To integrate evitaDB into your project, use the following steps:
<dependency>
<groupId>io.evitadb</groupId>
<artifactId>evita_db</artifactId>
<version>10.1.1</version>
<version>2024.2.2</version>
<type>pom</type>
</dependency>
```
</CodeTabsBlock>
<CodeTabsBlock>
```Gradle
implementation 'io.evitadb:evita_db:2024.1.3'
implementation 'io.evitadb:evita_db:2024.2.2'
```
</CodeTabsBlock>
</CodeTabs>
Expand Down Expand Up @@ -108,14 +108,14 @@ exception when you enable the corresponding API in evitaDB's configuration.
<dependency>
<groupId>io.evitadb</groupId>
<artifactId>evita_external_api_grpc</artifactId>
<version>10.1.1</version>
<version>2024.2.2</version>
<type>pom</type>
</dependency>
```
</CodeTabsBlock>
<CodeTabsBlock>
```Gradle
implementation 'io.evitadb:evita_external_api_grpc:2024.1.3'
implementation 'io.evitadb:evita_external_api_grpc:2024.2.2'
```
</CodeTabsBlock>
</CodeTabs>
Expand All @@ -128,14 +128,14 @@ implementation 'io.evitadb:evita_external_api_grpc:2024.1.3'
<dependency>
<groupId>io.evitadb</groupId>
<artifactId>evita_external_api_graphql</artifactId>
<version>10.1.1</version>
<version>2024.2.2</version>
<type>pom</type>
</dependency>
```
</CodeTabsBlock>
<CodeTabsBlock>
```Gradle
implementation 'io.evitadb:evita_external_api_graphql:2024.1.3'
implementation 'io.evitadb:evita_external_api_graphql:2024.2.2'
```
</CodeTabsBlock>
</CodeTabs>
Expand All @@ -148,14 +148,14 @@ implementation 'io.evitadb:evita_external_api_graphql:2024.1.3'
<dependency>
<groupId>io.evitadb</groupId>
<artifactId>evita_external_api_rest</artifactId>
<version>10.1.1</version>
<version>2024.2.2</version>
<type>pom</type>
</dependency>
```
</CodeTabsBlock>
<CodeTabsBlock>
```Gradle
implementation 'io.evitadb:evita_external_api_rest:2024.1.3'
implementation 'io.evitadb:evita_external_api_rest:2024.2.2'
```
</CodeTabsBlock>
</CodeTabs>
Expand Down
6 changes: 3 additions & 3 deletions documentation/user/en/use/api/write-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ artifact into your project:
<dependency>
<groupId>io.evitadb</groupId>
<artifactId>evita_test_support</artifactId>
<version>10.1.1</version>
<version>2024.2.2</version>
<scope>test</scope>
</dependency>
```
</CodeTabsBlock>
<CodeTabsBlock>
```Gradle
implementation 'io.evitadb:evita_test_support:2024.1.3'
implementation 'io.evitadb:evita_test_support:2024.2.2'
```
</CodeTabsBlock>
</CodeTabs>
Expand Down Expand Up @@ -378,4 +378,4 @@ you'd need a special cleanup procedure for your shared objects, and you might ap
<dd>Defines name of the associated dataset.</dd>
</dl>

</LS>
</LS>
23 changes: 21 additions & 2 deletions documentation/user/en/use/connectors/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,25 @@ So none of these topics will be covered here.

## Java remote client

In order to use a Java remote client you need only to add following dependency to your project:

<CodeTabs>
<CodeTabsBlock>
```Maven
<dependency>
<groupId>io.evitadb</groupId>
<artifactId>evita_java_driver</artifactId>
<version>2024.2.2</version>
</dependency>
```
</CodeTabsBlock>
<CodeTabsBlock>
```Gradle
implementation 'io.evitadb:evita_java_driver:2024.2.2'
```
</CodeTabsBlock>
</CodeTabs>

Java remote client builds on top of the [gRPC API](./grpc.md). The <SourceClass>evita_external_api/evita_external_api_grpc/client/src/main/java/io/evitadb/driver/EvitaClient.java</SourceClass>
is thread safe and only single instance of it is expected to be used in the application. The client internally manages
a pool of gRPC connections to handle parallel communication with the server.
Expand Down Expand Up @@ -223,7 +242,7 @@ needs to be added as dependency:
<dependency>
<groupId>one.edee.oss</groupId>
<artifactId>proxycian_bytebuddy</artifactId>
<version>1.3.10</version>
<version>1.4.0</version>
</dependency>
```

Expand Down Expand Up @@ -333,4 +352,4 @@ Now we can use the interfaces described above in the following way:
The sealed/open principle is a bit more complex than the naive approach of using a single interface for both reading and
writing data, but it clearly separates the read and write scenarios, allowing you to maintain control over mutations and
their visibility in a multi-threaded environment.
</LS>
</LS>

0 comments on commit 3300122

Please sign in to comment.