# apijson-surrealdb

**Repository Path**: APIJSON/apijson-surrealdb

## Basic Information

- **Project Name**: apijson-surrealdb
- **Description**: 腾讯 APIJSON 的 SurrealDB 关系、时序、图、键值、搜索、文档 等多模型数据库插件
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: https://github.com/APIJSON/apijson-surrealdb
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-01-30
- **Last Updated**: 2025-04-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: surreal, surrealdb, surrealql, 图数据库, graph

## README

# apijson-surrealdb  [![](https://jitpack.io/v/APIJSON/apijson-surrealdb.svg)](https://jitpack.io/#APIJSON/apijson-surrealdb)
腾讯 [APIJSON](https://github.com/Tencent/APIJSON) 7.4.0+ 的 SurrealDB 数据库插件，可通过 Maven, Gradle 等远程依赖。<br />
An SurrealDB plugin for Tencent [APIJSON](https://github.com/Tencent/APIJSON) 7.4.0+

![image](https://github.com/user-attachments/assets/a354661a-d5a7-4902-ab06-fada169a292c)
![image](https://github.com/user-attachments/assets/8ef690e6-8367-4882-9f73-ec610a116e13)
![image](https://github.com/user-attachments/assets/8c22a748-35d2-49d8-872e-b5269f558c24)
![image](https://github.com/user-attachments/assets/5f897dd4-0be8-4c5c-b874-4b789a7cf96f)


## 添加依赖
## Add Dependency

### Maven
#### 1. 在 pom.xml 中添加 JitPack 仓库
#### 1. Add the JitPack repository to pom.xml
```xml
	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>
```

![image](https://user-images.githubusercontent.com/5738175/167261814-d75d8fff-0e64-4534-a840-60ef628a8873.png)

<br />

#### 2. 在 pom.xml 中添加 apijson-surrealdb 依赖
#### 2. Add the apijson-surrealdb dependency to pom.xml
```xml
	<dependency>
	    <groupId>com.github.APIJSON</groupId>
	    <artifactId>apijson-surrealdb</artifactId>
	    <version>LATEST</version>
	</dependency>
```

<br />

https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot-MultiDataSource/pom.xml

<br />
<br />

### Gradle
#### 1. 在项目根目录 build.gradle 中最后添加 JitPack 仓库
#### 1. Add the JitPack repository in your root build.gradle at the end of repositories
```gradle
	allprojects {
		repositories {
			maven { url 'https://jitpack.io' }
		}
	}
```
<br />

#### 2. 在项目某个 module 目录(例如 `app`) build.gradle 中添加 apijson-surrealdb 依赖
#### 2. Add the apijson-surrealdb dependency in one of your modules(such as `app`)
```gradle
	dependencies {
	        implementation 'com.github.APIJSON:apijson-surrealdb:latest'
	}
```

<br />
<br />
<br />

## 使用
## Usage

在你项目继承 AbstractSQLExecutor 的子类重写方法 execute <br/>
Override execute in your SQLExecutor extends AbstractSQLExecutor

```java
        @Override
        public JSONObject execute(@NotNull SQLConfig<Long> config, boolean unknownType) throws Exception {
            if (config.isSurrealDB()) {
                return SurrealDBUtil.execute(config, null, unknownType);
            }
   
            return super.execute(config, unknownType);
        }
```

<br/>
在你项目继承 AbstractSQLConfig 的子类重写方法 execute <br/>
Override execute in your SQLConfig extends AbstractSQLConfig

```java
	@Override
	public String getNamespace() {
		return SurrealDBUtil.getNamespace(super.getNamespace(), DEFAULT_NAMESPACE, isSurrealDB());
	}

	@Override
	public String getSQLNamespace() {
		return SurrealDBUtil.getSQLNamespace(super.getSQLNamespace(), isSurrealDB());
	}
        
	@Override
	public String getSchema() {
		return SurrealDBUtil.getSchema(super.getSchema(), DEFAULT_SCHEMA, isSurrealDB());
	}

	@Override
	public String getSQLSchema() {
		return SurrealDBUtil.getSQLSchema(super.getSQLSchema(), isSurrealDB());
	}
```

#### 见 [SurrealDBUtil](/src/main/java/apijson/surrealdb/SurrealDBUtil.java) 的注释及 [APIJSONBoot-MultiDataSource](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot-MultiDataSource) 的 [DemoSQLExecutor](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot-MultiDataSource/src/main/java/apijson/demo/DemoSQLExecutor.java) <br />

#### See document in [SurrealDBUtil](/src/main/java/apijson/surrealdb/SurrealDBUtil.java) and [DemoSQLExecutor](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot-MultiDataSource/src/main/java/apijson/demo/DemoSQLExecutor.java) in [APIJSONBoot-MultiDataSource](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot-MultiDataSource)

<br />
<br />
<br />

有问题可以去 Tencent/APIJSON 提 issue <br />
https://github.com/Tencent/APIJSON/issues/36

<br /><br />

#### 点右上角 ⭐Star 支持一下，谢谢 ^_^
#### Please ⭐Star this project ^_^
https://github.com/APIJSON/apijson-surrealdb