v0.0.1+1

CorvusYe · CorvusYe · commit fb44cc5e0473 · 2023-05-13T11:20:33.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,14 @@
+## 0.0.1+1
+- 支持在创建连接时指定Space（可选）
+- 适配dart_gdbc v0.0.1+3
+  - 修改了Statement的接口
+  - PreparedStatement支持gql参数渲染
+- 完善PreparedStatement的带参实现
+- 拓展方法
+  - string.bytes 获取 Int8List
+  - string.utf8code 获取Utf8编码的Int8List
+  - int8List.utf8string 获取Utf8编码的String
+
 ## 0.0.1
 
 - 提供nebulagraph的驱动
diff --git a/bin/nebula_dart_gdbc.dart b/bin/nebula_dart_gdbc.dart
@@ -1,3 +1,21 @@
-// import 'package:nebula_dart_gdbc/nebula_dart_gdbc.dart' as nebula_dart_gdbc;
+import 'package:nebula_dart_gdbc/nebula_dart_gdbc.dart';
 
-void main(List<String> arguments) {}
+void main() async {
+  // 注册驱动
+  DriverManager.registerDriver(NgDriver());
+  // 获取连接
+  var conn = await DriverManager.getConnection(
+    'gdbc.nebula://127.0.0.1:9669/?space=test',
+    username: 'root', // username is optional
+    password: 'nebula', // password is optional
+  );
+
+  // 创建语句
+  var stmt = await conn.createStatement();
+  // 执行语句
+  var rs = await stmt.executeQuery(gql: 'SHOW SPACES;');
+  // 打印结果
+  print(rs);
+  // 关闭连接
+  conn.close();
+}
diff --git a/example/lib/example.dart b/example/lib/example.dart
@@ -3,15 +3,21 @@
 import 'package:nebula_dart_gdbc/nebula_dart_gdbc.dart';
 
 void main(List<String> args) async {
+  // 注册驱动
   DriverManager.registerDriver(NgDriver());
-
+  // 获取连接
   var conn = await DriverManager.getConnection(
-    'gdbc.nebula://127.0.0.1:9669/?username=root&password=nebula&space=test&timeout=1000',
+    'gdbc.nebula://127.0.0.1:9669/?space=test',
+    username: 'root', // username is optional
+    password: 'nebula', // password is optional
   );
 
+  // 创建语句
   var stmt = await conn.createStatement();
-  var rs = await stmt.executeQuery('SHOW SPACES;');
-
+  // 执行语句
+  var rs = await stmt.executeQuery(gql: 'SHOW SPACES;');
+  // 打印结果
   print(rs);
-  await conn.close();
+  // 关闭连接
+  conn.close();
 }
diff --git a/lib/gen/nebula_graph/src/graph_service.dart b/lib/gen/nebula_graph/src/graph_service.dart
@@ -55,7 +55,6 @@ class GraphServiceClient implements GraphService {
 
   Future<AuthResponse> authenticate(
       Int8List username, Int8List password) async {
-    print('authenticate');
     oprot.writeMessageBegin(
         new TMessage("authenticate", TMessageType.CALL, nextSeqid()));
     authenticate_args args = new authenticate_args();
@@ -96,7 +95,6 @@ class GraphServiceClient implements GraphService {
   }
 
   Future<ExecutionResponse> execute(int sessionId, Int8List stmt) async {
-    print('execute');
     oprot.writeMessageBegin(
         new TMessage("execute", TMessageType.CALL, nextSeqid()));
     execute_args args = new execute_args();
@@ -219,7 +217,6 @@ class GraphServiceClient implements GraphService {
 
   Future<VerifyClientVersionResp> verifyClientVersion(
       VerifyClientVersionReq? req) async {
-    print('verifyClientVersion');
     oprot.writeMessageBegin(
         new TMessage("verifyClientVersion", TMessageType.CALL, nextSeqid()));
     verifyClientVersion_args args = new verifyClientVersion_args();
diff --git a/lib/nebula_dart_gdbc.dart b/lib/nebula_dart_gdbc.dart
@@ -15,3 +15,6 @@ part 'src/ng_prepared_statement.dart';
 part 'src/ng_result_set.dart';
 part 'src/ng_result_set_meta_data.dart';
 part 'src/ng_result_handler.dart';
+
+part 'src/ext/string_ext.dart';
+part 'src/ext/int8list_ext.dart';
diff --git a/lib/src/ext/int8list_ext.dart b/lib/src/ext/int8list_ext.dart
@@ -0,0 +1,7 @@
+part of nebula_dart_gdbc;
+
+extension Int8ListToString on Int8List {
+  String utf8String() {
+    return utf8.decode(Uint8List.fromList(this));
+  }
+}
diff --git a/lib/src/ext/string_ext.dart b/lib/src/ext/string_ext.dart
@@ -0,0 +1,6 @@
+part of nebula_dart_gdbc;
+
+extension StringExt on String {
+  Int8List get bytes => Int8List.fromList(codeUnits);
+  Int8List get utf8code => Int8List.fromList(utf8.encode(this));
+}
diff --git a/lib/src/ng_connection.dart b/lib/src/ng_connection.dart
@@ -24,6 +24,7 @@ part of nebula_dart_gdbc;
 /// ```
 class NgConnection implements Connection {
   static const String timeoutKey = 'timeout';
+  static const String spaceKey = 'space';
 
   late ng.TSocketTransport socketTransport;
   late ng.TFramedTransport transport;
@@ -33,6 +34,7 @@ class NgConnection implements Connection {
   int? _sessionId;
   int? timezoneOffset;
   int timeout = 0;
+  String? space;
 
   /// Invoked in [DriverManager.getConnection],
   /// you should not call this method directly.
@@ -67,6 +69,11 @@ class NgConnection implements Connection {
     /// check the version of client and server
     await verifyVersion();
     await authencate();
+
+    if (properties.containsKey(spaceKey)) {
+      space = properties[spaceKey];
+      await executeQuery('USE $space');
+    }
   }
 
   /// check the version of client and server
@@ -119,13 +126,27 @@ class NgConnection implements Connection {
   }
 
   @override
-  Future<ResultSet> executeQuery(String gql) async {
-    return await NgStatement(this).executeQuery(gql);
+  Future<ResultSet> executeQuery(String gql,
+      {Map<String, dynamic>? params}) async {
+    var sessionId = _sessionId ?? 0;
+    var stmtBytes = Int8List.fromList(utf8.encode(gql));
+    ng.ExecutionResponse resp = params == null
+        ? await client.execute(sessionId, stmtBytes)
+        : await client.executeWithParameter(
+            sessionId,
+            stmtBytes,
+            _convertParams(params),
+          );
+    if (resp.error_code == ng.ErrorCode.SUCCEEDED) {
+      return handleResult(resp, timezoneOffset);
+    } else {
+      throw GdbcQueryException(message: resp.error_msg?.utf8String());
+    }
   }
 
   @override
   Future<int> executeUpdate(String gql) async {
-    return await NgStatement(this).executeUpdate(gql);
+    return await NgStatement(this).executeUpdate(gql: gql);
   }
 
   @override
@@ -145,14 +166,17 @@ class NgConnection implements Connection {
   }
 
   @override
-  Future<PreparedStatement> prepareStatement(String gql) async {
-    return NgPreparedStatement(this);
+  Future<PreparedStatement> prepareStatement(
+    String gql, {
+    String Function(String, Map<String, dynamic>?)? render,
+  }) async {
+    return NgPreparedStatement(this, gql: gql, render: render);
   }
 
   @override
   Future<PreparedStatement> prepareStatementWithParameters(
       String gql, List<ParameterMetaData> parameters) async {
-    return NgPreparedStatement(this, parameters: parameters);
+    return NgPreparedStatement(this, parameters: parameters, gql: gql);
   }
 
   @override
@@ -164,4 +188,49 @@ class NgConnection implements Connection {
   Future<void> setAutoCommit(bool autoCommit) {
     throw DbFeatureException('No support for setAutoCommit');
   }
+
+  Map<Int8List, ng.Value> _convertParams(Map<String, dynamic>? params) {
+    if (params == null) return <Int8List, ng.Value>{};
+    return params.map((key, value) {
+      return MapEntry(key.bytes, _convertParam(value));
+    });
+  }
+
+  ng.Value _convertParam(value) {
+    if (value == null) {
+      return ng.Value()..nVal = 0;
+    } else if (value is int) {
+      return ng.Value()..iVal = value;
+    } else if (value is double) {
+      return ng.Value()..fVal = value;
+    } else if (value is bool) {
+      return ng.Value()..bVal = value;
+    } else if (value is String) {
+      return ng.Value()..sVal = value.utf8code;
+    } else if (value is List) {
+      return ng.Value()
+        ..lVal = (ng.NList()..values = value.map(_convertParam).toList());
+    } else if (value is Set) {
+      return ng.Value()
+        ..uVal = (ng.NSet()..values = value.map(_convertParam).toSet());
+    } else if (value is Map<String, dynamic>) {
+      return ng.Value()..mVal = (ng.NMap()..kvs = _convertParams(value));
+    } else {
+      if (value.toJson is! Map<String, dynamic> Function()) {
+        throw GdbcQueryException(
+          message:
+              '''Unsupported type: ${value.runtimeType}, you can define a toJson method for it. such as:
+              Map<String, dynamic> toJson() {
+                return {
+                  'name': name,
+                  'age': age,
+                };
+              }
+              ''',
+        );
+      }
+      Map<String, dynamic> jsonValue = value.toJson();
+      return _convertParam(jsonValue);
+    }
+  }
 }
diff --git a/lib/src/ng_prepared_statement.dart b/lib/src/ng_prepared_statement.dart
@@ -6,22 +6,29 @@ part of nebula_dart_gdbc;
 
 class NgPreparedStatement extends NgStatement implements PreparedStatement {
   List<ParameterMetaData>? parameters;
-  NgPreparedStatement(super.conn, {this.parameters});
+  String gql;
+  String Function(String, Map<String, dynamic>?)? render;
+
+  NgPreparedStatement(super.conn,
+      {this.parameters, required this.gql, this.render});
 
   @override
-  Future<bool> execute([String? gql, Map<String, dynamic>? params]) async {
-    var rs = await executeQuery(gql, params);
+  Future<bool> execute({String? gql, Map<String, dynamic>? params}) async {
+    var rs = await executeQuery(gql: gql, params: params);
     return rs.success;
   }
 
   @override
   Future<ResultSet> executeQuery(
-      [String? gql, Map<String, dynamic>? params]) async {
-    return super.executeQuery(gql);
+      {String? gql, Map<String, dynamic>? params}) async {
+    if (params != null && render != null) {
+      gql = render?.call(gql ?? this.gql, params);
+    }
+    return super.executeQuery(gql: gql ?? this.gql, params: params);
   }
 
   @override
-  Future<int> executeUpdate(String? gql, [Map<String, dynamic>? params]) async {
-    return super.executeUpdate(gql);
+  Future<int> executeUpdate({String? gql, Map<String, dynamic>? params}) async {
+    return super.executeUpdate(gql: gql, params: params);
   }
 }
diff --git a/lib/src/ng_result_handler.dart b/lib/src/ng_result_handler.dart
@@ -4,12 +4,6 @@
 
 part of nebula_dart_gdbc;
 
-extension Int8ListToString on Int8List {
-  String utf8String() {
-    return utf8.decode(Uint8List.fromList(this));
-  }
-}
-
 NgResultSet handleResult(ng.ExecutionResponse rs, int? timezoneOffset) {
   ValueMetaData? meta = ValueMetaData();
   var rows = _handleValue(rs.data, meta, timezoneOffset);
diff --git a/lib/src/ng_statement.dart b/lib/src/ng_statement.dart
@@ -12,25 +12,22 @@ class NgStatement implements Statement {
   NgStatement(this._conn);
 
   @override
-  Future<bool> execute([String? gql]) async {
-    var rs = await executeQuery(gql);
+  Future<bool> execute({Map<String, dynamic>? params, String? gql}) async {
+    var rs = await executeQuery(gql: gql);
     return rs.success;
   }
 
   @override
-  Future<ResultSet> executeQuery([String? gql]) async {
-    ng.ExecutionResponse resp = await _conn.client.execute(
-        _conn._sessionId ?? 0, Int8List.fromList(utf8.encode(gql ?? '')));
-    if (resp.error_code == ng.ErrorCode.SUCCEEDED) {
-      return handleResult(resp, _conn.timezoneOffset);
-    } else {
-      print(utf8.decode(resp.error_msg ?? []));
-      throw GdbcQueryException(message: utf8.decode(resp.error_msg ?? []));
+  Future<ResultSet> executeQuery(
+      {Map<String, dynamic>? params, String? gql}) async {
+    if (gql == null) {
+      throw GdbcQueryException(message: 'gql is null');
     }
+    return await _conn.executeQuery(gql, params: params);
   }
 
   @override
-  Future<int> executeUpdate(String? gql) {
+  Future<int> executeUpdate({Map<String, dynamic>? params, String? gql}) {
     // TODO: implement executeUpdate
     throw UnimplementedError();
   }
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,14 +1,16 @@
 name: nebula_dart_gdbc
 description: A database driver for nebula graph based on dart_gdbc, help you to access nebula graph in dart language
-version: 0.0.1
+version: 0.0.1+1
 repository: https://github.com/graph-cn/nebula_dart_gdbc
 
 environment:
   sdk: '>=2.19.0 <3.0.0'
 
 dependencies:
   fbthrift: ^1.0.0+1
-  dart_gdbc: ^0.0.1+2
+  dart_gdbc: ^0.0.1+3
+  # dart_gdbc: 
+  #   path: ../dart_gdbc
 
 dev_dependencies:
   lints: ^2.0.0
diff --git a/test/nebula_dart_gdbc_test.dart b/test/nebula_dart_gdbc_test.dart
@@ -1,3 +1,7 @@
+// Copyright (c) 2023- All nebula_dart_gdbc authors. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
+
 import 'dart:math';
 
 import 'package:nebula_dart_gdbc/nebula_dart_gdbc.dart';
@@ -25,20 +29,19 @@ void main() async {
   var spaceNamePrefix = 'my_space_';
 
   test('test create space', () async {
-    await stmt.executeQuery('use test;');
     await stmt.executeQuery(
-      '''
+      gql: '''
       CREATE SPACE IF NOT EXISTS $spaceNamePrefix$spaceKey (vid_type=FIXED_STRING(30));
       ''',
     );
 
     await Future.delayed(Duration(seconds: 10), () async {
-      await stmt.executeQuery('use $spaceNamePrefix$spaceKey;');
+      await stmt.executeQuery(gql: 'use $spaceNamePrefix$spaceKey;');
     });
   });
 
   test('Test List', () async {
-    var rs = await stmt.executeQuery('RETURN [1, 2, 3] as arr;');
+    var rs = await stmt.executeQuery(gql: 'RETURN [1, 2, 3] as arr;');
     expect(rs.value([0]), [1, 2, 3]);
     var firstMeta = rs.meta([0]);
     expect(firstMeta?.type, GdbTypes.list);
@@ -47,7 +50,7 @@ void main() async {
 
   tearDownAll(() async {
     await stmt.executeQuery(
-      '''
+      gql: '''
       DROP SPACE $spaceNamePrefix$spaceKey;
       ''',
     );
diff --git a/test/ng_prepared_statement_test.dart b/test/ng_prepared_statement_test.dart
diff --git a/test/ng_result_handler_test.dart b/test/ng_result_handler_test.dart
