Documentation

UserRole
in package

UserRoles contains information about a user.

Table of Contents

Properties

$conns_in_use  : mixed
$read_info  : mixed
$roles  : mixed
$user  : mixed
$write_info  : mixed

Methods

getConnsInUse()  : int
ConnsInUse is the number of currently open connections for the user
getReadInfo()  : array<string|int, mixed>
ReadInfo is the list of read statistics. List may be nil.
getRoles()  : array<string|int, mixed>
Roles is a list of assigned roles.
getUser()  : string
User name.
getWriteInfo()  : array<string|int, mixed>
WriteInfo is the list of write statistics. List may be nil.

Properties

Methods

getConnsInUse()

ConnsInUse is the number of currently open connections for the user

public getConnsInUse() : int
Return values
int

getReadInfo()

ReadInfo is the list of read statistics. List may be nil.

public getReadInfo() : array<string|int, mixed>

Current statistics by offset are:

0: read quota in records per second 1: single record read transaction rate (TPS) 2: read scan/query record per second rate (RPS) 3: number of limitless read scans/queries

Future server releases may add additional statistics.

Return values
array<string|int, mixed>

getRoles()

Roles is a list of assigned roles.

public getRoles() : array<string|int, mixed>
Return values
array<string|int, mixed>

getWriteInfo()

WriteInfo is the list of write statistics. List may be nil.

public getWriteInfo() : array<string|int, mixed>

Current statistics by offset are:

0: write quota in records per second 1: single record write transaction rate (TPS) 2: write scan/query record per second rate (RPS) 3: number of limitless write scans/queries

Future server releases may add additional statistics.

Return values
array<string|int, mixed>

        
On this page

Search results