Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DEVEX-188] Rebrand Client #294

Open
wants to merge 12 commits into
base: trunk
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/plugins-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
type: string
default: enterprise

esdb_version:
kdb_version:
required: true
type: string

Expand Down Expand Up @@ -57,9 +57,9 @@ jobs:
- name: Execute Gradle build
run: ./gradlew ci --tests ${{ matrix.test }}Tests
env:
EVENTSTORE_DOCKER_REGISTRY_ENV: docker.eventstore.com
EVENTSTORE_DOCKER_IMAGE_ENV: ${{ needs.provide_docker.outputs.docker_repo }}/${{ needs.provide_docker.outputs.docker_container }}
EVENTSTORE_DOCKER_TAG_ENV: ${{ inputs.esdb_version }}
KURRENT_DOCKER_REGISTRY_ENV: docker.eventstore.com
KURRENT_DOCKER_IMAGE_ENV: ${{ needs.provide_docker.outputs.docker_repo }}/${{ needs.provide_docker.outputs.docker_container }}
KURRENT_DOCKER_TAG_ENV: ${{ inputs.kdb_version }}
SECURE: true

- uses: actions/upload-artifact@v3
Expand Down Expand Up @@ -97,7 +97,7 @@ jobs:
env:
CONTAINER_REGISTRY: docker.eventstore.com
CONTAINER_IMAGE: ${{ needs.provide_docker.outputs.docker_repo }}/${{ needs.provide_docker.outputs.docker_container }}
CONTAINER_IMAGE_VERSION: ${{ inputs.esdb_version }}
CONTAINER_IMAGE_VERSION: ${{ inputs.kdb_version }}

- name: Generate user certificates
run: docker compose --file configure-user-certs-for-tests.yml up
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pull-requests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:

uses: ./.github/workflows/tests.yml
with:
esdb_version: ${{ matrix.version }}
kdb_version: ${{ matrix.version }}

plugins-tests:
needs: build
Expand All @@ -55,5 +55,5 @@ jobs:

uses: ./.github/workflows/plugins-tests.yml
with:
esdb_version: ${{ matrix.version }}
kdb_version: ${{ matrix.version }}
secrets: inherit
2 changes: 1 addition & 1 deletion .github/workflows/test-dispatch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ jobs:
name: Test
uses: ./.github/workflows/tests.yml
with:
esdb_version: ${{ inputs.version }}
kdb_version: ${{ inputs.version }}
runtime_env: ${{ inputs.runtime_env }}
16 changes: 8 additions & 8 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
type: string
default: release

esdb_version:
kdb_version:
required: true
type: string

Expand Down Expand Up @@ -44,9 +44,9 @@ jobs:
- name: Execute Gradle build
run: ./gradlew ci --tests ${{ matrix.test }}Tests
env:
EVENTSTORE_DOCKER_REGISTRY_ENV: docker.eventstore.com
EVENTSTORE_DOCKER_IMAGE_ENV: ${{ needs.provide_docker.outputs.docker_repo }}/${{ needs.provide_docker.outputs.docker_container }}
EVENTSTORE_DOCKER_TAG_ENV: ${{ inputs.esdb_version }}
KURRENT_DOCKER_REGISTRY_ENV: docker.eventstore.com
KURRENT_DOCKER_IMAGE_ENV: ${{ needs.provide_docker.outputs.docker_repo }}/${{ needs.provide_docker.outputs.docker_container }}
KURRENT_DOCKER_TAG_ENV: ${{ inputs.kdb_version }}

- uses: actions/upload-artifact@v3
if: failure()
Expand Down Expand Up @@ -85,9 +85,9 @@ jobs:
- name: Execute Gradle build
run: ./gradlew ci --tests ${{ matrix.test }}Tests
env:
EVENTSTORE_DOCKER_REGISTRY_ENV: docker.eventstore.com
EVENTSTORE_DOCKER_IMAGE_ENV: ${{ needs.provide_docker.outputs.docker_repo }}/${{ needs.provide_docker.outputs.docker_container }}
EVENTSTORE_DOCKER_TAG_ENV: ${{ inputs.esdb_version }}
KURRENT_DOCKER_REGISTRY_ENV: docker.eventstore.com
KURRENT_DOCKER_IMAGE_ENV: ${{ needs.provide_docker.outputs.docker_repo }}/${{ needs.provide_docker.outputs.docker_container }}
KURRENT_DOCKER_TAG_ENV: ${{ inputs.kdb_version }}
SECURE: true

- uses: actions/upload-artifact@v3
Expand All @@ -114,7 +114,7 @@ jobs:
env:
CONTAINER_REGISTRY: docker.eventstore.com
CONTAINER_IMAGE: ${{ needs.provide_docker.outputs.docker_repo }}/${{ needs.provide_docker.outputs.docker_container }}
CONTAINER_IMAGE_VERSION: ${{ inputs.esdb_version }}
CONTAINER_IMAGE_VERSION: ${{ inputs.kdb_version }}

- name: Set up JDK 8
uses: actions/setup-java@v3
Expand Down
2 changes: 1 addition & 1 deletion CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributor Covenant Code of Conduct

`EventStoreDB-Client-Java` follows the widely-adopted Contributor Covenant Code of Conduct.
`Kurrent-Client-Java` follows the widely-adopted Contributor Covenant Code of Conduct.

## Our Pledge

Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to `EventStoreDB-Client-Java`
# Contributing to `Kurrent-Client-Java`

Welcome to the Event Store community, and thank you for contributing! The following guide outlines the basics of how to get involved. Pull requests to update and expand this guide are very welcome!

Expand All @@ -10,7 +10,7 @@ We want the Event Store community to be as welcoming and inclusive as possible,

### Licensing

`EventStoreDB-Client-Java` is licensed under the [Apache-2.0][apache2] license. By submitting a pull request, you represent that you have right to license your contribution to Event Store Ltd and the community, and that by submitting a patch your contributions are licensed under the Apache-2.0 license.
`Kurrent-Client-Java` is licensed under the [Apache-2.0][apache2] license. By submitting a pull request, you represent that you have right to license your contribution to Event Store Ltd and the community, and that by submitting a patch your contributions are licensed under the Apache-2.0 license.

## Contributing

Expand All @@ -22,7 +22,7 @@ Please disclose issues which you believe to be a security threat _by e-mail_ to

Issues may be reported via the [GitHub Repository][github-repo]. When reporting issues, please ensure that you include relevant information which can help diagnose the problem. This includes:

- The version of `EventStoreDB-Client-Java` - including a commit SHA if using a local build
- The version of `Kurrent-Client-Java` - including a commit SHA if using a local build

- The operating system on which the issue is exhibited (on Unix, the output of `uname -a`)

Expand All @@ -47,8 +47,8 @@ Please ensure that the following steps have been undertaken before marking pull
- Ensure that commits are atomic units of work, and that the message follows our [Commit Message Template][commit-template]. A good way to do this is to configure your local clone of the repository to use our included template, by running: `git config commit.template .git.commit.template` in the root directory of the clone.


[conduct]: https://github.com/EventStore/EventStoreDB-Client-Java/tree/master/CODE-OF-CONDUCT.md
[conduct]: https://github.com/EventStore/Kurrent-Client-Java/tree/master/CODE-OF-CONDUCT.md
[apache2]: https://www.apache.org/licenses/LICENSE-2.0
[commit-template]: https://github.com/EventStore/EventStoreDB-Client-Java/tree/master/.git.commit.template
[github-repo]: https://github.com/EventStore/EventStoreDB-Client-Java
[commit-template]: https://github.com/EventStore/Kurrent-Client-Java/tree/master/.git.commit.template
[github-repo]: https://github.com/EventStore/Kurrent-Client-Java
[drafts]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests
66 changes: 32 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# EventStoreDB Client SDK for Java
# Kurrent Client SDK for Java

EventStoreDB is the event-native database, where business events are immutably stored and streamed. Designed for event-sourced, event-driven, and microservices architectures.
KurrentDB is the event-native database, where business events are immutably stored and streamed. Designed for event-sourced, event-driven, and microservices architectures.

This repository contains an [EventStoreDB][es] Client SDK written in Java for use with languages on the JVM. It is
This repository contains an [KurrentDB][kurrent] Client SDK written in Java for use with languages on the JVM. It is
compatible with Java 8 and above.

*Note: This client is currently under active development and further API changes are expected. Feedback is very welcome.*

## Documentation
* General documentation can be found in [Event Store GRPC Docs].
* The latest stable version Javadoc can be found here: https://eventstore.github.io/EventStoreDB-Client-Java
* General documentation can be found in [Kurrent GRPC Docs].
* The latest stable version Javadoc can be found here: https://kurrent.github.io/Kurrent-Client-Java

## Access to binaries
EventStore Ltd publishes GA (general availability) versions to [Maven Central].
Expand All @@ -31,22 +31,21 @@ repositories {

## Developing

The SDK is built using [`Gradle`][gradle]. Integration tests run against a server using Docker, with the [EventStoreDB gRPC
Client Test Container][container].
The SDK is built using [`Gradle`][gradle]. Integration tests run against a server using Docker.

### Run tests

Tests are written using [TestContainers](https://www.testcontainers.org/) and require [Docker](https://www.docker.com/) to be installed.

Specific docker images can be specified via the enviroment variable `EVENTSTORE_IMAGE`.
Specific docker images can be specified via the environment variable `EVENTSTORE_IMAGE`.

## Open Telemetry

Tracing is the only telemetry currently exported, specifically for the `Append` and `Subscribe` (Catchup and Persistent) operations.

For more information about Open Telemetry, refer to the [official documentation](https://opentelemetry.io/docs/what-is-opentelemetry/).

## EventStoreDB Server Compatibility
## KurrentDB Server Compatibility

This client is compatible with version `20.6.1` upwards.

Expand Down Expand Up @@ -81,19 +80,19 @@ class AccountCreated {
}
```
```java
import com.eventstore.dbclient.EventStoreDBClient;
import com.eventstore.dbclient.EventStoreDBClientSettings;
import com.eventstore.dbclient.EventStoreDBConnectionString;
import com.eventstore.dbclient.EventData;
import com.eventstore.dbclient.ReadStreamOptions;
import com.eventstore.dbclient.ResolvedEvent;
import com.eventstore.dbclient.WriteResult;
import com.eventstore.dbclient.ReadResult;
import io.kurrent.dbclient.KurrentDBClient;
import io.kurrent.dbclient.KurrentDBClientSettings;
import io.kurrent.dbclient.KurrentDBConnectionString;
import io.kurrent.dbclient.EventData;
import io.kurrent.dbclient.ReadStreamOptions;
import io.kurrent.dbclient.ResolvedEvent;
import io.kurrent.dbclient.WriteResult;
import io.kurrent.dbclient.ReadResult;

public class Main {
public static void main(String args[]) {
EventStoreDBClientSettings setts = EventStoreDBConnectionString.parseOrThrow("esdb://localhost:2113");
EventStoreDBClient client = EventStoreDBClient.create(setts);
KurrentDBClientSettings setts = KurrentDBConnectionString.parseOrThrow("esdb://localhost:2113");
KurrentDBClient client = KurrentDBClient.create(setts);

AccountCreated createdEvent = new AccountCreated();

Expand Down Expand Up @@ -134,8 +133,8 @@ This client currently supports creating and getting the result of a continuous p

Create a projection:
```java
EventStoreDbClientSettings setts = EventStoreDBConnectionString.parseOrThrow("esdb://localhost:2113");
EventStoreDBProjectionManagementClient client = EventStoreDBProjectionManagementClient.create(setts);
KurrentDbClientSettings setts = KurrentDBConnectionString.parseOrThrow("esdb://localhost:2113");
KurrentDBProjectionManagementClient client = KurrentDBProjectionManagementClient.create(setts);

client
.createContinuous(PROJECTION_NAME, PROJECTION_JS)
Expand Down Expand Up @@ -165,40 +164,39 @@ CountResult result = client
.get();
```

For further details please see [the projection management tests](src/test/java/com/eventstore/dbclient/ProjectionManagementTests.java).
For further details please see [the projection management tests](src/test/java/io/kurrent/dbclient/ProjectionManagementTests.java).

## Support

Information on support can be found on our website: [Event Store Support][support]
Information on support can be found on our website: [Kurrent Support][support]

## Documentation

Documentation for EventStoreDB can be found in the [docs].
Documentation for KurrentDB can be found in the [docs].

Bear in mind that this client is not yet properly documented. We are working hard on a new version of the documentation.

## Security

If you find a vulnerability in our software, please contact us. You can find how to reach out us and report it at https://www.eventstore.com/security#security
If you find a vulnerability in our software, please contact us. You can find how to reach out us and report it at https://www.kurrent.io/security#security
Thank you very much for supporting our software.

## Communities

- [Discuss](https://discuss.eventstore.com/)
- [Discord (Event Store)](https://discord.gg/Phn9pmCw3t)
- [Discord (Kurrent)](https://discord.gg/Phn9pmCw3t)

## Contributing

All contributions to the SDK are made via GitHub Pull Requests, and must be licensed under the Apache 2.0 license. Please
review our [Contributing Guide][contributing] and [Code of Conduct][code-of-conduct] for more information.

[es]: https://eventstore.com
[kurrent]: https://kurrent.io
[gradle]: https://gradle.org
[container]: https://github.com/EventStore/EventStore-Client-gRPC-TestData
[contributing]: https://github.com/EventStore/EventStoreDB-Client-Java/tree/master/CONTRIBUTING.md
[code-of-conduct]: https://github.com/EventStore/EventStoreDB-Client-Java/tree/master/CODE-OF-CONDUCT.md
[support]: https://eventstore.com/support/
[docs]: https://developers.eventstore.com/server/v21.6/installation/
[contributing]: https://github.com/EventStore/Kurrent-Client-Java/tree/master/CONTRIBUTING.md
[code-of-conduct]: https://github.com/EventStore/Kurrent-Client-Java/tree/master/CODE-OF-CONDUCT.md
[support]: https://kurrent.io/support/
[docs]: https://developers.eventstore.com/server/v24.6/quick-start/installation/
[discuss]: https://discuss.eventstore.com/
[Maven Central]: https://search.maven.org/artifact/com.eventstore/db-client-java
[Event Store GRPC Docs]: https://developers.eventstore.com/clients/grpc
[Maven Central]: https://search.maven.org/artifact/io.kurrent/db-client-java
[Kurrent GRPC Docs]: https://developers.eventstore.com/clients/grpc
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ allprojects {
}

if (!JavaVersion.current().isJava8Compatible()) {
throw new Exception("Java 8 is required to build EventStoreDB-Client-Java")
throw new Exception("Java 8 is required to build Kurrent-Client-Java")
}
14 changes: 7 additions & 7 deletions db-client-java/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ tasks.withType(JavaCompile) {
options.compilerArgs += ['-Xlint:deprecation', '-Xlint:unchecked']
}

group = 'com.eventstore'
group = 'io.kurrent'
version = '5.4.3'

java {
Expand Down Expand Up @@ -201,16 +201,16 @@ publishing {

from components.java
pom {
name = 'EventStoreDB Client Java'
name = 'Kurrent Client Java'
// packaging 'jar'
// optionally artifactId can be defined here
description = 'EventStoreDB gRPC Java client'
url = 'https://eventstore.com'
description = 'Kurrent gRPC Java client'
url = 'https://kurrent.io'

scm {
connection = 'https://github.com/EventStore/EventStoreDB-Client-Java.git'
developerConnection = 'https://github.com/EventStore/EventStoreDB-Client-Java.git'
url = 'https://github.com/EventStore/EventStoreDB-Client-Java'
connection = 'https://github.com/EventStore/Kurrent-Client-Java.git'
developerConnection = 'https://github.com/EventStore/Kurrent-Client-Java.git'
url = 'https://github.com/EventStore/Kurrent-Client-Java'
}

licenses {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package com.eventstore.dbclient;
package io.kurrent.dbclient;

import com.eventstore.dbclient.proto.projections.Projectionmanagement;
import com.eventstore.dbclient.proto.projections.ProjectionsGrpc;
import io.kurrent.dbclient.proto.projections.Projectionmanagement;
import io.kurrent.dbclient.proto.projections.ProjectionsGrpc;

import java.util.concurrent.CompletableFuture;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.eventstore.dbclient;
package io.kurrent.dbclient;

/**
* Options of the abort projection request.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package com.eventstore.dbclient;
package io.kurrent.dbclient;

import com.eventstore.dbclient.proto.persistentsubscriptions.Persistent;
import com.eventstore.dbclient.proto.persistentsubscriptions.PersistentSubscriptionsGrpc;
import io.kurrent.dbclient.proto.persistentsubscriptions.Persistent;
import io.kurrent.dbclient.proto.persistentsubscriptions.PersistentSubscriptionsGrpc;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package com.eventstore.dbclient;
package io.kurrent.dbclient;

import com.eventstore.dbclient.proto.persistentsubscriptions.Persistent;
import com.eventstore.dbclient.proto.persistentsubscriptions.PersistentSubscriptionsGrpc;
import io.kurrent.dbclient.proto.persistentsubscriptions.Persistent;
import io.kurrent.dbclient.proto.persistentsubscriptions.PersistentSubscriptionsGrpc;

import java.util.concurrent.CompletableFuture;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.eventstore.dbclient;
package io.kurrent.dbclient;

import java.time.Duration;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package com.eventstore.dbclient;
package io.kurrent.dbclient;

import com.eventstore.dbclient.proto.shared.Shared;
import com.eventstore.dbclient.proto.streams.StreamsGrpc;
import com.eventstore.dbclient.proto.streams.StreamsOuterClass;
import io.kurrent.dbclient.proto.shared.Shared;
import io.kurrent.dbclient.proto.streams.StreamsGrpc;
import io.kurrent.dbclient.proto.streams.StreamsOuterClass;
import io.grpc.Metadata;
import io.grpc.StatusRuntimeException;
import io.grpc.stub.ClientCallStreamObserver;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package com.eventstore.dbclient;
package io.kurrent.dbclient;

import com.eventstore.dbclient.proto.shared.Shared;
import com.eventstore.dbclient.proto.streams.StreamsGrpc;
import com.eventstore.dbclient.proto.streams.StreamsOuterClass;
import io.kurrent.dbclient.proto.shared.Shared;
import io.kurrent.dbclient.proto.streams.StreamsGrpc;
import io.kurrent.dbclient.proto.streams.StreamsOuterClass;
import io.grpc.Metadata;
import io.grpc.Status;
import io.grpc.StatusRuntimeException;
Expand Down
Loading
Loading