Package cc.carm.plugin.minesql

Class MineSQL

  • public class MineSQL
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      MineSQL()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static @NotNull cc.carm.lib.easysql.api.SQLManager create​(@NotNull java.lang.String name, @NotNull SQLSourceConfig configuration)
      创建一个新的 SQLManager 实例
      static @NotNull cc.carm.lib.easysql.api.SQLManager create​(@NotNull java.lang.String name, @NotNull java.util.Properties properties)
      创建一个新的 SQLManager 实例
      static @NotNull cc.carm.lib.easysql.api.SQLManager create​(@NotNull java.lang.String name, @NotNull javax.sql.DataSource source)  
      static @NotNull SQLRegistry createRegistry()
      创建一个独立的管理器注册池。
      static void createTables​(@NotNull SQLTablesRoot tablesRoot)
      读取一个 SQLTablesRoot 中全部的 SimpleSQLTable 实例并初始化。
      static void createTables​(@NotNull java.lang.Class<? extends SQLTablesRoot> tablesRootClazz)
      读取一个 SQLTablesRoot类中 中全部的静态 SimpleSQLTable 实例并初始化。
      static java.io.File getDataSourceFolder()  
      static java.util.logging.Logger getLogger()  
      static SQLRegistry getRegistry()
      得到管理器注册池
      protected static void initializeAPI​(cc.carm.plugin.minesql.IMineSQL api)  
      static void shutdown​(cc.carm.lib.easysql.api.SQLManager manager)
      终止并关闭一个 SQLManager 实例。
      static void shutdown​(cc.carm.lib.easysql.api.SQLManager manager, boolean forceClose)
      终止并关闭一个 SQLManager 实例。
      static void shutdown​(cc.carm.lib.easysql.api.SQLManager manager, @Nullable java.util.function.Consumer<java.util.Map<java.util.UUID,​cc.carm.lib.easysql.api.SQLQuery>> activeQueries)
      终止并关闭一个 SQLManager 实例。

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MineSQL

        public MineSQL()

    • Method Detail

      • initializeAPI

        protected static void initializeAPI​(cc.carm.plugin.minesql.IMineSQL api)

      • getLogger

        public static java.util.logging.Logger getLogger()

      • getDataSourceFolder

        public static java.io.File getDataSourceFolder()
        Returns:
        数据库源文件所在目录，非插件数据目录。

      • getRegistry

        public static SQLRegistry getRegistry()
        得到管理器注册池
        Returns:
        SQLRegistry 注册池

      • createRegistry

        @NotNull
public static @NotNull SQLRegistry createRegistry()
        创建一个独立的管理器注册池。
        Returns:
        SQLRegistry

      • create

        @NotNull
public static @NotNull cc.carm.lib.easysql.api.SQLManager create​(@NotNull
                                                                 @NotNull java.lang.String name,
                                                                 @NotNull
                                                                 @NotNull SQLSourceConfig configuration)
                                                          throws java.lang.Exception
        创建一个新的 SQLManager 实例
        Parameters:
        name - 实例名称
        configuration - SQLManager 实例的配置
        Returns:
        SQLManager 实例
        Throws:
        java.lang.Exception - 若创建失败则抛出异常

      • create

        @NotNull
public static @NotNull cc.carm.lib.easysql.api.SQLManager create​(@NotNull
                                                                 @NotNull java.lang.String name,
                                                                 @NotNull
                                                                 @NotNull java.util.Properties properties)
                                                          throws java.lang.Exception
        创建一个新的 SQLManager 实例
        Parameters:
        name - 实例名称
        properties - SQLManager 实例的配置文件
        Returns:
        SQLManager 实例
        Throws:
        java.lang.Exception - 若创建失败则抛出异常

      • create

        @NotNull
public static @NotNull cc.carm.lib.easysql.api.SQLManager create​(@NotNull
                                                                 @NotNull java.lang.String name,
                                                                 @NotNull
                                                                 @NotNull javax.sql.DataSource source)
                                                          throws java.lang.Exception
        Throws:
        java.lang.Exception

      • shutdown

        public static void shutdown​(cc.carm.lib.easysql.api.SQLManager manager,
                            @Nullable
                            @Nullable java.util.function.Consumer<java.util.Map<java.util.UUID,​cc.carm.lib.easysql.api.SQLQuery>> activeQueries)
        终止并关闭一个 SQLManager 实例。
        Parameters:
        manager - SQLManager实例
        activeQueries - 终止前仍未被关闭的SQLQuery列表

      • shutdown

        public static void shutdown​(cc.carm.lib.easysql.api.SQLManager manager,
                            boolean forceClose)
        终止并关闭一个 SQLManager 实例。
        Parameters:
        manager - SQLManager实例
        forceClose - 是否强制关闭进行中的查询

      • shutdown

        public static void shutdown​(cc.carm.lib.easysql.api.SQLManager manager)
        终止并关闭一个 SQLManager 实例。
        若在终止时仍有活跃的查询，则将会强制关闭。
        Parameters:
        manager - SQLManager实例

      • createTables

        public static void createTables​(@NotNull
                                @NotNull SQLTablesRoot tablesRoot)
                         throws java.lang.Exception
        读取一个 SQLTablesRoot 中全部的 SimpleSQLTable 实例并初始化。
        Parameters:
        tablesRoot - SQLTablesRoot实例
        Throws:
        java.lang.Exception

      • createTables

        public static void createTables​(@NotNull
                                @NotNull java.lang.Class<? extends SQLTablesRoot> tablesRootClazz)
                         throws java.lang.Exception
        读取一个 SQLTablesRoot类中 中全部的静态 SimpleSQLTable 实例并初始化。
        Parameters:
        tablesRootClazz - SQLTablesRoot静态类
        Throws:
        java.lang.Exception