feat: create typsense plugin #2
Conversation
| collection: Countries | ||
| query: Paris | ||
| queryBy: capital | ||
| filter: countryName: [France, England] |
There was a problem hiding this comment.
How to apply multiple filter (if possible)?
There was a problem hiding this comment.
When using typescript, you can pass many filters in the same line -> price:>500 && in_stock:=true && category:='Electronics'
https://typesense.org/docs/26.0/api/search.html#filter-parameters
build.gradle
Outdated
| @@ -30,7 +30,7 @@ java { | |||
| } | |||
|
|
|||
| group "io.kestra.plugin" | |||
| description 'Plugin template for Kestra' | |||
| description 'Plugin typsense for Kestra' | |||
There was a problem hiding this comment.
| description 'Plugin typsense for Kestra' | |
| description 'Plugin typesense for Kestra' |
build.gradle
Outdated
| @@ -98,6 +101,11 @@ dependencies { | |||
| testImplementation "org.junit.jupiter:junit-jupiter-engine" | |||
| testImplementation "org.hamcrest:hamcrest" | |||
| testImplementation "org.hamcrest:hamcrest-library" | |||
|
|
|||
| //test container | |||
| testImplementation 'org.testcontainers:testcontainers:1.20.+' | |||
There was a problem hiding this comment.
We usually fix the latest version and let dependabot updating it.
We never use non-exact version.
| @Schema( | ||
| title = "The host of the typsense DB", | ||
| example = "localhost", | ||
| requiredMode = RequiredMode.REQUIRED |
There was a problem hiding this comment.
requiredMode is not needed, we parse the annotation when generating the schema and add required=true if we found the @NotNull
| protected Property<String> port; | ||
|
|
||
| @Schema( | ||
| title = "The api key to connect to the typsense DB", |
There was a problem hiding this comment.
| title = "The api key to connect to the typsense DB", | |
| title = "The API key to connect to the typsense DB", |
|
|
||
| @Schema( | ||
| title = "The name of the typsense collection", | ||
| example = "my_collection", |
There was a problem hiding this comment.
We don't use example so no need to add them.
| private Property<String> from; | ||
|
|
||
| @Override | ||
| public VoidOutput run(RunContext runContext) throws Exception { |
There was a problem hiding this comment.
We usually retrun an output containing the number of line stored.
| } catch (ObjectNotFound e){ | ||
| logger.error("No document found for id {}", renderedDocumentId, e); | ||
| } |
There was a problem hiding this comment.
Maybe let the task fail if there is nothing?
We usually do that.
| @Schema( | ||
| title = "Short description for this output", | ||
| description = "Full description of this output" |
There was a problem hiding this comment.
Hum, this didn't seems very accurate
| .documents() | ||
| .upsert(runContext.render(document).asMap(String.class, Object.class)); | ||
|
|
||
| runContext.metric(Counter.of("documentAdded", 1)); |
There was a problem hiding this comment.
This seems useless, you have one doc you add a metric of 1, not very useful (but a metric would be great on the bulk task)
| example = "countryName: [France, Germany]" | ||
| ) | ||
| @Default | ||
| protected Property<String> filter = Property.of(""); |
There was a problem hiding this comment.
default of empty seems not very usefull, maybe add no default as a property is always render via an Optional
| title = "The chunk size for every bulk request", | ||
| description = "Default value is 1000" | ||
| ) | ||
| private Property<Integer> chunk; |
There was a problem hiding this comment.
| private Property<Integer> chunk; | |
| private Property<Integer> chunk = Property.of(10); |
This would correctly document the default value.
What changes are being made and why?
This is the initialisation of the typesense plugin. It allows to:
How the changes have been QAed?
Setup Instructions