Skip to content

Commit

Permalink
now targets typesense 0.24.1 (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
runeanielsen authored Apr 10, 2023
1 parent 468e05d commit 2a539f7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ executors:
auth:
username: $DOCKER_LOGIN
password: $DOCKER_ACCESSTOKEN
- image: typesense/typesense:0.24.0 # For integration testing
- image: typesense/typesense:0.24.1 # For integration testing
auth:
username: $DOCKER_LOGIN
password: $DOCKER_ACCESSTOKEN
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Clojars Project](https://img.shields.io/clojars/v/io.github.runeanielsen/typesense-clj.svg)](https://clojars.org/io.github.runeanielsen/typesense-clj)

Clojure client for [Typesense 0.24.0](https://github.com/typesense/typesense)
Clojure client for [Typesense 0.24.1](https://github.com/typesense/typesense)

All of the examples uses the `typesense.client` namespace. The examples shows the simplest way to get started using the client, but all parameters described on Typesense API documentation should work, if that is not the case, please make a pull-request or open an issue.

Expand All @@ -22,11 +22,11 @@ Example of settings.

## Collection

This section describes how to use the collection, further information can be found [here.](https://typesense.org/docs/0.24.0/api/collections.html#create-a-collection)
This section describes how to use the collection, further information can be found [here.](https://typesense.org/docs/0.24.1/api/collections.html#create-a-collection)

### Create collection

The different `types` for the schema can be found [here](https://typesense.org/docs/0.24.0/api/collections.html#create-a-collection).
The different `types` for the schema can be found [here](https://typesense.org/docs/0.24.1/api/collections.html#create-a-collection).

The examples displays the creation of collection named `companies`.

Expand Down Expand Up @@ -78,7 +78,7 @@ The examples displays the creation of collection named `companies`.

### Update collection

The different `types` for the schema can be found [here](https://typesense.org/docs/0.24.0/api/collections.html#update-or-alter-a-collection).
The different `types` for the schema can be found [here](https://typesense.org/docs/0.24.1/api/collections.html#update-or-alter-a-collection).

The examples shows updating the collection named named `companies` with a new field `year_founded`.

Expand Down Expand Up @@ -222,7 +222,7 @@ Retrieves the collection on the `collection-name`.

## Documents

This section describes how to use the documents, further information can be found [here.](https://typesense.org/docs/0.24.0/api/documents.html)
This section describes how to use the documents, further information can be found [here.](https://typesense.org/docs/0.24.1/api/documents.html)

### Create document

Expand Down Expand Up @@ -300,7 +300,7 @@ Update document in a collection on id. The update can be partial.

## Create/Upsert/Update/Delete Documents

Create/upsert/update documents. All of them takes optional parameters, an example is setting the batch size using `:batch_size 20`. Read more [here.](https://typesense.org/docs/0.24.0/api/documents.html#import-documents)
Create/upsert/update documents. All of them takes optional parameters, an example is setting the batch size using `:batch_size 20`. Read more [here.](https://typesense.org/docs/0.24.1/api/documents.html#import-documents)

### Create documents

Expand Down Expand Up @@ -379,7 +379,7 @@ Export documents in collection.

## Search

Search for documents in a collection. You can find all the query arguments [here.](https://typesense.org/docs/0.24.0/api/documents.html#arguments)
Search for documents in a collection. You can find all the query arguments [here.](https://typesense.org/docs/0.24.1/api/documents.html#arguments)

```clojure
(search settings "companies" {:q "Innovation"
Expand Down Expand Up @@ -421,7 +421,7 @@ Search for documents in a collection. You can find all the query arguments [here

## Multi search

You can send multiple search requests in a single HTTP request, using the Multi-Search feature. This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can read more about multi-search [here.](https://typesense.org/docs/0.24.0/api/documents.html#federated-multi-search)
You can send multiple search requests in a single HTTP request, using the Multi-Search feature. This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can read more about multi-search [here.](https://typesense.org/docs/0.24.1/api/documents.html#federated-multi-search)

```clojure
(multi-search
Expand Down Expand Up @@ -530,7 +530,7 @@ You can send multiple search requests in a single HTTP request, using the Multi-

## Api keys

Typesense allows you to create API Keys with fine-grain access control. You can restrict access on both a per-collection and per-action level, [read more here](https://typesense.org/docs/0.24.0/api/api-keys.html#create-an-api-key)
Typesense allows you to create API Keys with fine-grain access control. You can restrict access on both a per-collection and per-action level, [read more here](https://typesense.org/docs/0.24.1/api/api-keys.html#create-an-api-key)

### Create api key

Expand Down Expand Up @@ -593,7 +593,7 @@ Deletes api key on `id`.

## Curation

Using overrides, you can include or exclude specific documents for a given query, read more [here.](https://typesense.org/docs/0.24.0/api/curation.html)
Using overrides, you can include or exclude specific documents for a given query, read more [here.](https://typesense.org/docs/0.24.1/api/curation.html)

### Create or update an override

Expand Down Expand Up @@ -664,7 +664,7 @@ Deletes override on name.

## Collection alias

An alias is a virtual collection name that points to a real collection. Read more [here](https://typesense.org/docs/0.24.0/api/collection-alias.html)
An alias is a virtual collection name that points to a real collection. Read more [here](https://typesense.org/docs/0.24.1/api/collection-alias.html)

### Create or update alias

Expand Down Expand Up @@ -712,7 +712,7 @@ Delete alias on collection name.

## Synonyms

The synonyms feature allows you to define search terms that should be considered equivalent, read more [here.](https://typesense.org/docs/0.24.0/api/synonyms.html)
The synonyms feature allows you to define search terms that should be considered equivalent, read more [here.](https://typesense.org/docs/0.24.1/api/synonyms.html)

### Create or update synonym

Expand Down Expand Up @@ -762,7 +762,7 @@ Delete synonym on synonym-name in collection.

### Typesense API Errors

Typesense API exceptions in the [Typesense-api-errors](https://typesense.org/docs/0.24.0/api/api-errors.html) spec.
Typesense API exceptions in the [Typesense-api-errors](https://typesense.org/docs/0.24.1/api/api-errors.html) spec.

| Type | Description |
|:------------------------------------------|:---------------------------------------------------------------------------|
Expand Down Expand Up @@ -792,7 +792,7 @@ bin/kaocha unit
To run the integration tests you can run a local docker instance with the following command. This will start a instance of Typesense on `localhost:8108`. The Typesense instance will be cleaned before starting the integration tests.

```sh
docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:0.24.0 --data-dir /data --api-key=key
docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:0.24.1 --data-dir /data --api-key=key
```

The following command runs only the integration tests.
Expand Down

0 comments on commit 2a539f7

Please sign in to comment.