This is an automated email from the ASF dual-hosted git repository. Croway pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
commit 4d0e337b93beafc18f64285ca413718cbb1ad531 Author: croway <[email protected]> AuthorDate: Tue Sep 15 13:42:20 2026 +0200 Add camel-pgvector-starter camel-pgvector performs vector operations against the PostgreSQL pgvector extension but never got a Spring Boot starter. Generate it with starter-create and regenerate the docs, catalog (including the pgvector-embeddings/pgvector-rag data type transformers) and dependencies BOM entries. Add a smoke test verifying camel.component.pgvector.* Spring Boot properties are copied onto the component's nested PgVectorConfiguration. Co-Authored-By: Claude Sonnet 5 <[email protected]> --- .../camel/springboot/catalog/components.properties | 1 + .../springboot/catalog/components/pgvector.json | 50 +++++ .../springboot/catalog/transformers.properties | 2 + .../catalog/transformers/pgvector-embeddings.json | 14 ++ .../catalog/transformers/pgvector-rag.json | 14 ++ components-starter/camel-pgvector-starter/pom.xml | 48 +++++ .../src/main/docs/pgvector.json | 66 +++++++ .../PgVectorComponentAutoConfiguration.java | 74 ++++++++ .../springboot/PgVectorComponentConfiguration.java | 127 +++++++++++++ .../springboot/PgVectorComponentConverter.java | 54 ++++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 ++ ...rk.boot.autoconfigure.AutoConfiguration.imports | 18 ++ .../PgVectorComponentAutoConfigurationTest.java | 55 ++++++ components-starter/pom.xml | 1 + docs/spring-boot/modules/ROOT/nav.adoc | 1 + .../modules/ROOT/pages/starters/pgvector.adoc | 37 ++++ tooling/camel-spring-boot-dependencies/pom.xml | 5 + 18 files changed, 781 insertions(+) diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties index 23d447d7cca..daaa1e4740c 100644 --- a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties @@ -303,6 +303,7 @@ paho-mqtt5 pdf pg-replication-slot pgevent +pgvector pinecone platform-http plc4x diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/pgvector.json b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/pgvector.json new file mode 100644 index 00000000000..39940f894ec --- /dev/null +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/pgvector.json @@ -0,0 +1,50 @@ +{ + "component": { + "kind": "component", + "name": "pgvector", + "title": "PGVector", + "description": "Perform operations on the PostgreSQL pgvector Vector Database.", + "deprecated": false, + "firstVersion": "4.19.0", + "label": "database,ai", + "javaType": "org.apache.camel.component.pgvector.PgVectorComponent", + "supportLevel": "Stable", + "groupId": "org.apache.camel.springboot", + "artifactId": "camel-pgvector-starter", + "version": "4.23.0-SNAPSHOT", + "scheme": "pgvector", + "extendsScheme": "", + "syntax": "pgvector:collection", + "async": false, + "api": false, + "consumerOnly": false, + "producerOnly": true, + "lenientProperties": false, + "browsable": false, + "remote": true + }, + "componentProperties": { + "configuration": { "index": 0, "kind": "property", "displayName": "Configuration", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.pgvector.PgVectorConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "The configuration;" }, + "dataSource": { "index": 1, "kind": "property", "displayName": "Data Source", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "javax.sql.DataSource", "deprecated": false, "deprecationNote": "", "autowired": true, "secret": false, "configurationClass": "org.apache.camel.component.pgvector.PgVectorConfiguration", "configurationField": "configuration", "description": "The DataSource to use for connecting to the PostgreSQL database with pgvector extension." }, + "dimension": { "index": 2, "kind": "property", "displayName": "Dimension", "group": "producer", "label": "producer", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": 384, "configurationClass": "org.apache.camel.component.pgvector.PgVectorConfiguration", "configurationField": "configuration", "description": "The dimension of the vectors to store." }, + "distanceType": { "index": 3, "kind": "property", "displayName": "Distance Type", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "org.apache.camel.component.pgvector.PgVectorDistanceType", "enum": [ "COSINE", "EUCLIDEAN", "INNER_PRODUCT" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "COSINE", "configurationClass": "org.apache.camel.component.pgvector.PgVectorConfiguration", "configurationF [...] + "lazyStartProducer": { "index": 4, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail [...] + "autowiredEnabled": { "index": 5, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching t [...] + }, + "headers": { + "CamelPgVectorAction": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "enum": [ "CREATE_TABLE", "CREATE_INDEX", "DROP_TABLE", "UPSERT", "DELETE", "SIMILARITY_SEARCH" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The action to be performed.", "constantName": "org.apache.camel.component.pgvector.PgVectorHeaders#ACTION" }, + "CamelPgVectorRecordId": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The id of the vector record.", "constantName": "org.apache.camel.component.pgvector.PgVectorHeaders#RECORD_ID" }, + "CamelPgVectorQueryTopK": { "index": 2, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "3", "description": "The maximum number of results to return for similarity search.", "constantName": "org.apache.camel.component.pgvector.PgVectorHeaders#QUERY_TOP_K" }, + "CamelPgVectorTextContent": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The text content to store alongside the vector embedding.", "constantName": "org.apache.camel.component.pgvector.PgVectorHeaders#TEXT_CONTENT" }, + "CamelPgVectorMetadata": { "index": 4, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The metadata associated with the vector record, stored as JSON.", "constantName": "org.apache.camel.component.pgvector.PgVectorHeaders#METADATA" }, + "CamelPgVectorFilter": { "index": 5, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Filter condition for similarity search. Applied as a SQL WHERE clause on the text_content and metadata columns. Supports parameterized queries using placeholders with values provided via the CamelPgVectorFilterParams header. WARNING: When not [...] + "CamelPgVectorFilterParams": { "index": 6, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "java.util.List", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Parameter values for parameterized filter queries. Use with placeholders in the CamelPgVectorFilter header. Example: filter = 'text_content LIKE AND metadata::jsonb-'category' = ' with filterParams = List.of(%hello%, science).", [...] + }, + "properties": { + "collection": { "index": 0, "kind": "path", "displayName": "Collection", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The collection (table) name" }, + "dataSource": { "index": 1, "kind": "parameter", "displayName": "Data Source", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "javax.sql.DataSource", "deprecated": false, "deprecationNote": "", "autowired": true, "secret": false, "configurationClass": "org.apache.camel.component.pgvector.PgVectorConfiguration", "configurationField": "configuration", "description": "The DataSource to use for connecting to the PostgreSQL database with pgvector extens [...] + "dimension": { "index": 2, "kind": "parameter", "displayName": "Dimension", "group": "producer", "label": "producer", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": 384, "configurationClass": "org.apache.camel.component.pgvector.PgVectorConfiguration", "configurationField": "configuration", "description": "The dimension of the vectors to store." }, + "distanceType": { "index": 3, "kind": "parameter", "displayName": "Distance Type", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "org.apache.camel.component.pgvector.PgVectorDistanceType", "enum": [ "COSINE", "EUCLIDEAN", "INNER_PRODUCT" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": "COSINE", "configurationClass": "org.apache.camel.component.pgvector.PgVectorConfiguration", "configuration [...] + "lazyStartProducer": { "index": 4, "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a produc [...] + } +} diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/transformers.properties b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/transformers.properties index 8bc37a131c9..2e1fc59dfc0 100644 --- a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/transformers.properties +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/transformers.properties @@ -32,6 +32,8 @@ infinispan-embeddings milvus-embeddings neo4j-embeddings neo4j-rag +pgvector-embeddings +pgvector-rag pinecone-embeddings pinecone-rag protobuf-binary diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/transformers/pgvector-embeddings.json b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/transformers/pgvector-embeddings.json new file mode 100644 index 00000000000..49a9f455a58 --- /dev/null +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/transformers/pgvector-embeddings.json @@ -0,0 +1,14 @@ +{ + "transformer": { + "kind": "transformer", + "name": "pgvector:embeddings", + "title": "Pgvector (Embeddings)", + "description": "Prepares the message to become an object writable by PgVector component", + "deprecated": false, + "javaType": "org.apache.camel.component.pgvector.transform.PgVectorEmbeddingsDataTypeTransformer", + "groupId": "org.apache.camel.springboot", + "artifactId": "camel-pgvector-starter", + "version": "4.23.0-SNAPSHOT" + } +} + diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/transformers/pgvector-rag.json b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/transformers/pgvector-rag.json new file mode 100644 index 00000000000..5c3bb45f803 --- /dev/null +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/transformers/pgvector-rag.json @@ -0,0 +1,14 @@ +{ + "transformer": { + "kind": "transformer", + "name": "pgvector:rag", + "title": "Pgvector (Rag)", + "description": "Prepares the PgVector similarity search results to become a List of String for LangChain4j RAG", + "deprecated": false, + "javaType": "org.apache.camel.component.pgvector.transform.PgVectorReverseEmbeddingsDataTypeTransformer", + "groupId": "org.apache.camel.springboot", + "artifactId": "camel-pgvector-starter", + "version": "4.23.0-SNAPSHOT" + } +} + diff --git a/components-starter/camel-pgvector-starter/pom.xml b/components-starter/camel-pgvector-starter/pom.xml new file mode 100644 index 00000000000..6bbfe1f4ede --- /dev/null +++ b/components-starter/camel-pgvector-starter/pom.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>components-starter</artifactId> + <version>4.23.0-SNAPSHOT</version> + </parent> + <artifactId>camel-pgvector-starter</artifactId> + <packaging>jar</packaging> + <name>Camel SB Starters :: pgvector</name> + <dependencies> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter</artifactId> + <version>${spring-boot-version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-pgvector</artifactId> + <version>${camel-version}</version> + </dependency> + <!--START OF GENERATED CODE--> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-core-starter</artifactId> + </dependency> + <!--END OF GENERATED CODE--> + </dependencies> +</project> diff --git a/components-starter/camel-pgvector-starter/src/main/docs/pgvector.json b/components-starter/camel-pgvector-starter/src/main/docs/pgvector.json new file mode 100644 index 00000000000..f3d5875f15b --- /dev/null +++ b/components-starter/camel-pgvector-starter/src/main/docs/pgvector.json @@ -0,0 +1,66 @@ +{ + "groups": [ + { + "name": "camel.component.pgvector", + "type": "org.apache.camel.component.pgvector.springboot.PgVectorComponentConfiguration", + "sourceType": "org.apache.camel.component.pgvector.springboot.PgVectorComponentConfiguration" + }, + { + "name": "camel.component.pgvector.customizer", + "type": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties", + "sourceType": "org.apache.camel.component.pgvector.springboot.PgVectorComponentConfiguration", + "sourceMethod": "getCustomizer()" + } + ], + "properties": [ + { + "name": "camel.component.pgvector.autowired-enabled", + "type": "java.lang.Boolean", + "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.", + "sourceType": "org.apache.camel.component.pgvector.springboot.PgVectorComponentConfiguration", + "defaultValue": true + }, + { + "name": "camel.component.pgvector.configuration", + "type": "org.apache.camel.component.pgvector.PgVectorConfiguration", + "description": "The configuration;. The option is a org.apache.camel.component.pgvector.PgVectorConfiguration type.", + "sourceType": "org.apache.camel.component.pgvector.springboot.PgVectorComponentConfiguration" + }, + { + "name": "camel.component.pgvector.customizer.enabled", + "type": "java.lang.Boolean", + "sourceType": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties" + }, + { + "name": "camel.component.pgvector.dimension", + "type": "java.lang.Integer", + "description": "The dimension of the vectors to store.", + "sourceType": "org.apache.camel.component.pgvector.springboot.PgVectorComponentConfiguration", + "defaultValue": 384 + }, + { + "name": "camel.component.pgvector.distance-type", + "type": "org.apache.camel.component.pgvector.PgVectorDistanceType", + "description": "The distance type to use for similarity search.", + "sourceType": "org.apache.camel.component.pgvector.springboot.PgVectorComponentConfiguration", + "defaultValue": "cosine" + }, + { + "name": "camel.component.pgvector.enabled", + "type": "java.lang.Boolean", + "description": "Whether to enable auto configuration of the pgvector component. This is enabled by default.", + "sourceType": "org.apache.camel.component.pgvector.springboot.PgVectorComponentConfiguration" + }, + { + "name": "camel.component.pgvector.lazy-start-producer", + "type": "java.lang.Boolean", + "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the [...] + "sourceType": "org.apache.camel.component.pgvector.springboot.PgVectorComponentConfiguration", + "defaultValue": false + } + ], + "hints": [], + "ignored": { + "properties": [] + } +} \ No newline at end of file diff --git a/components-starter/camel-pgvector-starter/src/main/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentAutoConfiguration.java b/components-starter/camel-pgvector-starter/src/main/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentAutoConfiguration.java new file mode 100644 index 00000000000..d020a85d87b --- /dev/null +++ b/components-starter/camel-pgvector-starter/src/main/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentAutoConfiguration.java @@ -0,0 +1,74 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.pgvector.springboot; + +import org.apache.camel.CamelContext; +import org.apache.camel.Component; +import org.apache.camel.component.pgvector.PgVectorComponent; +import org.apache.camel.spi.ComponentCustomizer; +import org.apache.camel.spring.boot.CamelAutoConfiguration; +import org.apache.camel.spring.boot.ComponentConfigurationProperties; +import org.apache.camel.spring.boot.util.CamelPropertiesHelper; +import org.apache.camel.spring.boot.util.ConditionalOnCamelContextAndAutoConfigurationBeans; +import org.apache.camel.spring.boot.util.ConditionalOnHierarchicalProperties; +import org.apache.camel.spring.boot.util.HierarchicalPropertiesEvaluator; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Conditional; +import org.springframework.context.annotation.Lazy; + +/** + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@AutoConfiguration(after = {CamelAutoConfiguration.class, PgVectorComponentConverter.class}) +@Conditional(ConditionalOnCamelContextAndAutoConfigurationBeans.class) +@EnableConfigurationProperties({ComponentConfigurationProperties.class,PgVectorComponentConfiguration.class}) +@ConditionalOnHierarchicalProperties({"camel.component", "camel.component.pgvector"}) +public class PgVectorComponentAutoConfiguration { + + private final ApplicationContext applicationContext; + private final PgVectorComponentConfiguration configuration; + + public PgVectorComponentAutoConfiguration( + org.springframework.context.ApplicationContext applicationContext, + org.apache.camel.component.pgvector.springboot.PgVectorComponentConfiguration configuration) { + this.applicationContext = applicationContext; + this.configuration = configuration; + } + + @Lazy + @Bean + public ComponentCustomizer configurePgVectorComponent() { + return new ComponentCustomizer() { + @Override + public void configure(String name, Component target) { + CamelPropertiesHelper.copyConfigurationProperties(target.getCamelContext(), applicationContext, + "camel.component.pgvector", configuration, target); + } + @Override + public boolean isEnabled(String name, Component target) { + return HierarchicalPropertiesEvaluator.evaluate( + applicationContext, + "camel.component.customizer", + "camel.component.pgvector.customizer") + && target instanceof PgVectorComponent; + } + }; + } +} \ No newline at end of file diff --git a/components-starter/camel-pgvector-starter/src/main/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentConfiguration.java b/components-starter/camel-pgvector-starter/src/main/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentConfiguration.java new file mode 100644 index 00000000000..dfaa2107a1a --- /dev/null +++ b/components-starter/camel-pgvector-starter/src/main/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentConfiguration.java @@ -0,0 +1,127 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.pgvector.springboot; + +import javax.sql.DataSource; +import org.apache.camel.component.pgvector.PgVectorComponent; +import org.apache.camel.component.pgvector.PgVectorConfiguration; +import org.apache.camel.component.pgvector.PgVectorDistanceType; +import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon; +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * Perform operations on the PostgreSQL pgvector Vector Database. + * + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@ConfigurationProperties(prefix = "camel.component.pgvector") +public class PgVectorComponentConfiguration + extends + ComponentConfigurationPropertiesCommon { + + /** + * Whether to enable auto configuration of the pgvector component. This is + * enabled by default. + */ + private Boolean enabled; + /** + * The configuration;. The option is a + * org.apache.camel.component.pgvector.PgVectorConfiguration type. + */ + private PgVectorConfiguration configuration; + /** + * The DataSource to use for connecting to the PostgreSQL database with + * pgvector extension. The option is a javax.sql.DataSource type. + */ + private DataSource dataSource; + /** + * The dimension of the vectors to store. + */ + private Integer dimension = 384; + /** + * The distance type to use for similarity search. + */ + private PgVectorDistanceType distanceType = PgVectorDistanceType.COSINE; + /** + * Whether the producer should be started lazy (on the first message). By + * starting lazy you can use this to allow CamelContext and routes to + * startup in situations where a producer may otherwise fail during starting + * and cause the route to fail being started. By deferring this startup to + * be lazy then the startup failure can be handled during routing messages + * via Camel's routing error handlers. Beware that when the first message is + * processed then creating and starting the producer may take a little time + * and prolong the total processing time of the processing. + */ + private Boolean lazyStartProducer = false; + /** + * Whether autowiring is enabled. This is used for automatic autowiring + * options (the option must be marked as autowired) by looking up in the + * registry to find if there is a single instance of matching type, which + * then gets configured on the component. This can be used for automatic + * configuring JDBC data sources, JMS connection factories, AWS Clients, + * etc. + */ + private Boolean autowiredEnabled = true; + + public PgVectorConfiguration getConfiguration() { + return configuration; + } + + public void setConfiguration(PgVectorConfiguration configuration) { + this.configuration = configuration; + } + + public DataSource getDataSource() { + return dataSource; + } + + public void setDataSource(DataSource dataSource) { + this.dataSource = dataSource; + } + + public Integer getDimension() { + return dimension; + } + + public void setDimension(Integer dimension) { + this.dimension = dimension; + } + + public PgVectorDistanceType getDistanceType() { + return distanceType; + } + + public void setDistanceType(PgVectorDistanceType distanceType) { + this.distanceType = distanceType; + } + + public Boolean getLazyStartProducer() { + return lazyStartProducer; + } + + public void setLazyStartProducer(Boolean lazyStartProducer) { + this.lazyStartProducer = lazyStartProducer; + } + + public Boolean getAutowiredEnabled() { + return autowiredEnabled; + } + + public void setAutowiredEnabled(Boolean autowiredEnabled) { + this.autowiredEnabled = autowiredEnabled; + } +} \ No newline at end of file diff --git a/components-starter/camel-pgvector-starter/src/main/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentConverter.java b/components-starter/camel-pgvector-starter/src/main/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentConverter.java new file mode 100644 index 00000000000..ec0e7eda036 --- /dev/null +++ b/components-starter/camel-pgvector-starter/src/main/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentConverter.java @@ -0,0 +1,54 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.pgvector.springboot; + +import java.util.LinkedHashSet; +import java.util.Set; +import org.apache.camel.spring.boot.util.BeanReferenceHelper; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.ConfigurationPropertiesBinding; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.convert.TypeDescriptor; +import org.springframework.core.convert.converter.GenericConverter; +import org.springframework.stereotype.Component; + +/** + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@Configuration(proxyBeanMethods = false) +@ConfigurationPropertiesBinding +@Component +public class PgVectorComponentConverter implements GenericConverter { + + @Autowired + private ApplicationContext applicationContext; + + public Set<ConvertiblePair> getConvertibleTypes() { + Set<ConvertiblePair> answer = new LinkedHashSet<>(); + answer.add(new ConvertiblePair(String.class, org.apache.camel.component.pgvector.PgVectorConfiguration.class)); + answer.add(new ConvertiblePair(String.class, javax.sql.DataSource.class)); + return answer; + } + + public Object convert( + Object source, + TypeDescriptor sourceType, + TypeDescriptor targetType) { + return BeanReferenceHelper.resolveBeanReference(applicationContext, source, targetType, "camel.component.pgvector"); + } +} \ No newline at end of file diff --git a/components-starter/camel-pgvector-starter/src/main/resources/META-INF/LICENSE.txt b/components-starter/camel-pgvector-starter/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 00000000000..6b0b1270ff0 --- /dev/null +++ b/components-starter/camel-pgvector-starter/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/components-starter/camel-pgvector-starter/src/main/resources/META-INF/NOTICE.txt b/components-starter/camel-pgvector-starter/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 00000000000..2e215bf2e6b --- /dev/null +++ b/components-starter/camel-pgvector-starter/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. diff --git a/components-starter/camel-pgvector-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/components-starter/camel-pgvector-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports new file mode 100644 index 00000000000..44ba332d98d --- /dev/null +++ b/components-starter/camel-pgvector-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -0,0 +1,18 @@ +## --------------------------------------------------------------------------- +## Licensed to the Apache Software Foundation (ASF) under one or more +## contributor license agreements. See the NOTICE file distributed with +## this work for additional information regarding copyright ownership. +## The ASF licenses this file to You under the Apache License, Version 2.0 +## (the "License"); you may not use this file except in compliance with +## the License. You may obtain a copy of the License at +## +## http://www.apache.org/licenses/LICENSE-2.0 +## +## Unless required by applicable law or agreed to in writing, software +## distributed under the License is distributed on an "AS IS" BASIS, +## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +## See the License for the specific language governing permissions and +## limitations under the License. +## --------------------------------------------------------------------------- +org.apache.camel.component.pgvector.springboot.PgVectorComponentConverter +org.apache.camel.component.pgvector.springboot.PgVectorComponentAutoConfiguration diff --git a/components-starter/camel-pgvector-starter/src/test/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentAutoConfigurationTest.java b/components-starter/camel-pgvector-starter/src/test/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentAutoConfigurationTest.java new file mode 100644 index 00000000000..484ea5cbf35 --- /dev/null +++ b/components-starter/camel-pgvector-starter/src/test/java/org/apache/camel/component/pgvector/springboot/PgVectorComponentAutoConfigurationTest.java @@ -0,0 +1,55 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.pgvector.springboot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; + +import org.apache.camel.CamelContext; +import org.apache.camel.component.pgvector.PgVectorComponent; +import org.apache.camel.component.pgvector.PgVectorDistanceType; +import org.apache.camel.spring.boot.CamelAutoConfiguration; +import org.apache.camel.test.spring.junit6.CamelSpringBootTest; + +import org.junit.jupiter.api.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.DirtiesContext; + +@DirtiesContext +@CamelSpringBootTest +@SpringBootTest(classes = { CamelAutoConfiguration.class, PgVectorComponentAutoConfiguration.class }, + properties = { + "camel.component.pgvector.dimension = 1536", + "camel.component.pgvector.distance-type = EUCLIDEAN" }) +public class PgVectorComponentAutoConfigurationTest { + + @Autowired + CamelContext context; + + @Test + public void componentIsAutoConfigured() { + PgVectorComponent component = assertInstanceOf(PgVectorComponent.class, context.getComponent("pgvector")); + + // set through camel.component.pgvector.*, so this asserts the Spring Boot + // properties are copied onto the component's nested PgVectorConfiguration by + // the starter + assertEquals(1536, component.getConfiguration().getDimension()); + assertEquals(PgVectorDistanceType.EUCLIDEAN, component.getConfiguration().getDistanceType()); + } +} diff --git a/components-starter/pom.xml b/components-starter/pom.xml index 3d39d7cf0ea..6305e67bb88 100644 --- a/components-starter/pom.xml +++ b/components-starter/pom.xml @@ -413,6 +413,7 @@ <module>camel-pdf-starter</module> <module>camel-pg-replication-slot-starter</module> <module>camel-pgevent-starter</module> + <module>camel-pgvector-starter</module> <module>camel-pinecone-starter</module> <module>camel-platform-http-starter</module> <module>camel-plc4x-starter</module> diff --git a/docs/spring-boot/modules/ROOT/nav.adoc b/docs/spring-boot/modules/ROOT/nav.adoc index 46212af7f9d..c26db1ac94c 100644 --- a/docs/spring-boot/modules/ROOT/nav.adoc +++ b/docs/spring-boot/modules/ROOT/nav.adoc @@ -312,6 +312,7 @@ ** xref:starters/pdf.adoc[PDF] ** xref:starters/pg-replication-slot.adoc[PostgreSQL Replication Slot] ** xref:starters/pgevent.adoc[PostgreSQL Event] +** xref:starters/pgvector.adoc[PGVector] ** xref:starters/pinecone.adoc[Pinecone] ** xref:starters/platform-http.adoc[Platform HTTP] ** xref:starters/plc4x.adoc[PLC4X] diff --git a/docs/spring-boot/modules/ROOT/pages/starters/pgvector.adoc b/docs/spring-boot/modules/ROOT/pages/starters/pgvector.adoc new file mode 100644 index 00000000000..90b960740d3 --- /dev/null +++ b/docs/spring-boot/modules/ROOT/pages/starters/pgvector.adoc @@ -0,0 +1,37 @@ +// Do not edit directly! +// This file was generated by camel-spring-boot-generator-maven-plugin += PGVector +:artifactid: camel-pgvector-starter + +Perform operations on the PostgreSQL pgvector Vector Database. + +== What's inside + +* xref:{csb-camel-components}::pgvector-component.adoc[PGVector component], URI syntax: `pgvector:collection` + +Please refer to the above links for usage and configuration details. + +== Maven coordinates + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-pgvector-starter</artifactId> +</dependency> +---- + +== Spring Boot Auto-Configuration + +The starter supports 6 options, which are listed below. + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| camel.component.pgvector.autowired-enabled | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean +| camel.component.pgvector.configuration | The configuration;. The option is a org.apache.camel.component.pgvector.PgVectorConfiguration type. | | PgVectorConfiguration +| camel.component.pgvector.dimension | The dimension of the vectors to store. | 384 | Integer +| camel.component.pgvector.distance-type | The distance type to use for similarity search. | cosine | PgVectorDistanceType +| camel.component.pgvector.enabled | Whether to enable auto configuration of the pgvector component. This is enabled by default. | | Boolean +| camel.component.pgvector.lazy-start-producer | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed the [...] +|=== diff --git a/tooling/camel-spring-boot-dependencies/pom.xml b/tooling/camel-spring-boot-dependencies/pom.xml index fa6142e09e0..3fe3b30623e 100644 --- a/tooling/camel-spring-boot-dependencies/pom.xml +++ b/tooling/camel-spring-boot-dependencies/pom.xml @@ -1922,6 +1922,11 @@ <artifactId>camel-pgevent-starter</artifactId> <version>${project.version}</version> </dependency> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-pgvector-starter</artifactId> + <version>${project.version}</version> + </dependency> <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-pinecone-starter</artifactId>
