|
| 1 | +# apijson-surrealdb [](https://jitpack.io/#APIJSON/apijson-surrealdb) |
| 2 | +腾讯 [APIJSON](https://github.com/Tencent/APIJSON) 6.1.0+ 的 SurrealDB 数据库插件,可通过 Maven, Gradle 等远程依赖。<br /> |
| 3 | +An SurrealDB plugin for Tencent [APIJSON](https://github.com/Tencent/APIJSON) 6.1.0+ |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +## 添加依赖 |
| 10 | +## Add Dependency |
| 11 | + |
| 12 | +### Maven |
| 13 | +#### 1. 在 pom.xml 中添加 JitPack 仓库 |
| 14 | +#### 1. Add the JitPack repository to pom.xml |
| 15 | +```xml |
| 16 | + <repositories> |
| 17 | + <repository> |
| 18 | + <id>jitpack.io</id> |
| 19 | + <url>https://jitpack.io</url> |
| 20 | + </repository> |
| 21 | + </repositories> |
| 22 | +``` |
| 23 | + |
| 24 | + |
| 25 | + |
| 26 | +<br /> |
| 27 | + |
| 28 | +#### 2. 在 pom.xml 中添加 apijson-surrealdb 依赖 |
| 29 | +#### 2. Add the apijson-surrealdb dependency to pom.xml |
| 30 | +```xml |
| 31 | + <dependency> |
| 32 | + <groupId>com.github.APIJSON</groupId> |
| 33 | + <artifactId>apijson-surrealdb</artifactId> |
| 34 | + <version>LATEST</version> |
| 35 | + </dependency> |
| 36 | +``` |
| 37 | + |
| 38 | +<br /> |
| 39 | + |
| 40 | +https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot-MultiDataSource/pom.xml |
| 41 | + |
| 42 | +<br /> |
| 43 | +<br /> |
| 44 | + |
| 45 | +### Gradle |
| 46 | +#### 1. 在项目根目录 build.gradle 中最后添加 JitPack 仓库 |
| 47 | +#### 1. Add the JitPack repository in your root build.gradle at the end of repositories |
| 48 | +```gradle |
| 49 | + allprojects { |
| 50 | + repositories { |
| 51 | + maven { url 'https://jitpack.io' } |
| 52 | + } |
| 53 | + } |
| 54 | +``` |
| 55 | +<br /> |
| 56 | + |
| 57 | +#### 2. 在项目某个 module 目录(例如 `app`) build.gradle 中添加 apijson-surrealdb 依赖 |
| 58 | +#### 2. Add the apijson-surrealdb dependency in one of your modules(such as `app`) |
| 59 | +```gradle |
| 60 | + dependencies { |
| 61 | + implementation 'com.github.APIJSON:apijson-surrealdb:latest' |
| 62 | + } |
| 63 | +``` |
| 64 | + |
| 65 | +<br /> |
| 66 | +<br /> |
| 67 | +<br /> |
| 68 | + |
| 69 | +## 使用 |
| 70 | +## Usage |
| 71 | + |
| 72 | +在你项目继承 AbstractSQLExecutor 的子类重写方法 execute <br/> |
| 73 | +Override execute in your SQLExecutor extends AbstractSQLExecutor |
| 74 | + |
| 75 | +```java |
| 76 | + @Override |
| 77 | + public JSONObject execute(@NotNull SQLConfig<Long> config, boolean unknownType) throws Exception { |
| 78 | + if (config.isSurrealDB()) { |
| 79 | + return SurrealDBUtil.execute(config, null, unknownType); |
| 80 | + } |
| 81 | + |
| 82 | + return super.execute(config, unknownType); |
| 83 | + } |
| 84 | +``` |
| 85 | + |
| 86 | +<br/> |
| 87 | +在你项目继承 AbstractSQLConfig 的子类重写方法 execute <br/> |
| 88 | +Override execute in your SQLConfig extends AbstractSQLConfig |
| 89 | + |
| 90 | +```java |
| 91 | + @Override |
| 92 | + public String getNamespace() { |
| 93 | + return SurrealDBUtil.getNamespace(super.getNamespace(), DEFAULT_NAMESPACE, isSurrealDB()); |
| 94 | + } |
| 95 | + |
| 96 | + @Override |
| 97 | + public String getSQLNamespace() { |
| 98 | + return SurrealDBUtil.getSQLNamespace(super.getSQLNamespace(), isSurrealDB()); |
| 99 | + } |
| 100 | + |
| 101 | + @Override |
| 102 | + public String getSchema() { |
| 103 | + return SurrealDBUtil.getSchema(super.getSchema(), DEFAULT_SCHEMA, isSurrealDB()); |
| 104 | + } |
| 105 | + |
| 106 | + @Override |
| 107 | + public String getSQLSchema() { |
| 108 | + return SurrealDBUtil.getSQLSchema(super.getSQLSchema(), isSurrealDB()); |
| 109 | + } |
| 110 | +``` |
| 111 | + |
| 112 | +#### 见 [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 /> |
| 113 | + |
| 114 | +#### 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) |
| 115 | + |
| 116 | +<br /> |
| 117 | +<br /> |
| 118 | +<br /> |
| 119 | + |
| 120 | +有问题可以去 Tencent/APIJSON 提 issue <br /> |
| 121 | +https://github.com/Tencent/APIJSON/issues/36 |
| 122 | + |
| 123 | +<br /><br /> |
| 124 | + |
| 125 | +#### 点右上角 ⭐Star 支持一下,谢谢 ^_^ |
| 126 | +#### Please ⭐Star this project ^_^ |
| 127 | +https://github.com/APIJSON/apijson-surrealdb |
0 commit comments