Trait

com.github.fsanaulla.chronicler.core

ManagementClient

Related Doc: package core

Permalink

trait ManagementClient[F[_], Req, Resp, Uri, Entity] extends SystemManagement[F] with DatabaseManagement[F, Req, Resp, Uri, Entity] with UserManagement[F, Req, Resp, Uri, Entity] with QueriesManagement[F, Req, Resp, Uri, Entity] with RetentionPolicyManagement[F, Req, Resp, Uri, Entity] with ContinuousQueryManagement[F, Req, Resp, Uri, Entity] with ShardManagement[F, Req, Resp, Uri, Entity] with SubscriptionManagement[F, Req, Resp, Uri, Entity] with AutoCloseable

Functionality of management client

F

- Container

Req

- Request type

Resp

- Response type

Uri

- Uri type

Entity

- Request entity type

Linear Supertypes
AutoCloseable, SubscriptionManagement[F, Req, Resp, Uri, Entity], SubscriptionsManagementQuery[Uri], ShardManagement[F, Req, Resp, Uri, Entity], ShardManagementQuery[Uri], ContinuousQueryManagement[F, Req, Resp, Uri, Entity], ContinuousQueries[Uri], RetentionPolicyManagement[F, Req, Resp, Uri, Entity], RetentionPolicyManagementQuery[Uri], QueriesManagement[F, Req, Resp, Uri, Entity], QueriesManagementQuery[Uri], UserManagement[F, Req, Resp, Uri, Entity], UserManagementQuery[Uri], DatabaseManagement[F, Req, Resp, Uri, Entity], DataManagementQuery[Uri], SystemManagement[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ManagementClient
  2. AutoCloseable
  3. SubscriptionManagement
  4. SubscriptionsManagementQuery
  5. ShardManagement
  6. ShardManagementQuery
  7. ContinuousQueryManagement
  8. ContinuousQueries
  9. RetentionPolicyManagement
  10. RetentionPolicyManagementQuery
  11. QueriesManagement
  12. QueriesManagementQuery
  13. UserManagement
  14. UserManagementQuery
  15. DatabaseManagement
  16. DataManagementQuery
  17. SystemManagement
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def close(): Unit

    Permalink
    Definition Classes
    AutoCloseable
    Annotations
    @throws( classOf[java.lang.Exception] )
  2. implicit abstract val fm: FlatMap[F]

    Permalink
    Definition Classes
    SubscriptionManagement
  3. abstract def ping: F[WriteResult]

    Permalink
    Definition Classes
    SystemManagement
  4. implicit abstract val qb: QueryBuilder[Uri]

    Permalink
    Definition Classes
    SubscriptionManagement
  5. implicit abstract val re: RequestExecutor[F, Req, Resp, Uri]

    Permalink
    Definition Classes
    SubscriptionManagement
  6. implicit abstract val rh: ResponseHandler[F, Resp]

    Permalink
    Definition Classes
    SubscriptionManagement

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def createAdmin(username: String, password: String): F[WriteResult]

    Permalink

    Create admin user

    Create admin user

    username

    - admin name

    password

    - admin password

    returns

    - execution response

    Definition Classes
    UserManagement
  7. final def createCQ(dbName: String, cqName: String, query: String): F[WriteResult]

    Permalink

    Create new one continuous query

    Create new one continuous query

    dbName

    - database on which CQ will runes

    cqName

    - continuous query name

    query

    - query

    Definition Classes
    ContinuousQueryManagement
  8. final def createDatabase(dbName: String, duration: Option[String] = None, replication: Option[Int] = None, shardDuration: Option[String] = None, rpName: Option[String] = None): F[WriteResult]

    Permalink

    Create database

    Create database

    dbName

    - database name

    duration

    - database duration

    replication

    - replication

    shardDuration

    - shard duration

    rpName

    - retention policy name

    returns

    - execution R

    Definition Classes
    DatabaseManagement
  9. final def createDatabaseQuery(dbName: String, duration: Option[String], replication: Option[Int], shardDuration: Option[String], rpName: Option[String])(implicit qb: QueryBuilder[Uri]): Uri

    Permalink
    Definition Classes
    DataManagementQuery
  10. final def createRetentionPolicy(rpName: String, dbName: String, duration: String, replication: Int = 1, shardDuration: Option[String] = None, default: Boolean = false): F[WriteResult]

    Permalink

    Create retention policy for specified database

    Create retention policy for specified database

    rpName

    - retention policy name

    dbName

    - database name

    duration

    - retention policy duration

    replication

    - replication factor

    shardDuration

    - shard duration value

    default

    - use default

    returns

    - execution result

    Definition Classes
    RetentionPolicyManagement
  11. final def createSubscription(subsName: String, dbName: String, rpName: String = "autogen", destinationType: Destination, addresses: Seq[String]): F[WriteResult]

    Permalink

    Create subscription

    Create subscription

    subsName

    - subscription name

    dbName

    - database name

    rpName

    - retention policy name

    destinationType

    - destination type, where subscription should aggregate data

    addresses

    - subscription addresses

    returns

    - execution result

    Definition Classes
    SubscriptionManagement
  12. final def createUser(username: String, password: String): F[WriteResult]

    Permalink

    * Create new username

    * Create new username

    username

    - Name for new user

    password

    - Password for new user

    returns

    - Result of execution

    Definition Classes
    UserManagement
  13. final def deleteAllSeriesQuery(dbName: String, seriesName: String)(implicit qb: QueryBuilder[Uri]): Uri

    Permalink
    Definition Classes
    DataManagementQuery
  14. final def disableAdmin(username: String): F[WriteResult]

    Permalink

    Remove admin rights

    Remove admin rights

    Definition Classes
    UserManagement
  15. final def dropCQ(dbName: String, cqName: String): F[WriteResult]

    Permalink

    Drop continuous query

    Drop continuous query

    dbName

    - database name

    cqName

    - continuous query name

    returns

    - execution result

    Definition Classes
    ContinuousQueryManagement
  16. final def dropDatabase(dbName: String): F[WriteResult]

    Permalink

    Drop database

    Drop database

    Definition Classes
    DatabaseManagement
  17. final def dropDatabaseQuery(dbName: String)(implicit qb: QueryBuilder[Uri]): Uri

    Permalink
    Definition Classes
    DataManagementQuery
  18. final def dropMeasurement(dbName: String, measurementName: String): F[WriteResult]

    Permalink

    Drop measurement

    Drop measurement

    Definition Classes
    DatabaseManagement
  19. final def dropMeasurementQuery(dbName: String, measurementName: String)(implicit qb: QueryBuilder[Uri]): Uri

    Permalink
    Definition Classes
    DataManagementQuery
  20. final def dropRetentionPolicy(rpName: String, dbName: String): F[WriteResult]

    Permalink

    Drop retention policy

    Drop retention policy

    Definition Classes
    RetentionPolicyManagement
  21. final def dropSeriesQuery(dbName: String, seriesName: String)(implicit qb: QueryBuilder[Uri]): Uri

    Permalink
    Definition Classes
    DataManagementQuery
  22. final def dropShard(shardId: Int): F[WriteResult]

    Permalink

    Drop shard

    Drop shard

    Definition Classes
    ShardManagement
  23. final def dropSubscription(subName: String, dbName: String, rpName: String): F[WriteResult]

    Permalink

    Drop subscription

    Drop subscription

    Definition Classes
    SubscriptionManagement
  24. final def dropUser(username: String): F[WriteResult]

    Permalink

    Drop user

    Drop user

    Definition Classes
    UserManagement
  25. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  27. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  29. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  31. final def killQuery(queryId: Int): F[WriteResult]

    Permalink

    Kill query

    Kill query

    Definition Classes
    QueriesManagement
  32. final def makeAdmin(username: String): F[WriteResult]

    Permalink

    Grant admin rights

    Grant admin rights

    Definition Classes
    UserManagement
  33. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  34. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  35. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. final def revokePrivileges(username: String, dbName: String, privilege: Privilege): F[WriteResult]

    Permalink

    Revoke user privilege on specified datasbase

    Revoke user privilege on specified datasbase

    Definition Classes
    UserManagement
  37. final def setPrivileges(username: String, dbName: String, privilege: Privilege): F[WriteResult]

    Permalink

    Set user privilege on specified database

    Set user privilege on specified database

    Definition Classes
    UserManagement
  38. final def setUserPassword(username: String, password: String): F[WriteResult]

    Permalink

    Set password for user

    Set password for user

    Definition Classes
    UserManagement
  39. final def showCQs: F[QueryResult[ContinuousQueryInfo]]

    Permalink

    Show continuous query information

    Show continuous query information

    Definition Classes
    ContinuousQueryManagement
  40. final def showDatabases(): F[QueryResult[String]]

    Permalink

    Show database list

    Show database list

    Definition Classes
    DatabaseManagement
  41. final def showDatabasesQuery(implicit qb: QueryBuilder[Uri]): Uri

    Permalink
    Definition Classes
    DataManagementQuery
  42. final def showFieldKeys(dbName: String, measurementName: String): F[QueryResult[FieldInfo]]

    Permalink

    Show field tags list

    Show field tags list

    Definition Classes
    DatabaseManagement
  43. final def showFieldKeysQuery(dbName: String, measurementName: String)(implicit qb: QueryBuilder[Uri]): Uri

    Permalink
    Definition Classes
    DataManagementQuery
  44. final def showMeasurement(dbName: String): F[QueryResult[String]]

    Permalink

    Show measurements

    Show measurements

    Definition Classes
    DatabaseManagement
  45. final def showMeasurementQuery(dbName: String)(implicit qb: QueryBuilder[Uri]): Uri

    Permalink
    Definition Classes
    DataManagementQuery
  46. final def showQueries: F[QueryResult[QueryInfo]]

    Permalink

    Show list of queries

    Show list of queries

    Definition Classes
    QueriesManagement
  47. final def showRetentionPolicies(dbName: String): F[QueryResult[RetentionPolicyInfo]]

    Permalink

    Show list of retention polices

    Show list of retention polices

    Definition Classes
    RetentionPolicyManagement
  48. final def showShardGroups: F[QueryResult[ShardGroupsInfo]]

    Permalink

    Show shard groups

    Show shard groups

    Definition Classes
    ShardManagement
  49. final def showShards: F[QueryResult[ShardInfo]]

    Permalink

    Show shards

    Show shards

    Definition Classes
    ShardManagement
  50. final def showSubscriptionsInfo: F[QueryResult[SubscriptionInfo]]

    Permalink

    Show list of subscription info

    Show list of subscription info

    Definition Classes
    SubscriptionManagement
  51. final def showTagKeys(dbName: String, measurementName: String, whereClause: Option[String] = None, limit: Option[Int] = None, offset: Option[Int] = None): F[QueryResult[String]]

    Permalink

    Show tags keys list

    Show tags keys list

    Definition Classes
    DatabaseManagement
  52. final def showTagKeysQuery(dbName: String, measurementName: String, whereClause: Option[String], limit: Option[Int], offset: Option[Int])(implicit qb: QueryBuilder[Uri]): Uri

    Permalink
    Definition Classes
    DataManagementQuery
  53. final def showTagValues(dbName: String, measurementName: String, withKey: Seq[String], whereClause: Option[String] = None, limit: Option[Int] = None, offset: Option[Int] = None): F[QueryResult[TagValue]]

    Permalink

    Show tag values list

    Show tag values list

    Definition Classes
    DatabaseManagement
  54. final def showTagValuesQuery(dbName: String, measurementName: String, withKey: Seq[String], whereClause: Option[String], limit: Option[Int], offset: Option[Int])(implicit qb: QueryBuilder[Uri]): Uri

    Permalink
    Definition Classes
    DataManagementQuery
  55. final def showUserPrivileges(username: String): F[QueryResult[UserPrivilegesInfo]]

    Permalink

    Show user privileges

    Show user privileges

    Definition Classes
    UserManagement
  56. final def showUsers: F[QueryResult[UserInfo]]

    Permalink

    Show use lists

    Show use lists

    Definition Classes
    UserManagement
  57. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  58. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  59. final def updateRetentionPolicy(rpName: String, dbName: String, duration: Option[String] = None, replication: Option[Int] = None, shardDuration: Option[String] = None, default: Boolean = false): F[WriteResult]

    Permalink

    Update retention policy

    Update retention policy

    Definition Classes
    RetentionPolicyManagement
  60. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AutoCloseable

Inherited from SubscriptionManagement[F, Req, Resp, Uri, Entity]

Inherited from SubscriptionsManagementQuery[Uri]

Inherited from ShardManagement[F, Req, Resp, Uri, Entity]

Inherited from ShardManagementQuery[Uri]

Inherited from ContinuousQueryManagement[F, Req, Resp, Uri, Entity]

Inherited from ContinuousQueries[Uri]

Inherited from RetentionPolicyManagement[F, Req, Resp, Uri, Entity]

Inherited from RetentionPolicyManagementQuery[Uri]

Inherited from QueriesManagement[F, Req, Resp, Uri, Entity]

Inherited from QueriesManagementQuery[Uri]

Inherited from UserManagement[F, Req, Resp, Uri, Entity]

Inherited from UserManagementQuery[Uri]

Inherited from DatabaseManagement[F, Req, Resp, Uri, Entity]

Inherited from DataManagementQuery[Uri]

Inherited from SystemManagement[F]

Inherited from AnyRef

Inherited from Any

Ungrouped