Package org.pgcodekeeper.core.schema.ch

Class ChUser

java.lang.Object
org.pgcodekeeper.core.schema.PgStatement
org.pgcodekeeper.core.schema.ch.ChUser
All Implemented Interfaces:
IHashable, IStatement
public final class ChUser extends PgStatement
Represents a ClickHouse user account with authentication and authorization settings. It supports hosts restrictions, role assignments, default database, and grantee configurations.

  • Constructor Details

    • ChUser

      public ChUser(String name)
      Creates a new ClickHouse user with the specified name.
      Parameters:
      name - the name of the user

  • Method Details

    • getStatementType

      public DbObjType getStatementType()
      Description copied from interface: IStatement
      Gets the type of this database object.
      Returns:
      the database object type

    • getDbType

      public DatabaseType getDbType()
      Overrides:
      getDbType in class PgStatement

    • getDatabase

      public AbstractDatabase getDatabase()
      Description copied from interface: IStatement
      Gets the database that contains this statement.
      Returns:
      the containing database

    • getCreationSQL

      public void getCreationSQL(SQLScript script)
      Description copied from class: PgStatement
      Generates the SQL statements needed to create this database object. This is an abstract method that must be implemented by subclasses to provide the specific CREATE SQL for each object type.
      Specified by:
      getCreationSQL in class PgStatement
      Parameters:
      script - the SQL script to append creation statements to

    • appendAlterSQL

      public ObjectState appendAlterSQL(PgStatement newCondition, SQLScript script)
      Description copied from class: PgStatement
      Fill script with object changes and return change type
      Specified by:
      appendAlterSQL in class PgStatement
      Parameters:
      newCondition - new object state
      script - script to collect changes
      Returns:
      object change type

    • compare

      public boolean compare(PgStatement obj)
      Description copied from class: PgStatement
      This method does not account for nested child PgStatements. Shallow version of PgStatement.equals(Object)
      Overrides:
      compare in class PgStatement

    • shallowCopy

      public PgStatement shallowCopy()
      Description copied from class: PgStatement
      Copies all object properties into a new object and leaves all its children empty.
      Specified by:
      shallowCopy in class PgStatement
      Returns:
      shallow copy of a DB object.

    • computeHash

      public void computeHash(Hasher hasher)
      Description copied from interface: IHashable
      Computes the hash of the implementing object using the provided hasher. The implementation should call appropriate put methods on the hasher for all fields that should contribute to the hash value.
      Parameters:
      hasher - the hasher instance to use for hash computation

    • setDefaultDatabase

      public void setDefaultDatabase(String defaultDatabase)

    • addDefRole

      public void addDefRole(String defRole)
      Adds a default role for this user.
      Parameters:
      defRole - the role name to add as default

    • addExceptRole

      public void addExceptRole(String exceptRole)
      Adds a role to the EXCEPT list for default roles.
      Parameters:
      exceptRole - the role name to exclude from defaults

    • addGrantee

      public void addGrantee(String grantee)
      Adds a grantee role for this user.
      Parameters:
      grantee - the grantee role name to add

    • addExGrantee

      public void addExGrantee(String exGrantee)
      Adds a role to the EXCEPT list for grantees.
      Parameters:
      exGrantee - the grantee role name to exclude

    • hasHosts

      public boolean hasHosts()
      Checks if this user has host restrictions.
      Returns:
      true if no host restrictions are defined, false otherwise

    • addHost

      public void addHost(String host)
      Adds a host restriction for this user.
      Parameters:
      host - the host pattern to add

    • setStorageType

      public void setStorageType(String storageType)