v0.0.1+1

Author: CorvusYe

CHANGELOG.md

@@ -1,4 +1,4 @@
-## 0.0.1
+## 0.0.1+1
 
 - Provided driver manager which can be used to register drivers and get a driver by its legal url
 

example/.gitignore

@@ -0,0 +1,3 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/

example/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial version.

example/README.md

@@ -0,0 +1,2 @@
+A sample command-line application with an entrypoint in `bin/`, library code
+in `lib/`, and example unit test in `test/`.

example/analysis_options.yaml

@@ -0,0 +1,30 @@
+# This file configures the static analysis results for your project (errors,
+# warnings, and lints).
+#
+# This enables the 'recommended' set of lints from `package:lints`.
+# This set helps identify many issues that may lead to problems when running
+# or consuming Dart code, and enforces writing Dart using a single, idiomatic
+# style and format.
+#
+# If you want a smaller set of lints you can change this to specify
+# 'package:lints/core.yaml'. These are just the most critical lints
+# (the recommended set includes the core lints).
+# The core lints are also what is used by pub.dev for scoring packages.
+
+include: package:lints/recommended.yaml
+
+# Uncomment the following section to specify additional rules.
+
+# linter:
+#   rules:
+#     - camel_case_types
+
+# analyzer:
+#   exclude:
+#     - path/to/excluded/files/**
+
+# For more information about the core and recommended set of lints, see
+# https://dart.dev/go/core-lints
+
+# For additional information about configuring this file, see
+# https://dart.dev/guides/language/analysis-options

example/lib/example.dart

@@ -0,0 +1,126 @@
+// Copyright (c) 2023- All dart_gdbc authors. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
+import 'package:dart_gdbc/dart_gdbc.dart';
+
+void main() async {
+  DriverManager.registerDriver(SampleDriver());
+  var conn = await DriverManager.getConnection('gdbc.dbname://ip:port/dbname');
+  conn.createStatement();
+  ResultSet rs = await conn.executeQuery('MATCH (n) RETURN n');
+  print(rs);
+}
+
+class SampleDriver extends Driver {
+  @override
+  bool acceptsURL(String url) {
+    return url.startsWith('gdbc.dbname://');
+  }
+
+  @override
+  Future<Connection> connect(String url, {Map<String, dynamic>? properties}) {
+    return Future.value(SampleConnection());
+  }
+}
+
+class SampleStatement extends Statement {
+  @override
+  Future<bool> execute([String? gql]) {
+    // TODO: implement execute
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<ResultSet> executeQuery([String? gql]) {
+    print(gql);
+    return Future.value(SampleResultSet());
+  }
+
+  @override
+  Future<int> executeUpdate(String? gql) {
+    // TODO: implement executeUpdate
+    throw UnimplementedError();
+  }
+}
+
+class SampleResultSet extends ResultSet {
+  @override
+  List<ValueMetaData> get metas => [];
+
+  @override
+  List<List> get rows => [];
+}
+
+class SampleConnection extends Connection {
+  @override
+  Future<void> close() {
+    // TODO: implement close
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<void> commit() {
+    // TODO: implement commit
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<Statement> createStatement() {
+    return Future.value(SampleStatement());
+  }
+
+  @override
+  Future<ResultSet> executeQuery(String gql) {
+    print(gql);
+    return Future.value(SampleResultSet());
+  }
+
+  @override
+  Future<int> executeUpdate(String gql) {
+    // TODO: implement executeUpdate
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<bool> getAutoCommit() {
+    // TODO: implement getAutoCommit
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<ResultSetMetaData> getMetaData() {
+    // TODO: implement getMetaData
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<bool> isClosed() {
+    // TODO: implement isClosed
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<PreparedStatement> prepareStatement(String gql) {
+    // TODO: implement prepareStatement
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<PreparedStatement> prepareStatementWithParameters(
+      String gql, List<ParameterMetaData> parameters) {
+    // TODO: implement prepareStatementWithParameters
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<void> rollback() {
+    // TODO: implement rollback
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<void> setAutoCommit(bool autoCommit) {
+    // TODO: implement setAutoCommit
+    throw UnimplementedError();
+  }
+}

example/pubspec.yaml

@@ -0,0 +1,16 @@
+name: example
+description: A sample command-line application.
+version: 1.0.0
+publish_to: none
+# repository: https://github.com/my_org/my_repo
+
+environment:
+  sdk: '>=2.19.0 <3.0.0'
+
+dependencies:
+  dart_gdbc: 
+    path: ../
+
+dev_dependencies:
+  lints: ^2.0.0
+  test: ^1.21.0

lib/src/connection.dart

@@ -4,29 +4,42 @@
 
 part of dart_gdbc;
 
+/// A connection (session) with a specific database.
 abstract class Connection {
+  /// Creates a new [Statement] instance.
   Future<Statement> createStatement();
 
+  /// Creates a new [PreparedStatement] instance.
   Future<PreparedStatement> prepareStatement(String gql);
 
+  /// Creates a new [PreparedStatement] instance with parameters.
   Future<PreparedStatement> prepareStatementWithParameters(
       String gql, List<ParameterMetaData> parameters);
 
+  /// Executes a query.
   Future<ResultSet> executeQuery(String gql);
 
+  /// Executes an update.
   Future<int> executeUpdate(String gql);
 
+  /// Connection state if auto commit is enabled.
   Future<bool> getAutoCommit();
 
+  /// Set connection state if auto commit is enabled.
   Future<void> setAutoCommit(bool autoCommit);
 
+  /// Commits all changes made since the previous commit/rollback.
   Future<void> commit();
 
+  /// Undoes all changes made in the current transaction.
   Future<void> rollback();
 
+  /// Closes the connection.
   Future<void> close();
 
+  /// Checks if the connection is closed.
   Future<bool> isClosed();
 
+  /// Gets the metadata of the connection.
   Future<ResultSetMetaData> getMetaData();
 }

lib/src/exeception/connect_exception.dart

@@ -4,6 +4,11 @@
 
 part of dart_gdbc;
 
+/// Exception thrown when a connection to a database could not be established.
+///---
+/// 當無法連接到數據庫時拋出的異常。
+///---
+/// 当无法连接到数据库时抛出的异常。
 class ConnectException extends GdbcException {
   ConnectException({String? message, Error? cause})
       : super(message: message, cause: cause);

lib/src/exeception/gdbc_exception.dart

@@ -4,6 +4,7 @@
 
 part of dart_gdbc;
 
+/// A super class for all exceptions thrown by dart_gdbc.
 class GdbcException implements Error {
   final String? message;