[WIP]add opengauss support

README.md

@@ -138,6 +138,7 @@ AnythingLLM divides your documents into objects called `workspaces`. A Workspace
 - [Qdrant](https://qdrant.tech)
 - [Milvus](https://milvus.io)
 - [Zilliz](https://zilliz.com)
+- [openGauss](https://opengauss.org)
 
 ### Technical Overview
 

docker/.env.example

@@ -226,6 +226,14 @@ GID='1000'
 # ASTRA_DB_APPLICATION_TOKEN=
 # ASTRA_DB_ENDPOINT=
 
+# Enable all below if you are using vector database: openGauss
+# VECTOR_DB="openGauss"
+# OPENGAUSS_HOST="127.0.0.1"
+# OPENGAUSS_PORT=5432
+# OPENGAUSS_USERNAME=
+# OPENGAUSS_PASSWORD=
+# OPENGAUSS_DATABASE=
+
 ###########################################
 ######## Audio Model Selection ############
 ###########################################
@@ -325,4 +333,4 @@ GID='1000'
 # Specify the target languages for when using OCR to parse images and PDFs.
 # This is a comma separated list of language codes as a string. Unsupported languages will be ignored.
 # Default is English. See https://tesseract-ocr.github.io/tessdoc/Data-Files-in-different-versions.html for a list of valid language codes.
-# TARGET_OCR_LANG=eng,deu,ita,spa,fra,por,rus,nld,tur,hun,pol,ita,spa,fra,por,rus,nld,tur,hun,pol
+# TARGET_OCR_LANG=eng,deu,ita,spa,fra,por,rus,nld,tur,hun,pol,ita,spa,fra,por,rus,nld,tur,hun,pol

frontend/src/components/VectorDBSelection/OpenGaussDBOptions/index.jsx

@@ -0,0 +1,80 @@
+export default function OpenGaussDBOptions({ settings }) {
+  return (
+    <div className="w-full flex flex-col gap-y-7">
+      <div className="w-full flex items-center gap-[36px] mt-1.5">
+        <div className="flex flex-col w-60">
+          <label className="text-white text-sm font-semibold block mb-3">
+            OpenGauss Host
+          </label>
+          <input
+            type="text"
+            name="OpenGaussHost"
+            className="border-none bg-theme-settings-input-bg text-white placeholder:text-theme-settings-input-placeholder text-sm rounded-lg focus:outline-primary-button active:outline-primary-button outline-none block w-full p-2.5"
+            placeholder="127.0.0.1"
+            defaultValue={settings?.OpenGaussHost}
+            required={true}
+            autoComplete="off"
+            spellCheck={false}
+          />
+        </div>
+
+        <div className="flex flex-col w-60">
+          <label className="text-white text-sm font-semibold block mb-3">
+            OpenGauss Port
+          </label>
+          <input
+            type="text"
+            name="OpenGaussPort"
+            className="border-none bg-theme-settings-input-bg text-white placeholder:text-theme-settings-input-placeholder text-sm rounded-lg focus:outline-primary-button active:outline-primary-button outline-none block w-full p-2.5"
+            placeholder="5432"
+            defaultValue={settings?.OpenGaussPort}
+            autoComplete="off"
+            spellCheck={false}
+          />
+        </div>
+        <div className="flex flex-col w-60">
+          <label className="text-white text-sm font-semibold block mb-3">
+            OpenGauss Username
+          </label>
+          <input
+            type="text"
+            name="OpenGaussUsername"
+            className="border-none bg-theme-settings-input-bg text-white placeholder:text-theme-settings-input-placeholder text-sm rounded-lg focus:outline-primary-button active:outline-primary-button outline-none block w-full p-2.5"
+            placeholder="username"
+            defaultValue={settings?.OpenGaussUsername}
+            autoComplete="off"
+            spellCheck={false}
+          />
+        </div>
+        <div className="flex flex-col w-60">
+          <label className="text-white text-sm font-semibold block mb-3">
+            OpenGauss Password
+          </label>
+          <input
+            type="password"
+            name="OpenGaussPassword"
+            className="border-none bg-theme-settings-input-bg text-white placeholder:text-theme-settings-input-placeholder text-sm rounded-lg focus:outline-primary-button active:outline-primary-button outline-none block w-full p-2.5"
+            placeholder="password"
+            defaultValue={settings?.OpenGaussPassword ? "*".repeat(20) : ""}
+            autoComplete="off"
+            spellCheck={false}
+          />
+        </div>
+        <div className="flex flex-col w-60">
+          <label className="text-white text-sm font-semibold block mb-3">
+            OpenGauss Database
+          </label>
+          <input
+            type="text"
+            name="OpenGaussDatabase"
+            className="border-none bg-theme-settings-input-bg text-white placeholder:text-theme-settings-input-placeholder text-sm rounded-lg focus:outline-primary-button active:outline-primary-button outline-none block w-full p-2.5"
+            placeholder="postgres"
+            defaultValue={settings?.OpenGaussDatabase}
+            autoComplete="off"
+            spellCheck={false}
+          />
+        </div>
+      </div>
+    </div>
+  );
+}

frontend/src/pages/GeneralSettings/VectorDatabase/index.jsx

@@ -11,6 +11,7 @@ import QDrantLogo from "@/media/vectordbs/qdrant.png";
 import MilvusLogo from "@/media/vectordbs/milvus.png";
 import ZillizLogo from "@/media/vectordbs/zilliz.png";
 import AstraDBLogo from "@/media/vectordbs/astraDB.png";
+import OpenGaussLogo from "@/media/vectordbs/opengauss.png";
 import PreLoader from "@/components/Preloader";
 import ChangeWarningModal from "@/components/ChangeWarning";
 import { CaretUpDown, MagnifyingGlass, X } from "@phosphor-icons/react";
@@ -22,6 +23,7 @@ import WeaviateDBOptions from "@/components/VectorDBSelection/WeaviateDBOptions"
 import VectorDBItem from "@/components/VectorDBSelection/VectorDBItem";
 import MilvusDBOptions from "@/components/VectorDBSelection/MilvusDBOptions";
 import ZillizCloudOptions from "@/components/VectorDBSelection/ZillizCloudOptions";
+import OpenGaussDBOptions from "@/components/VectorDBSelection/OpenGaussDBOptions";
 import { useModal } from "@/hooks/useModal";
 import ModalWrapper from "@/components/ModalWrapper";
 import AstraDBOptions from "@/components/VectorDBSelection/AstraDBOptions";
@@ -166,6 +168,13 @@ export default function GeneralVectorDatabase() {
       options: <AstraDBOptions settings={settings} />,
       description: "Vector Search for Real-world GenAI.",
     },
+    {
+      name: "openGauss",
+      value: "openGauss",
+      logo: OpenGaussLogo,
+      options: <OpenGaussDBOptions settings={settings} />,
+      description: "Open source vector database.",
+    },
   ];
 
   const selectedVDBObject = VECTOR_DBS.find((vdb) => vdb.value === selectedVDB);

frontend/src/pages/OnboardingFlow/Steps/DataHandling/index.jsx

@@ -36,6 +36,7 @@ import QDrantLogo from "@/media/vectordbs/qdrant.png";
 import MilvusLogo from "@/media/vectordbs/milvus.png";
 import VoyageAiLogo from "@/media/embeddingprovider/voyageai.png";
 import PPIOLogo from "@/media/llmprovider/ppio.png";
+import OpenGaussLogo from "@/media/vectordbs/openGauss.png";
 
 import React, { useState, useEffect } from "react";
 import paths from "@/utils/paths";
@@ -295,6 +296,13 @@ export const VECTOR_DB_PRIVACY = {
     ],
     logo: LanceDbLogo,
   },
+  openGauss: {
+    name: "openGauss",
+    description: [
+      "Your vectors and document text are stored on this openGauss instance (cloud or self-hosted)",
+    ],
+    logo: OpenGaussLogo,
+  },
 };
 
 export const EMBEDDING_ENGINE_PRIVACY = {

server/.env.example

@@ -216,6 +216,14 @@ VECTOR_DB="lancedb"
 # ZILLIZ_ENDPOINT="https://sample.api.gcp-us-west1.zillizcloud.com"
 # ZILLIZ_API_TOKEN=api-token-here
 
+# Enable all below if you are using vector database: openGauss.
+# VECTOR_DB="openGauss"
+# OPENGAUSS_HOST="127.0.0.1"
+# OPENGAUSS_PORT=5432
+# OPENGAUSS_USERNAME=
+# OPENGAUSS_PASSWORD=
+# OPENGAUSS_DATABASE="postgres"
+
 ###########################################
 ######## Audio Model Selection ############
 ###########################################
@@ -314,4 +322,4 @@ TTS_PROVIDER="native"
 # Specify the target languages for when using OCR to parse images and PDFs.
 # This is a comma separated list of language codes as a string. Unsupported languages will be ignored.
 # Default is English. See https://tesseract-ocr.github.io/tessdoc/Data-Files-in-different-versions.html for a list of valid language codes.
-# TARGET_OCR_LANG=eng,deu,ita,spa,fra,por,rus,nld,tur,hun,pol,ita,spa,fra,por,rus,nld,tur,hun,pol
+# TARGET_OCR_LANG=eng,deu,ita,spa,fra,por,rus,nld,tur,hun,pol,ita,spa,fra,por,rus,nld,tur,hun,pol

server/models/systemSettings.js

@@ -427,6 +427,13 @@ const SystemSettings = {
       // AstraDB Keys
       AstraDBApplicationToken: process?.env?.ASTRA_DB_APPLICATION_TOKEN,
       AstraDBEndpoint: process?.env?.ASTRA_DB_ENDPOINT,
+
+      // openGauss DB Keys
+      OpenGaussHost: process.env.OPENGAUSS_HOST,
+      OpenGaussPort: process.env.OPENGAUSS_PORT,
+      OpenGaussUsername: process.env.OPENGAUSS_USERNAME,
+      OpenGaussPassword: process.env.OPENGAUSS_PASSWORD,
+      OpenGaussDatabase: process.env.OPENGAUSS_DATABASE,
     };
   },
 

server/package.json

@@ -66,6 +66,7 @@
     "ollama": "^0.5.10",
     "openai": "4.38.5",
     "pg": "^8.11.5",
+    "pg-opengauss": "^1.4.0",
     "pinecone-client": "^1.1.0",
     "pluralize": "^8.0.0",
     "posthog-node": "^3.1.1",
@@ -82,6 +83,7 @@
   },
   "devDependencies": {
     "@inquirer/prompts": "^4.3.1",
+    "cross-env": "^7.0.3",
     "eslint": "^8.50.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-ft-flow": "^3.0.0",
@@ -95,7 +97,6 @@
     "hermes-eslint": "^0.15.0",
     "node-html-markdown": "^1.3.0",
     "nodemon": "^2.0.22",
-    "prettier": "^3.0.3",
-    "cross-env": "^7.0.3"
+    "prettier": "^3.0.3"
   }
 }

server/utils/helpers/index.js

@@ -77,7 +77,7 @@
 
 /**
  * Gets the systems current vector database provider.
- * @param {('pinecone' | 'chroma' | 'lancedb' | 'weaviate' | 'qdrant' | 'milvus' | 'zilliz' | 'astra') | null} getExactly - If provided, this will return an explit provider.
+ * @param {('pinecone' | 'chroma' | 'lancedb' | 'weaviate' | 'qdrant' | 'milvus' | 'zilliz' | 'astra' | 'opengauss') | null} getExactly - If provided, this will return an explit provider.
  * @returns { BaseVectorDatabaseProvider}
  */
 function getVectorDbClass(getExactly = null) {
@@ -107,6 +107,9 @@ function getVectorDbClass(getExactly = null) {
     case "astra":
       const { AstraDB } = require("../vectorDbProviders/astra");
       return AstraDB;
+    case "openGauss":
+      const { OpenGauss } = require("../vectorDbProviders/openGauss");
+      return OpenGauss;
     default:
       throw new Error("ENV: No VECTOR_DB value found in environment!");
   }

server/utils/helpers/updateENV.js

@@ -369,6 +369,28 @@ const KEY_MAPPING = {
     checks: [isNotEmpty],
   },
 
+  // openGauss Options
+  OpenGaussHost: {
+    envKey: "OPENGAUSS_HOST",
+    checks: [isNotEmpty],
+  },
+  OpenGaussPort: {
+    envKey: "OPENGAUSS_PORT",
+    checks: [isNotEmpty],
+  },
+  OpenGaussUsername: {
+    envKey: "OPENGAUSS_USERNAME",
+    checks: [isNotEmpty],
+  },
+  OpenGaussPassword: {
+    envKey: "OPENGAUSS_PASSWORD",
+    checks: [isNotEmpty],
+  },
+  OpenGaussDatabase: {
+    envKey: "OPENGAUSS_DATABASE",
+    checks: [isNotEmpty],
+  },
+
   // Together Ai Options
   TogetherAiApiKey: {
     envKey: "TOGETHER_AI_API_KEY",
@@ -806,6 +828,7 @@ function supportedVectorDB(input = "") {
     "milvus",
     "zilliz",
     "astra",
+    "openGauss",
   ];
   return supported.includes(input)
     ? null

server/utils/vectorDbProviders/openGauss/OPENGAUSS_SETUP.md

@@ -0,0 +1,25 @@
+# How to setup OpenGauss Vector Database for AnythingLLM
+
+[Official OpenGauss Docs](https://docs.opengauss.org/zh/) for reference.
+
+### How to get started
+
+**Requirements**
+
+- Docker
+  - `git` available in your CLI/terminal
+
+**Instructions**
+
+- (https://docs.opengauss.org/zh/docs/latest/docs/InstallationGuide/%E5%AE%B9%E5%99%A8%E9%95%9C%E5%83%8F%E5%AE%89%E8%A3%85.html) for reference.
+
+eg: `server/.env.development`
+
+```
+VECTOR_DB="openGauss"
+OPENGAUSS_HOST="127.0.0.1"
+OPENGAUSS_PORT=5432
+OPENGAUSS_USERNAME=
+OPENGAUSS_PASSWORD=
+OPENGAUSS_DATABASE="postgres"
+```