module documentation

Holds all tabling functionality for hbspark, including creating, deletion, querying, and modifications.
Class Table Represents the instance of the HBase table.
Function create_table Create a new table inside HBase.
Function delete_table Deletes an existing table from the HBase connection.
Function families Get all of the families for a specific HBase table.
Function get_or_create_table Gets the table provided by table_name or creates a new one with the provided column families from families.
Function has_table Determine if the HBase connection contains the specified tablename.
Function table Get an instance of a specific table that can have queries performed on it.
Function tables Get all of the tables at the initialized HBase connection.
def create_table(name, families):
Create a new table inside HBase.
Parameters
name:stringThe new table's name.
families:dict : (string -> dict: (attr -> val))dict of column family names to the column settings.
Returns
hbspark.table.TableAn instance of the newly created table
def delete_table(name, disabled=False):
Deletes an existing table from the HBase connection.
Parameters
name:stringThe name of the table that is to be deleted.
disabled:boolWhether or not tables should only be deleted if they are disabled in hbase (False), or if any table regardless of status can be deleted (True) .
Returns
NoneNo return
def families(table_name):
Get all of the families for a specific HBase table.
Parameters
table_name:stringThe name of the HBase table.
Returns
dict : (string -> dict: (attr -> val))dict of column family names to the column family's HBase attributes.
def get_or_create_table(table_name, families):
Gets the table provided by table_name or creates a new one with the provided column families from families.
Parameters
table_name:stringThe name of the HBase table.
families:dict : (string -> dict: (attr -> val))dict of column family names to the column settings.
Returns
hbspark.table.TableAn instance of the provided table_name either newly created or not.
def has_table(table_name):
Determine if the HBase connection contains the specified tablename.
Parameters
table_name:stringThe name for the table to be checked.
Returns
boolTrue if the connection contains table_name, false otherwise.
def table(table_name):
Get an instance of a specific table that can have queries performed on it.
Parameters
table_name:stringThe name for the table to be returned.
Returns
hbspark.table.TableThe table instance, permitting various querying and modification operations.
def tables():
Get all of the tables at the initialized HBase connection.
Returns
list of stringA list of the string names of the tables stored at the HBase connection hbspark._hb_session.conn