Sharkbite Documentation¶

Accumulo connector plugin

class pysharkbite.AccumuloConnector¶

Accumulo connector

getStatistics(self: pysharkbite.AccumuloConnector) → pysharkbite.AccumuloInfo ¶: Returns Statistics for the accumulo connector

namespaceOps(self: pysharkbite.AccumuloConnector, arg0: str) → pysharkbite.AccumuloNamespaceOperations ¶: Allows the user to perform namespace operations

securityOps(self: pysharkbite.AccumuloConnector) → interconnect::PythonSecurityOperations¶: Return the security operations object

tableOps(self: pysharkbite.AccumuloConnector, arg0: str) → pysharkbite.AccumuloTableOperations ¶: Return the table operations object

class pysharkbite.AccumuloInfo¶

property bad_servers¶

property dead_servers¶

getBadTabletServers(self: pysharkbite.AccumuloInfo) → Dict[str, int]¶: Gets a mapping of bad tablet servers.

getDeadServers(self: pysharkbite.AccumuloInfo) → List[pysharkbite.DeadServer]¶: Returns a list of dead tablet servers.

getGoalState(self: pysharkbite.AccumuloInfo) → pysharkbite.CoordinatorGoalState ¶: Returns the goal state of the cluster.

getServerShuttingDown(self: pysharkbite.AccumuloInfo) → Set[str]¶: Returns the set of servers shutting down.

getState(self: pysharkbite.AccumuloInfo) → pysharkbite.CoordinatorState ¶: Gets the state of the accumulo cluster.

getTableMap(self: pysharkbite.AccumuloInfo) → Dict[str, pysharkbite.TableInfo]¶: Gets the Table map for the cluster.

getTabletServerInfo(self: pysharkbite.AccumuloInfo) → List[pysharkbite.TabletServerStatus]¶: Gets tablet server Info

getUnassignedTablets(self: pysharkbite.AccumuloInfo) → int¶: Gets the unassigned tablets

property goal_state¶

property servs_shutting_down¶

property state¶

property table_map¶

property tablet_server_info¶

property unassigned_tablets¶

class pysharkbite.AccumuloNamespaceOperations¶

Accumulo namespace operations. Should be accessed through ‘AccumuloConnector’

create(self: pysharkbite.AccumuloNamespaceOperations, arg0: str) → None¶: Creates the namespace

exists(self: pysharkbite.AccumuloNamespaceOperations, arg0: str) → bool¶: Returns true if the namespace exists

list(self: pysharkbite.AccumuloNamespaceOperations) → List[str]¶: Lists namespaces within this Accumulo instance

remove(self: pysharkbite.AccumuloNamespaceOperations, arg0: str) → bool¶: removes the namespace

removeProperty(self: pysharkbite.AccumuloNamespaceOperations, arg0: str, arg1: str) → None¶: Remove the namespace property

rename(self: pysharkbite.AccumuloNamespaceOperations, arg0: str, arg1: str) → None¶: Renames the namespace

setProperty(self: pysharkbite.AccumuloNamespaceOperations, arg0: str, arg1: str, arg2: str) → None¶: Sets a namespace property

class pysharkbite.AccumuloTableOperations¶

Accumulo table operations. Should be accessed through ‘AccumuloConnector’

addConstraint(self: pysharkbite.AccumuloTableOperations, arg0: str) → int¶: Add table constraint

addSplits(self: pysharkbite.AccumuloTableOperations, arg0: Set[str]) → None¶: Add splits for a table

compact(self: pysharkbite.AccumuloTableOperations, arg0: str, arg1: str, arg2: bool) → int¶: compact the table

create(self: pysharkbite.AccumuloTableOperations, arg0: bool) → bool¶: Create the table

createScanner(self: pysharkbite.AccumuloTableOperations, arg0: cclient::data::security::Authorizations, arg1: int) → scanners::Source<cclient::data::KeyValue, scanners::ResultBlock<cclient::data::KeyValue> >¶: createWriter scanner

createWriter(self: pysharkbite.AccumuloTableOperations, arg0: cclient::data::security::Authorizations, arg1: int) → writer::Sink<cclient::data::KeyValue>¶: Create writer for table

exists(self: pysharkbite.AccumuloTableOperations, arg0: bool) → bool¶: Returns true if the table exists

flush(self: pysharkbite.AccumuloTableOperations, arg0: str, arg1: str, arg2: bool) → int¶: flush the table

import(self: pysharkbite.AccumuloTableOperations, arg0: str, arg1: str, arg2: bool) → bool¶: import data into this directory

remove(self: pysharkbite.AccumuloTableOperations) → bool¶: remove the table

removeProperty(self: pysharkbite.AccumuloTableOperations, arg0: str) → int¶: Remove the table property

setProperty(self: pysharkbite.AccumuloTableOperations, arg0: str, arg1: str) → int¶: Set table property

class pysharkbite.AuthInfo¶

Auth info object contains accessor to an Accumulo Instance

getInstanceId(self: pysharkbite.AuthInfo) → str¶: Get the instance ID

getPassword(self: pysharkbite.AuthInfo) → str¶: Get the user’s password

getUserName(self: pysharkbite.AuthInfo) → str¶: Get the username

class pysharkbite.Authorizations¶

Authorizations object

addAuthorization(self: pysharkbite.Authorizations, arg0: str) → None¶: Add an authorization to be used for table operations

contains(self: pysharkbite.Authorizations, arg0: str) → bool¶: Returns true if the set contains an authorization

get_authorizations(self: pysharkbite.Authorizations) → List[str]¶: Returns an iterable of authorizations

class pysharkbite.BatchScanner¶

Batch Scanner to be constructed via TableOperations

addIterator(*args, **kwargs)¶

Overloaded function.

addIterator(self: pysharkbite.BatchScanner, arg0: pysharkbite.IterInfo) -> None

Add an iterator to be run server side

addIterator(self: pysharkbite.BatchScanner, arg0: pysharkbite.PythonIterator) -> None

Adds a python iterator to be run server side

addRange(self: pysharkbite.BatchScanner, arg0: pysharkbite.Range) → None¶: Adds a range

close(self: pysharkbite.BatchScanner) → None¶: closes the scanner

fetchColumn(self: pysharkbite.BatchScanner, arg0: str, arg1: str) → None¶: Fetches the column

getResultSet(self: pysharkbite.BatchScanner) → pysharkbite.Results ¶: Gets a result set that can be used asynchronously

removeOption(self: pysharkbite.BatchScanner, arg0: pysharkbite.ScannerOptions) → None¶: Removes an option

setOption(self: pysharkbite.BatchScanner, arg0: pysharkbite.ScannerOptions) → None¶: Sets the option

withRange(self: pysharkbite.BatchScanner, arg0: pysharkbite.Range) → pysharkbite.BatchScanner ¶

class pysharkbite.BatchWriter¶

Batch writer to be constructed, from TableOperations

addMutation(self: pysharkbite.BatchWriter, arg0: pysharkbite.Mutation) → bool¶: Adds a mutation to the batch writer

close(self: pysharkbite.BatchWriter) → None¶: Closes the batch writer

flush(self: pysharkbite.BatchWriter, arg0: bool) → None¶: Flushes the batch writer. Will be called automatically by close.

size(self: pysharkbite.BatchWriter) → int¶: Returns the current size to be written to Accumulo

exception pysharkbite.ClientException¶

class pysharkbite.Compacting¶

getQueued(self: pysharkbite.Compacting) → int¶: Gets queued compactions.

getRunning(self: pysharkbite.Compacting) → int¶: Gets running compactions.

property queued¶

property running¶

class pysharkbite.Configuration¶

Sharkbite Configuration object.

get(*args, **kwargs)¶

Overloaded function.

get(self: pysharkbite.Configuration, arg0: str) -> str

Get the configuration option

get(self: pysharkbite.Configuration, arg0: str, arg1: str) -> str

Get the configuration option with default value

getLong(self: pysharkbite.Configuration, arg0: str, arg1: int) → int¶: Get the integer value of a configuration item

set(self: pysharkbite.Configuration, arg0: str, arg1: str) → None¶: Set a configuration option

class pysharkbite.CoordinatorGoalState¶

Members:

CLEAN_STOP : CLEAN_STOP state

SAFE_MODE : SAFE_MODE state

NORMAL : NORMAL state

CLEAN_STOP = CoordinatorGoalState.CLEAN_STOP¶

NORMAL = CoordinatorGoalState.NORMAL¶

SAFE_MODE = CoordinatorGoalState.SAFE_MODE¶

__entries = {'CLEAN_STOP': (CoordinatorGoalState.CLEAN_STOP, 'CLEAN_STOP state'), 'NORMAL': (CoordinatorGoalState.NORMAL, 'NORMAL state'), 'SAFE_MODE': (CoordinatorGoalState.SAFE_MODE, 'SAFE_MODE state')}¶

property name¶: (self: handle) -> str

class pysharkbite.CoordinatorState¶

Members:

INITIAL : INITIAL state

HAVE_LOCK : HAVE_LOCK state

SAFE_MODE : SAFE_MODE state

NORMAL : NORMAL state

UNLOAD_METADATA_TABLETS : UNLOAD_METADATA_TABLETS state

UNLOAD_ROOT_TABLET : UNLOAD_ROOT_TABLET state

STOP : STOP state

HAVE_LOCK = CoordinatorState.HAVE_LOCK¶

INITIAL = CoordinatorState.INITIAL¶

NORMAL = CoordinatorState.NORMAL¶

SAFE_MODE = CoordinatorState.SAFE_MODE¶

STOP = CoordinatorState.STOP¶

UNLOAD_METADATA_TABLETS = CoordinatorState.UNLOAD_METADATA_TABLETS¶

UNLOAD_ROOT_TABLET = CoordinatorState.UNLOAD_ROOT_TABLET¶

__entries = {'HAVE_LOCK': (CoordinatorState.HAVE_LOCK, 'HAVE_LOCK state'), 'INITIAL': (CoordinatorState.INITIAL, 'INITIAL state'), 'NORMAL': (CoordinatorState.NORMAL, 'NORMAL state'), 'SAFE_MODE': (CoordinatorState.SAFE_MODE, 'SAFE_MODE state'), 'STOP': (CoordinatorState.STOP, 'STOP state'), 'UNLOAD_METADATA_TABLETS': (CoordinatorState.UNLOAD_METADATA_TABLETS, 'UNLOAD_METADATA_TABLETS state'), 'UNLOAD_ROOT_TABLET': (CoordinatorState.UNLOAD_ROOT_TABLET, 'UNLOAD_ROOT_TABLET state')}¶

property name¶: (self: handle) -> str

class pysharkbite.DeadServer¶

getLastContact(self: pysharkbite.DeadServer) → int¶: Get last contact time with this server.

getServer(self: pysharkbite.DeadServer) → str¶: Gets the server name.

getStatus(self: pysharkbite.DeadServer) → str¶: Gets the status of the server.

property last_contact¶

property server¶

property status¶

class pysharkbite.Hdfs¶

HDFS refernce object

chown(self: pysharkbite.Hdfs, arg0: str, arg1: str, arg2: str) → int¶: Chowns the provided path

list(self: pysharkbite.Hdfs, arg0: str) → List[pysharkbite.HdfsDirEnt]¶: Lists HDFS directory, returns a list of HdfsDirEnt objects

mkdir(self: pysharkbite.Hdfs, arg0: str) → int¶: Creates a directory on HDFS. Should be a relative path

move(self: pysharkbite.Hdfs, arg0: str, arg1: str) → int¶: Moves a file within a NN instance.

read(self: pysharkbite.Hdfs, arg0: str) → cclient::data::streams::InputStream¶: Opens a read stream to an HDFS file, creating or updating it

remove(self: pysharkbite.Hdfs, arg0: str, arg1: bool) → int¶: Removes a file or directory, the boolean flag, if set to true, deletes recusively

rename(self: pysharkbite.Hdfs, arg0: str, arg1: str) → int¶: Renames a path

write(self: pysharkbite.Hdfs, arg0: str) → cclient::data::streams::ByteOutputStream¶: Opens a write stream to an HDFS file, creating or updating it

class pysharkbite.HdfsDirEnt¶

HDFS directory entry object.

getGroup(self: pysharkbite.HdfsDirEnt) → str¶: Gets the group of the directory entry

getName(self: pysharkbite.HdfsDirEnt) → str¶: Gets the name of the directory entry

getOwner(self: pysharkbite.HdfsDirEnt) → str¶: Gets the owner of the directory entry

getSize(self: pysharkbite.HdfsDirEnt) → int¶: Returns the size of the directory entry

class pysharkbite.HdfsInputStream¶

HDFS Input Stream

readBytes(self: pysharkbite.HdfsInputStream, arg0: str, arg1: int) → int¶: Reads a character sequence from the file on HDFS

readInt(self: pysharkbite.HdfsInputStream) → int¶: Reads a four byte integer

readLong(self: pysharkbite.HdfsInputStream) → int¶: Reads an eight byte integer

readShort(self: pysharkbite.HdfsInputStream) → int¶: Reads a two byte integer

readString(self: pysharkbite.HdfsInputStream) → str¶: Reads a string

class pysharkbite.HdfsOutputStream¶

HDFS Output Stream

write(self: pysharkbite.HdfsOutputStream, arg0: str, arg1: int) → int¶: Writes an eight byte integer

writeInt(self: pysharkbite.HdfsOutputStream, arg0: int) → int¶: Writes a four byte integer

writeLong(self: pysharkbite.HdfsOutputStream, arg0: int) → int¶: Writes an eight byte integer

writeShort(self: pysharkbite.HdfsOutputStream, arg0: int) → int¶: Writes a two byte integer

writeString(self: pysharkbite.HdfsOutputStream, arg0: str) → int¶: Writes a string

class pysharkbite.Instance¶: Accumulo Instance

class pysharkbite.IterInfo¶

IterInfo is an iterator configuration

getClass(self: pysharkbite.IterInfo) → str¶: Get the class for this iterator

getName(self: pysharkbite.IterInfo) → str¶: Get the name of this iterator

getPriority(self: pysharkbite.IterInfo) → int¶: Get the priority for this iterator

class pysharkbite.Key¶

Accumulo Key

getColumnFamily(self: pysharkbite.Key) → str¶: Gets the Column Family

getColumnQualifier(self: pysharkbite.Key) → str¶: Gets the Column Qualifier

getColumnVisibility(self: pysharkbite.Key) → str¶: Gets the Column Visibility

getRow(self: pysharkbite.Key) → str¶: Gets the row

getTimestamp(self: pysharkbite.Key) → int¶: Gets the key timestamp

setColumnFamily(self: pysharkbite.Key, arg0: str) → None¶: Sets the column fmaily

setColumnQualifier(self: pysharkbite.Key, arg0: str) → None¶: Sets the column qualifier

setRow(self: pysharkbite.Key, arg0: str) → None¶: Sets the row

class pysharkbite.KeyValue¶

getKey(self: pysharkbite.KeyValue) → pysharkbite.Key ¶: Gets the Key from the key value object

getValue(self: pysharkbite.KeyValue) → pysharkbite.Value ¶: Gets the Value from the key value object

class pysharkbite.KeyValueIterator¶

Iterable object within Accumulo

getTopKey(self: pysharkbite.KeyValueIterator) → pysharkbite.Key ¶: Returns the top key

getTopValue(self: pysharkbite.KeyValueIterator) → pysharkbite.Value ¶: Returns the top value

hasNext(self: pysharkbite.KeyValueIterator) → bool¶: Returns true of further keys exist, false otherwise

next(self: pysharkbite.KeyValueIterator) → None¶: Queues the next key/value to be returned via getTopKey and getTopValue

seek(self: pysharkbite.KeyValueIterator, arg0: cclient::data::streams::StreamRelocation) → None¶: Seeks to a key within the iterator

class pysharkbite.LoggingConfiguration¶

Sharkbite Logger, enables logging at the debug and trace levels

static enableDebugLogger() → None¶: Enables the debug logging for all classes

static enableTraceLogger() → None¶: Enables trace logging for all classes

class pysharkbite.Mutation¶

put(*args, **kwargs)¶

Overloaded function.

put(self: pysharkbite.Mutation, arg0: str, arg1: str, arg2: str, arg3: int, arg4: str) -> None

Adds a mutation

put(self: pysharkbite.Mutation, arg0: str, arg1: str, arg2: str, arg3: int) -> None

Adds a mutation

put(self: pysharkbite.Mutation, arg0: str, arg1: str, arg2: str) -> None

Adds a mutation

put(self: pysharkbite.Mutation, arg0: str, arg1: str) -> None

Adds a mutation

putDelete(*args, **kwargs)¶

Overloaded function.

putDelete(self: pysharkbite.Mutation, arg0: str, arg1: str, arg2: str, arg3: int) -> None

Adds a delete mutation

putDelete(self: pysharkbite.Mutation, arg0: str, arg1: str, arg2: str) -> None

Adds a delete mutation

class pysharkbite.NamespacePermissions¶

Members:

READ : Enables read permission on the namespace

WRITE : Enables write permission on the namespace

ALTER_NAMESPACE : Enables the alter namespace permissions for the user

GRANT : Enables grant permission on the namespace

ALTER_TABLE : Enables alter table permissions on the namespace

CREATE_TABLE : Enables create table permissions on the namespace

DROP_TABLE : Enables drop table permissions on the namespace

BULK_IMPORT : Enables bulk import permissions on the namespace

DROP_NAMESPACE : Enables drop namespace permissions on the namespace

ALTER_NAMESPACE = NamespacePermissions.ALTER_NAMESPACE¶

ALTER_TABLE = NamespacePermissions.ALTER_TABLE¶

BULK_IMPORT = NamespacePermissions.BULK_IMPORT¶

CREATE_TABLE = NamespacePermissions.CREATE_TABLE¶

DROP_NAMESPACE = NamespacePermissions.DROP_NAMESPACE¶

DROP_TABLE = NamespacePermissions.DROP_TABLE¶

GRANT = NamespacePermissions.GRANT¶

READ = NamespacePermissions.READ¶

WRITE = NamespacePermissions.WRITE¶

__entries = {'ALTER_NAMESPACE': (NamespacePermissions.ALTER_NAMESPACE, 'Enables the alter namespace permissions for the user'), 'ALTER_TABLE': (NamespacePermissions.ALTER_TABLE, 'Enables alter table permissions on the namespace'), 'BULK_IMPORT': (NamespacePermissions.BULK_IMPORT, 'Enables bulk import permissions on the namespace'), 'CREATE_TABLE': (NamespacePermissions.CREATE_TABLE, 'Enables create table permissions on the namespace'), 'DROP_NAMESPACE': (NamespacePermissions.DROP_NAMESPACE, 'Enables drop namespace permissions on the namespace'), 'DROP_TABLE': (NamespacePermissions.DROP_TABLE, 'Enables drop table permissions on the namespace'), 'GRANT': (NamespacePermissions.GRANT, 'Enables grant permission on the namespace'), 'READ': (NamespacePermissions.READ, 'Enables read permission on the namespace'), 'WRITE': (NamespacePermissions.WRITE, 'Enables write permission on the namespace')}¶

property name¶: (self: handle) -> str

class pysharkbite.PythonIterator¶

Defines a python iterator

getClass(self: pysharkbite.PythonIterator) → str¶: Get the class for this iterator

getName(self: pysharkbite.PythonIterator) → str¶: Get the name of this iterator

getPriority(self: pysharkbite.PythonIterator) → int¶: Get the priority for this iterator

onNext(self: pysharkbite.PythonIterator, arg0: str) → pysharkbite.PythonIterator ¶: Lambda that is provided the accumulo key

class pysharkbite.RFile¶

RFile, which is an internal data structure for storing data within Accumulo

close(self: pysharkbite.RFile) → None¶: Closes the RFile

getTop(self: pysharkbite.RFile) → pysharkbite.KeyValue ¶: Returns the top key/value

hasNext(self: pysharkbite.RFile) → bool¶: Returns true of further keys exist, false otherwise

next(self: pysharkbite.RFile) → None¶: Queues the next key/value pair

seek(self: pysharkbite.RFile, arg0: cclient::data::streams::StreamRelocation) → None¶: Seek to data

class pysharkbite.RFileOperations¶

RFile Operations

openForWrite(self: str) → pysharkbite.SequentialRFile ¶: Opens an RFile to write

openManySequential(self: List[str], arg0: int) → pysharkbite.KeyValueIterator ¶: Opens many RFiles sequentially.

randomSeek(self: str) → pysharkbite.RFile ¶: Opens a single RFile to read, best used for random seeks

sequentialRead(self: str) → pysharkbite.SequentialRFile ¶: Opens an RFile to read sequentially

class pysharkbite.Range¶

after_end_key(self: pysharkbite.Range, arg0: pysharkbite.Key) → bool¶: Returns true if the provided key is after this range’s end key

before_start_key(self: pysharkbite.Range, arg0: pysharkbite.Key) → bool¶: Returns true if the provided key is before this range’s start key

get_start_key(self: pysharkbite.Range) → pysharkbite.Key ¶: Returns the start key of this range, if it exists

get_stop_key(self: pysharkbite.Range) → pysharkbite.Key ¶: Returns the stop key of this range, if it exists

inifinite_start_key(self: pysharkbite.Range) → bool¶: Returns true if the start key is inclusive

inifinite_stop_key(self: pysharkbite.Range) → bool¶: Returns true if the stop key is inclusive

start_key_inclusive(self: pysharkbite.Range) → bool¶: Returns true if the start key is inclusive

stop_key_inclusive(self: pysharkbite.Range) → bool¶: Returns true if the stop key is inclusive

class pysharkbite.RecoveryStatus¶

getName(self: pysharkbite.RecoveryStatus) → str¶: Gets the name of the recovery.

getProgress(self: pysharkbite.RecoveryStatus) → float¶: Gets the progress of the recovery.

getRuntime(self: pysharkbite.RecoveryStatus) → int¶: Gets the runtime of the recovery process.

property name¶

property progress¶

property runtime¶

class pysharkbite.Results¶

class pysharkbite.ScannerOptions¶

Members:

HedgedReads : Enables hedged reads

RFileScanOnly : Enables the RFile Scanner

HedgedReads = ScannerOptions.HedgedReads¶

RFileScanOnly = ScannerOptions.RFileScanOnly¶

__entries = {'HedgedReads': (ScannerOptions.HedgedReads, 'Enables hedged reads'), 'RFileScanOnly': (ScannerOptions.RFileScanOnly, 'Enables the RFile Scanner')}¶

property name¶: (self: handle) -> str

class pysharkbite.SecurityOperations¶

Basic security operations

change_password(self: pysharkbite.SecurityOperations, arg0: str, arg1: str) → int¶: Changes the user password

create_user(self: pysharkbite.SecurityOperations, arg0: str, arg1: str) → int¶: Creates a user

get_auths(self: pysharkbite.SecurityOperations, arg0: str) → pysharkbite.Authorizations ¶: Returns the user’s authorizations

grantAuthorizations(self: pysharkbite.SecurityOperations, arg0: pysharkbite.Authorizations, arg1: str) → int¶: Get user authorizations

grant_namespace_permission(self: pysharkbite.SecurityOperations, arg0: str, arg1: str, arg2: pysharkbite.NamespacePermissions) → int¶: Grants a namespace permission

grant_system_permission(self: pysharkbite.SecurityOperations, arg0: str, arg1: pysharkbite.SystemPermissions) → int¶: Grants a system permission

grant_table_permission(self: pysharkbite.SecurityOperations, arg0: str, arg1: str, arg2: pysharkbite.TablePermissions) → int¶: Grants a table permission

has_namespace_permission(self: pysharkbite.SecurityOperations, arg0: str, arg1: str, arg2: pysharkbite.NamespacePermissions) → bool¶: Has namespace permission

has_system_permission(self: pysharkbite.SecurityOperations, arg0: str, arg1: pysharkbite.SystemPermissions) → bool¶: Returns true if the user has the system permission

has_table_permission(self: pysharkbite.SecurityOperations, arg0: str, arg1: str, arg2: pysharkbite.TablePermissions) → bool¶: Has table permission

remove_user(self: pysharkbite.SecurityOperations, arg0: str) → int¶: Removes the user

revoke_namespace_permission(self: pysharkbite.SecurityOperations, arg0: str, arg1: str, arg2: pysharkbite.NamespacePermissions) → int¶: Revokes a namespace permission

revoke_system_permission(self: pysharkbite.SecurityOperations, arg0: str, arg1: pysharkbite.SystemPermissions) → int¶: Revokes a system permission

revoke_table_permission(self: pysharkbite.SecurityOperations, arg0: str, arg1: str, arg2: pysharkbite.TablePermissions) → int¶: Revokes a table permission

class pysharkbite.Seekable¶

getColumnFamilies(self: pysharkbite.Seekable) → List[str]¶: Gets the column families for this seekable

getRange(self: pysharkbite.Seekable) → pysharkbite.Range ¶: Gets this seekable range

isInclusive(self: pysharkbite.Seekable) → bool¶: Returns true if the column families are inclusive.

class pysharkbite.SequentialRFile¶

Specializd RFile, which is an internal data structure for storing data within Accumulo, to be used when much of the data is similar

addLocalityGroup(self: pysharkbite.SequentialRFile, arg0: str) → None¶: Adds a locality group to an RFile when writing

append(self: pysharkbite.SequentialRFile, arg0: pysharkbite.KeyValue) → bool¶: Appends a key and value pair to the RFile

close(self: pysharkbite.SequentialRFile) → None¶: Closes the RFile

getTop(self: pysharkbite.SequentialRFile) → pysharkbite.KeyValue ¶: Returns the top key/value

hasNext(self: pysharkbite.SequentialRFile) → bool¶: Returns true of further keys exist, false otherwise

next(self: pysharkbite.SequentialRFile) → None¶: Queues the next key/value pair

seek(self: pysharkbite.SequentialRFile, arg0: cclient::data::streams::StreamRelocation) → None¶: Seeks to the next key and value within the RFile

class pysharkbite.StreamRelocation¶

class pysharkbite.SystemPermissions¶

Members:

GRANT : Enables grant permission on the system

CREATE_TABLE : Enables create table permissions on the system

DROP_TABLE : Enables drop table permissions on the system

ALTER_TABLE : Enables alter table permissions on the system

CREATE_USER : Enables create user permissions on the system

ALTER_USER : Enables alter user permissions on the system

SYSTEM : Enables system permissions for the user

CREATE_NAMESPACE : Enables create namespace permissions for the user

DROP_NAMESPACE : Enables drop namespace permissions for the user

ALTER_NAMESPACE : Enables the alter namespace permissions for the user

ALTER_NAMESPACE = SystemPermissions.ALTER_NAMESPACE¶

ALTER_TABLE = SystemPermissions.ALTER_TABLE¶

ALTER_USER = SystemPermissions.ALTER_USER¶

CREATE_NAMESPACE = SystemPermissions.CREATE_NAMESPACE¶

CREATE_TABLE = SystemPermissions.CREATE_TABLE¶

CREATE_USER = SystemPermissions.CREATE_USER¶

DROP_NAMESPACE = SystemPermissions.DROP_NAMESPACE¶

DROP_TABLE = SystemPermissions.DROP_TABLE¶

GRANT = SystemPermissions.GRANT¶

SYSTEM = SystemPermissions.SYSTEM¶

__entries = {'ALTER_NAMESPACE': (SystemPermissions.ALTER_NAMESPACE, 'Enables the alter namespace permissions for the user'), 'ALTER_TABLE': (SystemPermissions.ALTER_TABLE, 'Enables alter table permissions on the system'), 'ALTER_USER': (SystemPermissions.ALTER_USER, 'Enables alter user permissions on the system'), 'CREATE_NAMESPACE': (SystemPermissions.CREATE_NAMESPACE, 'Enables create namespace permissions for the user'), 'CREATE_TABLE': (SystemPermissions.CREATE_TABLE, 'Enables create table permissions on the system'), 'CREATE_USER': (SystemPermissions.CREATE_USER, 'Enables create user permissions on the system'), 'DROP_NAMESPACE': (SystemPermissions.DROP_NAMESPACE, 'Enables drop namespace permissions for the user'), 'DROP_TABLE': (SystemPermissions.DROP_TABLE, 'Enables drop table permissions on the system'), 'GRANT': (SystemPermissions.GRANT, 'Enables grant permission on the system'), 'SYSTEM': (SystemPermissions.SYSTEM, 'Enables system permissions for the user')}¶

property name¶: (self: handle) -> str

exception pysharkbite.TApplicationException¶

class pysharkbite.TableCompactions¶

getMajorCompactions(self: pysharkbite.TableCompactions) → pysharkbite.Compacting ¶: Gets major compaction stats.

getMinorCompactions(self: pysharkbite.TableCompactions) → pysharkbite.Compacting ¶: Gets minor compaction stats.

getScans(self: pysharkbite.TableCompactions) → pysharkbite.Compacting ¶: Gets scan stats.

property majors¶

property minors¶

property scans¶

class pysharkbite.TableInfo¶

property compaction_info¶

getCompactioninfo(self: pysharkbite.TableInfo) → pysharkbite.TableCompactions ¶: Gets compaction info for the table

getOnlineTablets(self: pysharkbite.TableInfo) → int¶: Gets online tablets in the table

getRecords(self: pysharkbite.TableInfo) → int¶: Gets records in the table

getRecordsInMemory(self: pysharkbite.TableInfo) → int¶: Gets records in memory for a table

getTableRates(self: pysharkbite.TableInfo) → pysharkbite.TableRates ¶: Gets table rates for the table

getTablets(self: pysharkbite.TableInfo) → int¶: Gets tablets in the table

property online_tables¶

property records¶

property records_in_memory¶

property table_rates¶

property tablets¶

class pysharkbite.TablePermissions¶

Members:

READ : Enables read permission on the table

WRITE : Enables write permission on the table

GRANT : Enables grant permission on the table

ALTER_TABLE : Enables alter table permissions on the table

DROP_TABLE : Enables drop table permissions on the table

BULK_IMPORT : Enables bulk import permissions on the table

ALTER_TABLE = TablePermissions.ALTER_TABLE¶

BULK_IMPORT = TablePermissions.BULK_IMPORT¶

DROP_TABLE = TablePermissions.DROP_TABLE¶

GRANT = TablePermissions.GRANT¶

READ = TablePermissions.READ¶

WRITE = TablePermissions.WRITE¶

__entries = {'ALTER_TABLE': (TablePermissions.ALTER_TABLE, 'Enables alter table permissions on the table'), 'BULK_IMPORT': (TablePermissions.BULK_IMPORT, 'Enables bulk import permissions on the table'), 'DROP_TABLE': (TablePermissions.DROP_TABLE, 'Enables drop table permissions on the table'), 'GRANT': (TablePermissions.GRANT, 'Enables grant permission on the table'), 'READ': (TablePermissions.READ, 'Enables read permission on the table'), 'WRITE': (TablePermissions.WRITE, 'Enables write permission on the table')}¶

property name¶: (self: handle) -> str

class pysharkbite.TableRates¶

getIngestRate(self: pysharkbite.TableRates) → float¶: Gets the ingest rate in records.

getIngestRateByte(self: pysharkbite.TableRates) → float¶: Gets the ingest rate in bytes.

getQueryRate(self: pysharkbite.TableRates) → float¶: Gets the query rate in records.

getQueryRateByte(self: pysharkbite.TableRates) → float¶: Gets the query rate in bytes.

getScanRate(self: pysharkbite.TableRates) → float¶: Gets the scan rate.

property query_rate_byte¶

property scan_rate¶

class pysharkbite.TabletServerStatus¶

property data_cache_hits¶

property data_cache_requests¶

property flushes¶

getDataCacheHits(self: pysharkbite.TabletServerStatus) → int¶: Gets data cache hits against the server

getDataCacheRequests(self: pysharkbite.TabletServerStatus) → int¶: Gets data cache requests against the server

getFlushes(self: pysharkbite.TabletServerStatus) → int¶: Gets the number of flushes on the server

getHoldTime(self: pysharkbite.TabletServerStatus) → int¶: Gets the hold time

getIndexCacheHits(self: pysharkbite.TabletServerStatus) → int¶: Gets index cache hits against the server

getLastContact(self: pysharkbite.TabletServerStatus) → int¶: Gets the last contact time of the server

getLogSorts(self: pysharkbite.TabletServerStatus) → List[pysharkbite.RecoveryStatus]¶: Gets the number of log sorts

getLookups(self: pysharkbite.TabletServerStatus) → int¶: Gets lookups against the server

getName(self: pysharkbite.TabletServerStatus) → str¶: Gets the name of the server

getOsLoad(self: pysharkbite.TabletServerStatus) → float¶: Gets the load of the server

getSyncs(self: pysharkbite.TabletServerStatus) → int¶: Gets the number of syncs on the server

getTableMap(self: pysharkbite.TabletServerStatus) → Dict[str, pysharkbite.TableInfo]¶: Gets the table map

property hold_time¶

property index_cache_hits¶

property last_contact¶

property log_sorts¶

property lookups¶

property name¶

property os_load¶

property syncs¶

property table_map¶

class pysharkbite.Value¶

Accumulo value

get(self: pysharkbite.Value) → str¶: Returns the value as a UTF-8 string

get_bytes(self: pysharkbite.Value) → bytes¶: Returns the bytes as python bytes

class pysharkbite.ZookeeperInstance¶

Zookeeper instance enables connectivity to a zookeper quorum

getInstanceId(self: pysharkbite.ZookeeperInstance, retry: bool = False) → str¶

getInstanceName(self: pysharkbite.ZookeeperInstance) → str¶