Package cc.carm.lib.easysql.api.builder

Interface TableAlterBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default SQLAction<java.lang.Integer> addAutoIncrementColumn​(@NotNull java.lang.String columnName)
      为该表添加一个自增列
      自增列强制要求为数字类型，非空，且为UNIQUE。
      default SQLAction<java.lang.Integer> addAutoIncrementColumn​(@NotNull java.lang.String columnName, @NotNull NumberType numberType)
      为该表添加一个自增列
      自增列强制要求为数字类型，非空，且为UNIQUE。
      default SQLAction<java.lang.Integer> addAutoIncrementColumn​(@NotNull java.lang.String columnName, @Nullable NumberType numberType, boolean primary, boolean unsigned)
      为该表添加一个自增列
      default SQLAction<java.lang.Integer> addColumn​(@NotNull java.lang.String columnName, @NotNull java.lang.String settings)
      为表添加一列
      SQLAction<java.lang.Integer> addColumn​(@NotNull java.lang.String columnName, @NotNull java.lang.String settings, @Nullable java.lang.String afterColumn)
      为表添加一列
      SQLAction<java.lang.Integer> addIndex​(@NotNull IndexType indexType, @Nullable java.lang.String indexName, @NotNull java.lang.String columnName, @NotNull java.lang.String... moreColumns)  
      SQLAction<java.lang.Integer> changeComment​(@NotNull java.lang.String newTableComment)  
      SQLAction<java.lang.Integer> dropForeignKey​(@NotNull java.lang.String keySymbol)
      为该表移除一个外键
      SQLAction<java.lang.Integer> dropIndex​(@NotNull java.lang.String indexName)
      为该表移除一个索引
      SQLAction<java.lang.Integer> dropPrimaryKey()
      为该表移除主键(须添加新主键)
      SQLAction<java.lang.Integer> modifyColumn​(@NotNull java.lang.String columnName, @NotNull java.lang.String settings)  
      default SQLAction<java.lang.Integer> modifyColumn​(@NotNull java.lang.String columnName, @NotNull java.lang.String columnSettings, @NotNull java.lang.String afterColumn)  
      SQLAction<java.lang.Integer> removeColumn​(@NotNull java.lang.String columnName)  
      SQLAction<java.lang.Integer> removeColumnDefault​(@NotNull java.lang.String columnName)  
      SQLAction<java.lang.Integer> renameColumn​(@NotNull java.lang.String columnName, @NotNull java.lang.String newName)  
      SQLAction<java.lang.Integer> renameTo​(@NotNull java.lang.String newTableName)  
      SQLAction<java.lang.Integer> setAutoIncrementIndex​(int index)  
      SQLAction<java.lang.Integer> setColumnDefault​(@NotNull java.lang.String columnName, @NotNull java.lang.String defaultValue)  

    • Method Detail

      • renameTo

        SQLAction<java.lang.Integer> renameTo​(@NotNull
                                      @NotNull java.lang.String newTableName)

      • changeComment

        SQLAction<java.lang.Integer> changeComment​(@NotNull
                                           @NotNull java.lang.String newTableComment)

      • setAutoIncrementIndex

        SQLAction<java.lang.Integer> setAutoIncrementIndex​(int index)

      • addIndex

        SQLAction<java.lang.Integer> addIndex​(@NotNull
                                      @NotNull IndexType indexType,
                                      @Nullable
                                      @Nullable java.lang.String indexName,
                                      @NotNull
                                      @NotNull java.lang.String columnName,
                                      @NotNull
                                      @NotNull java.lang.String... moreColumns)

      • dropIndex

        SQLAction<java.lang.Integer> dropIndex​(@NotNull
                                       @NotNull java.lang.String indexName)
        为该表移除一个索引
        Parameters:
        indexName - 索引名
        Returns:
        SQLUpdateAction

      • dropForeignKey

        SQLAction<java.lang.Integer> dropForeignKey​(@NotNull
                                            @NotNull java.lang.String keySymbol)
        为该表移除一个外键
        Parameters:
        keySymbol - 外键名
        Returns:
        SQLUpdateAction

      • dropPrimaryKey

        SQLAction<java.lang.Integer> dropPrimaryKey()
        为该表移除主键(须添加新主键)
        Returns:
        SQLUpdateAction

      • addColumn

        default SQLAction<java.lang.Integer> addColumn​(@NotNull
                                               @NotNull java.lang.String columnName,
                                               @NotNull
                                               @NotNull java.lang.String settings)
        为表添加一列
        Parameters:
        columnName - 列名
        settings - 列的相关设定
        Returns:
        SQLUpdateAction

      • addColumn

        SQLAction<java.lang.Integer> addColumn​(@NotNull
                                       @NotNull java.lang.String columnName,
                                       @NotNull
                                       @NotNull java.lang.String settings,
                                       @Nullable
                                       @Nullable java.lang.String afterColumn)
        为表添加一列
        Parameters:
        columnName - 列名
        settings - 列的相关设定
        afterColumn - 该列增添到哪个列的后面，

        该参数若省缺则放于最后一行

        若为 "" 则置于首行。

        Returns:
        SQLUpdateAction

      • renameColumn

        SQLAction<java.lang.Integer> renameColumn​(@NotNull
                                          @NotNull java.lang.String columnName,
                                          @NotNull
                                          @NotNull java.lang.String newName)

      • modifyColumn

        SQLAction<java.lang.Integer> modifyColumn​(@NotNull
                                          @NotNull java.lang.String columnName,
                                          @NotNull
                                          @NotNull java.lang.String settings)

      • modifyColumn

        default SQLAction<java.lang.Integer> modifyColumn​(@NotNull
                                                  @NotNull java.lang.String columnName,
                                                  @NotNull
                                                  @NotNull java.lang.String columnSettings,
                                                  @NotNull
                                                  @NotNull java.lang.String afterColumn)

      • removeColumn

        SQLAction<java.lang.Integer> removeColumn​(@NotNull
                                          @NotNull java.lang.String columnName)

      • setColumnDefault

        SQLAction<java.lang.Integer> setColumnDefault​(@NotNull
                                              @NotNull java.lang.String columnName,
                                              @NotNull
                                              @NotNull java.lang.String defaultValue)

      • removeColumnDefault

        SQLAction<java.lang.Integer> removeColumnDefault​(@NotNull
                                                 @NotNull java.lang.String columnName)

      • addAutoIncrementColumn

        default SQLAction<java.lang.Integer> addAutoIncrementColumn​(@NotNull
                                                            @NotNull java.lang.String columnName,
                                                            @Nullable
                                                            @Nullable NumberType numberType,
                                                            boolean primary,
                                                            boolean unsigned)
        为该表添加一个自增列

        自增列强制要求为数字类型，非空，且为UNIQUE。

        注意：一个表只允许有一个自增列！

        Parameters:
        columnName - 列名
        numberType - 数字类型，若省缺则为 NumberType.INT
        primary - 是否为主键，若否则只为唯一键
        unsigned - 是否采用 UNSIGNED (即无负数，可以增加自增键的最高数，建议为true)
        Returns:
        TableCreateBuilder

      • addAutoIncrementColumn

        default SQLAction<java.lang.Integer> addAutoIncrementColumn​(@NotNull
                                                            @NotNull java.lang.String columnName,
                                                            @NotNull
                                                            @NotNull NumberType numberType)
        为该表添加一个自增列
        自增列强制要求为数字类型，非空，且为UNIQUE。

        注意：一个表只允许有一个自增列！

        Parameters:
        columnName - 列名
        numberType - 数字类型，若省缺则为 NumberType.INT
        Returns:
        TableAlterBuilder

      • addAutoIncrementColumn

        default SQLAction<java.lang.Integer> addAutoIncrementColumn​(@NotNull
                                                            @NotNull java.lang.String columnName)
        为该表添加一个自增列
        自增列强制要求为数字类型，非空，且为UNIQUE。

        注意：一个表只允许有一个自增列！

        Parameters:
        columnName - 列名
        Returns:
        TableAlterBuilder