/cottontaildb-examples

Repository with getting started examples for Cottontail DB.

Primary LanguageKotlinMIT LicenseMIT

Cottontail DB Examples

This repository contains some simple examples as to how to use Cottontail DB using either a Kotlin or Java client. Since Cottontail DB uses gRPC to communicate with its clients, other technologies can be used as well. See gRPC List of Languages for a full list of supported platforms.

Prerequites

You need an instance of Cottontail DB running either on localhost or some remote host of your choice. In case you're not running Cottontail DB on the same host, make sure to adjust hostname and IP address in example scripts (ExamplesGrpc.kt, ExamplesSimple.kt or Examples.java). Same holds true if you're running Cottontail DB on a different port than 1865.

Furthermore, you will need Java 8 or newer on the machine you're running the example project on. The project comes with a Gradle Wrapper, so no need to have Gradle installed locally.

How to use

Checkout the repository to your local machine by using the following command.

git clone https://github.com/vitrivr/cottontaildb-examples.git

To run the Kotlin example, use the following command from within the project directory.

./gradlew runKotlinExample

Of course, it is also possible to simply open the project in your favourite IDE and use it as a Gradle project from there.

Words on the example data

The example data was taken from the YLI feature corpus. Namely, we're using some LIRE features in this example. You can download the full dataset for the YFCC100M collection from here.