org.apache.blur.thrift.generated
Class Blur.Client

java.lang.Object
  extended by org.apache.blur.thirdparty.thrift_0_9_0.TServiceClient
      extended by org.apache.blur.thrift.generated.Blur.Client
All Implemented Interfaces:
Blur.Iface
Direct Known Subclasses:
SafeClientGen
Enclosing class:
Blur

public static class Blur.Client
extends TServiceClient
implements Blur.Iface


Nested Class Summary
static class Blur.Client.Factory
           
 
Constructor Summary
Blur.Client(TProtocol prot)
           
Blur.Client(TProtocol iprot, TProtocol oprot)
           
 
Method Summary
 boolean addColumnDefinition(String table, ColumnDefinition columnDefinition)
          Attempts to add a column definition to the given table.
 void cancelQuery(String table, String uuid)
          Cancels a query that is executing against the given table with the given uuid.
 Map<String,String> configuration()
          Fetches the Blur configuration.
 List<String> controllerServerList()
          Returns a list of all the controller servers.
 void createSnapshot(String table, String name)
          Creates a snapshot for the table with the given name
 void createTable(TableDescriptor tableDescriptor)
          Creates a table with the given TableDescriptor.
 TableDescriptor describe(String table)
          Returns a table descriptor for the given table.
 void disableTable(String table)
          Disables the given table, blocking until all shards are offline.
 void enableTable(String table)
          Enables the given table, blocking until all shards are online.
 void enqueueMutate(RowMutation mutation)
          Enqueue a RowMutation.
 void enqueueMutateBatch(List<RowMutation> mutations)
          Enqueue a batch of RowMutations.
 FetchResult fetchRow(String table, Selector selector)
          Fetches a Row or a Record in the given table with the given Selector.
 List<FetchResult> fetchRowBatch(String table, List<Selector> selectors)
          Fetches a batch of Rows or Records in the given table with the given Selector list.
 boolean isInSafeMode(String cluster)
          Checks to see if the given cluster is in safemode.
 Map<String,List<String>> listSnapshots(String table)
          Returns a map where the key is the shard, and the list is the snapshots within that shard
 void logging(String classNameOrLoggerName, Level level)
          Changes the logging level for the given instance dynamically at runtime.
 Map<String,Metric> metrics(Set<String> metrics)
          Fetches the Blur metrics by name.
 void mutate(RowMutation mutation)
          Mutates a Row given the RowMutation that is provided.
 void mutateBatch(List<RowMutation> mutations)
          Mutates a group of Rows given the list of RowMutations that are provided.
 void optimize(String table, int numberOfSegmentsPerShard)
          Will perform a forced optimize on the index in the given table.
 String parseQuery(String table, Query query)
          Parses the given query and returns the string that represents the query.
 void ping()
          A way to ping a server to make sure the connection is still valid.
 BlurResults query(String table, BlurQuery blurQuery)
          Executes a query against a the given table and returns the results.
 BlurQueryStatus queryStatusById(String table, String uuid)
          Returns the query status for the given table and query uuid.
 List<String> queryStatusIdList(String table)
          Returns a list of the query ids of queries that have recently been executed for the given table.
 long recordFrequency(String table, String columnFamily, String columnName, String value)
          Gets the record frequency for the provided table, family, column and value.
 boolean recv_addColumnDefinition()
           
 void recv_cancelQuery()
           
 Map<String,String> recv_configuration()
           
 List<String> recv_controllerServerList()
           
 void recv_createSnapshot()
           
 void recv_createTable()
           
 TableDescriptor recv_describe()
           
 void recv_disableTable()
           
 void recv_enableTable()
           
 void recv_enqueueMutate()
           
 void recv_enqueueMutateBatch()
           
 FetchResult recv_fetchRow()
           
 List<FetchResult> recv_fetchRowBatch()
           
 boolean recv_isInSafeMode()
           
 Map<String,List<String>> recv_listSnapshots()
           
 void recv_logging()
           
 Map<String,Metric> recv_metrics()
           
 void recv_mutate()
           
 void recv_mutateBatch()
           
 void recv_optimize()
           
 String recv_parseQuery()
           
 void recv_ping()
           
 BlurResults recv_query()
           
 BlurQueryStatus recv_queryStatusById()
           
 List<String> recv_queryStatusIdList()
           
 long recv_recordFrequency()
           
 void recv_removeSnapshot()
           
 void recv_removeTable()
           
 void recv_resetLogging()
           
 Schema recv_schema()
           
 List<String> recv_shardClusterList()
           
 Map<String,String> recv_shardServerLayout()
           
 Map<String,Map<String,ShardState>> recv_shardServerLayoutState()
           
 List<String> recv_shardServerList()
           
 List<String> recv_tableList()
           
 List<String> recv_tableListByCluster()
           
 TableStats recv_tableStats()
           
 List<String> recv_terms()
           
 List<String> recv_traceList()
           
 void recv_traceRemove()
           
 String recv_traceRequestFetch()
           
 List<String> recv_traceRequestList()
           
 void removeSnapshot(String table, String name)
          Removes a previous snapshot(identified by name) of the table
 void removeTable(String table, boolean deleteIndexFiles)
          Removes the given table, with an optional to delete the underlying index storage as well.
 void resetLogging()
          Resets the logging for this instance to match the log4j file.
 Schema schema(String table)
          Gets the schema for a given table.
 void send_addColumnDefinition(String table, ColumnDefinition columnDefinition)
           
 void send_cancelQuery(String table, String uuid)
           
 void send_configuration()
           
 void send_controllerServerList()
           
 void send_createSnapshot(String table, String name)
           
 void send_createTable(TableDescriptor tableDescriptor)
           
 void send_describe(String table)
           
 void send_disableTable(String table)
           
 void send_enableTable(String table)
           
 void send_enqueueMutate(RowMutation mutation)
           
 void send_enqueueMutateBatch(List<RowMutation> mutations)
           
 void send_fetchRow(String table, Selector selector)
           
 void send_fetchRowBatch(String table, List<Selector> selectors)
           
 void send_isInSafeMode(String cluster)
           
 void send_listSnapshots(String table)
           
 void send_logging(String classNameOrLoggerName, Level level)
           
 void send_metrics(Set<String> metrics)
           
 void send_mutate(RowMutation mutation)
           
 void send_mutateBatch(List<RowMutation> mutations)
           
 void send_optimize(String table, int numberOfSegmentsPerShard)
           
 void send_parseQuery(String table, Query query)
           
 void send_ping()
           
 void send_query(String table, BlurQuery blurQuery)
           
 void send_queryStatusById(String table, String uuid)
           
 void send_queryStatusIdList(String table)
           
 void send_recordFrequency(String table, String columnFamily, String columnName, String value)
           
 void send_removeSnapshot(String table, String name)
           
 void send_removeTable(String table, boolean deleteIndexFiles)
           
 void send_resetLogging()
           
 void send_schema(String table)
           
 void send_setUser(User user)
           
 void send_shardClusterList()
           
 void send_shardServerLayout(String table)
           
 void send_shardServerLayoutState(String table)
           
 void send_shardServerList(String cluster)
           
 void send_startTrace(String traceId, String requestId)
           
 void send_tableList()
           
 void send_tableListByCluster(String cluster)
           
 void send_tableStats(String table)
           
 void send_terms(String table, String columnFamily, String columnName, String startWith, short size)
           
 void send_traceList()
           
 void send_traceRemove(String traceId)
           
 void send_traceRequestFetch(String traceId, String requestId)
           
 void send_traceRequestList(String traceId)
           
 void setUser(User user)
          Sets the User for the current session.
 List<String> shardClusterList()
          Returns a list of all the shard clusters.
 Map<String,String> shardServerLayout(String table)
          Returns a map of the layout of the given table, where the key is the shard name and the value is the shard server.

This method will return the "correct" layout for the given shard, or the "correct" layout of cluster if called on a controller.

The meaning of correct:
Given the current state of the shard cluster with failures taken into account, the correct layout is what the layout should be given the current state.
 Map<String,Map<String,ShardState>> shardServerLayoutState(String table)
          Returns a map of the layout of the given table, where the key is the shard name and the value is the shard server.

This method will return immediately with what shards are currently open in the shard server.
 List<String> shardServerList(String cluster)
          Returns a list of all the shard servers for the given cluster.
 void startTrace(String traceId, String requestId)
          Starts a trace with the given trace id.
 List<String> tableList()
          Returns a list of the table names across all shard clusters.
 List<String> tableListByCluster(String cluster)
          Returns a list of the table names for the given cluster.
 TableStats tableStats(String table)
          Gets the table stats for the given table.
 List<String> terms(String table, String columnFamily, String columnName, String startWith, short size)
          Gets the terms list from the index for the given table, family, column using the startWith value to page through the results.
 List<String> traceList()
          Get a list of all the traces.
 void traceRemove(String traceId)
          Remove the trace for the given trace id.
 String traceRequestFetch(String traceId, String requestId)
          Fetches the given trace.
 List<String> traceRequestList(String traceId)
          Gets a request list for the given trace.
 
Methods inherited from class org.apache.blur.thirdparty.thrift_0_9_0.TServiceClient
getInputProtocol, getOutputProtocol
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Blur.Client

public Blur.Client(TProtocol prot)

Blur.Client

public Blur.Client(TProtocol iprot,
                   TProtocol oprot)
Method Detail

createTable

public void createTable(TableDescriptor tableDescriptor)
                 throws BlurException,
                        TException
Description copied from interface: Blur.Iface
Creates a table with the given TableDescriptor.

Specified by:
createTable in interface Blur.Iface
Parameters:
tableDescriptor - the TableDescriptor.
Throws:
BlurException
TException

send_createTable

public void send_createTable(TableDescriptor tableDescriptor)
                      throws TException
Throws:
TException

recv_createTable

public void recv_createTable()
                      throws BlurException,
                             TException
Throws:
BlurException
TException

enableTable

public void enableTable(String table)
                 throws BlurException,
                        TException
Description copied from interface: Blur.Iface
Enables the given table, blocking until all shards are online.

Specified by:
enableTable in interface Blur.Iface
Parameters:
table - the table name.
Throws:
BlurException
TException

send_enableTable

public void send_enableTable(String table)
                      throws TException
Throws:
TException

recv_enableTable

public void recv_enableTable()
                      throws BlurException,
                             TException
Throws:
BlurException
TException

disableTable

public void disableTable(String table)
                  throws BlurException,
                         TException
Description copied from interface: Blur.Iface
Disables the given table, blocking until all shards are offline.

Specified by:
disableTable in interface Blur.Iface
Parameters:
table - the table name.
Throws:
BlurException
TException

send_disableTable

public void send_disableTable(String table)
                       throws TException
Throws:
TException

recv_disableTable

public void recv_disableTable()
                       throws BlurException,
                              TException
Throws:
BlurException
TException

removeTable

public void removeTable(String table,
                        boolean deleteIndexFiles)
                 throws BlurException,
                        TException
Description copied from interface: Blur.Iface
Removes the given table, with an optional to delete the underlying index storage as well.

Specified by:
removeTable in interface Blur.Iface
Parameters:
table - the table name.
deleteIndexFiles - true to remove the index storage and false if to preserve.
Throws:
BlurException
TException

send_removeTable

public void send_removeTable(String table,
                             boolean deleteIndexFiles)
                      throws TException
Throws:
TException

recv_removeTable

public void recv_removeTable()
                      throws BlurException,
                             TException
Throws:
BlurException
TException

addColumnDefinition

public boolean addColumnDefinition(String table,
                                   ColumnDefinition columnDefinition)
                            throws BlurException,
                                   TException
Description copied from interface: Blur.Iface
Attempts to add a column definition to the given table.

Specified by:
addColumnDefinition in interface Blur.Iface
Parameters:
table - the name of the table.
columnDefinition - the ColumnDefinition.
Returns:
true if successfully defined false if not.
Throws:
BlurException
TException

send_addColumnDefinition

public void send_addColumnDefinition(String table,
                                     ColumnDefinition columnDefinition)
                              throws TException
Throws:
TException

recv_addColumnDefinition

public boolean recv_addColumnDefinition()
                                 throws BlurException,
                                        TException
Throws:
BlurException
TException

tableList

public List<String> tableList()
                       throws BlurException,
                              TException
Description copied from interface: Blur.Iface
Returns a list of the table names across all shard clusters.

Specified by:
tableList in interface Blur.Iface
Returns:
list of all tables in all shard clusters.
Throws:
BlurException
TException

send_tableList

public void send_tableList()
                    throws TException
Throws:
TException

recv_tableList

public List<String> recv_tableList()
                            throws BlurException,
                                   TException
Throws:
BlurException
TException

tableListByCluster

public List<String> tableListByCluster(String cluster)
                                throws BlurException,
                                       TException
Description copied from interface: Blur.Iface
Returns a list of the table names for the given cluster.

Specified by:
tableListByCluster in interface Blur.Iface
Parameters:
cluster - the cluster name.
Returns:
list of all the tables within the given shard cluster.
Throws:
BlurException
TException

send_tableListByCluster

public void send_tableListByCluster(String cluster)
                             throws TException
Throws:
TException

recv_tableListByCluster

public List<String> recv_tableListByCluster()
                                     throws BlurException,
                                            TException
Throws:
BlurException
TException

describe

public TableDescriptor describe(String table)
                         throws BlurException,
                                TException
Description copied from interface: Blur.Iface
Returns a table descriptor for the given table.

Specified by:
describe in interface Blur.Iface
Parameters:
table - the table name.
Returns:
the TableDescriptor.
Throws:
BlurException
TException

send_describe

public void send_describe(String table)
                   throws TException
Throws:
TException

recv_describe

public TableDescriptor recv_describe()
                              throws BlurException,
                                     TException
Throws:
BlurException
TException

schema

public Schema schema(String table)
              throws BlurException,
                     TException
Description copied from interface: Blur.Iface
Gets the schema for a given table.

Specified by:
schema in interface Blur.Iface
Parameters:
table - the table name.
Returns:
Schema.
Throws:
BlurException
TException

send_schema

public void send_schema(String table)
                 throws TException
Throws:
TException

recv_schema

public Schema recv_schema()
                   throws BlurException,
                          TException
Throws:
BlurException
TException

parseQuery

public String parseQuery(String table,
                         Query query)
                  throws BlurException,
                         TException
Description copied from interface: Blur.Iface
Parses the given query and returns the string that represents the query.

Specified by:
parseQuery in interface Blur.Iface
Parameters:
table - the table name.
query - the query to parse.
Returns:
string representation of the parsed query.
Throws:
BlurException
TException

send_parseQuery

public void send_parseQuery(String table,
                            Query query)
                     throws TException
Throws:
TException

recv_parseQuery

public String recv_parseQuery()
                       throws BlurException,
                              TException
Throws:
BlurException
TException

tableStats

public TableStats tableStats(String table)
                      throws BlurException,
                             TException
Description copied from interface: Blur.Iface
Gets the table stats for the given table.

Specified by:
tableStats in interface Blur.Iface
Parameters:
table - the table name.
Returns:
TableStats.
Throws:
BlurException
TException

send_tableStats

public void send_tableStats(String table)
                     throws TException
Throws:
TException

recv_tableStats

public TableStats recv_tableStats()
                           throws BlurException,
                                  TException
Throws:
BlurException
TException

optimize

public void optimize(String table,
                     int numberOfSegmentsPerShard)
              throws BlurException,
                     TException
Description copied from interface: Blur.Iface
Will perform a forced optimize on the index in the given table.

Specified by:
optimize in interface Blur.Iface
Parameters:
table - table the name of the table.
numberOfSegmentsPerShard - the maximum of segments per shard index after the operation is completed.
Throws:
BlurException
TException

send_optimize

public void send_optimize(String table,
                          int numberOfSegmentsPerShard)
                   throws TException
Throws:
TException

recv_optimize

public void recv_optimize()
                   throws BlurException,
                          TException
Throws:
BlurException
TException

createSnapshot

public void createSnapshot(String table,
                           String name)
                    throws BlurException,
                           TException
Description copied from interface: Blur.Iface
Creates a snapshot for the table with the given name

Specified by:
createSnapshot in interface Blur.Iface
Throws:
BlurException
TException

send_createSnapshot

public void send_createSnapshot(String table,
                                String name)
                         throws TException
Throws:
TException

recv_createSnapshot

public void recv_createSnapshot()
                         throws BlurException,
                                TException
Throws:
BlurException
TException

removeSnapshot

public void removeSnapshot(String table,
                           String name)
                    throws BlurException,
                           TException
Description copied from interface: Blur.Iface
Removes a previous snapshot(identified by name) of the table

Specified by:
removeSnapshot in interface Blur.Iface
Throws:
BlurException
TException

send_removeSnapshot

public void send_removeSnapshot(String table,
                                String name)
                         throws TException
Throws:
TException

recv_removeSnapshot

public void recv_removeSnapshot()
                         throws BlurException,
                                TException
Throws:
BlurException
TException

listSnapshots

public Map<String,List<String>> listSnapshots(String table)
                                       throws BlurException,
                                              TException
Description copied from interface: Blur.Iface
Returns a map where the key is the shard, and the list is the snapshots within that shard

Specified by:
listSnapshots in interface Blur.Iface
Throws:
BlurException
TException

send_listSnapshots

public void send_listSnapshots(String table)
                        throws TException
Throws:
TException

recv_listSnapshots

public Map<String,List<String>> recv_listSnapshots()
                                            throws BlurException,
                                                   TException
Throws:
BlurException
TException

setUser

public void setUser(User user)
             throws TException
Description copied from interface: Blur.Iface
Sets the User for the current session.

Specified by:
setUser in interface Blur.Iface
Parameters:
user - the User object.
Throws:
TException

send_setUser

public void send_setUser(User user)
                  throws TException
Throws:
TException

query

public BlurResults query(String table,
                         BlurQuery blurQuery)
                  throws BlurException,
                         TException
Description copied from interface: Blur.Iface
Executes a query against a the given table and returns the results. If this method is executed against a controller the results will contain the aggregated results from all the shards. If this method is executed against a shard server the results will only contain aggregated results from the shards of the given table that are being served on the shard server, if any.

Specified by:
query in interface Blur.Iface
Parameters:
table - the table name.
blurQuery - the query to execute.
Returns:
the BlurResults.
Throws:
BlurException
TException

send_query

public void send_query(String table,
                       BlurQuery blurQuery)
                throws TException
Throws:
TException

recv_query

public BlurResults recv_query()
                       throws BlurException,
                              TException
Throws:
BlurException
TException

fetchRow

public FetchResult fetchRow(String table,
                            Selector selector)
                     throws BlurException,
                            TException
Description copied from interface: Blur.Iface
Fetches a Row or a Record in the given table with the given Selector.

Specified by:
fetchRow in interface Blur.Iface
Parameters:
table - the table name.
selector - the Selector to use to fetch the Row or Record.
Returns:
the FetchResult.
Throws:
BlurException
TException

send_fetchRow

public void send_fetchRow(String table,
                          Selector selector)
                   throws TException
Throws:
TException

recv_fetchRow

public FetchResult recv_fetchRow()
                          throws BlurException,
                                 TException
Throws:
BlurException
TException

fetchRowBatch

public List<FetchResult> fetchRowBatch(String table,
                                       List<Selector> selectors)
                                throws BlurException,
                                       TException
Description copied from interface: Blur.Iface
Fetches a batch of Rows or Records in the given table with the given Selector list.

Specified by:
fetchRowBatch in interface Blur.Iface
Parameters:
table - the table name.
selectors - the Selector to use to fetch the Row or Record.
Returns:
the FetchResult.
Throws:
BlurException
TException

send_fetchRowBatch

public void send_fetchRowBatch(String table,
                               List<Selector> selectors)
                        throws TException
Throws:
TException

recv_fetchRowBatch

public List<FetchResult> recv_fetchRowBatch()
                                     throws BlurException,
                                            TException
Throws:
BlurException
TException

mutate

public void mutate(RowMutation mutation)
            throws BlurException,
                   TException
Description copied from interface: Blur.Iface
Mutates a Row given the RowMutation that is provided.

Specified by:
mutate in interface Blur.Iface
Parameters:
mutation - the RowMutation.
Throws:
BlurException
TException

send_mutate

public void send_mutate(RowMutation mutation)
                 throws TException
Throws:
TException

recv_mutate

public void recv_mutate()
                 throws BlurException,
                        TException
Throws:
BlurException
TException

enqueueMutate

public void enqueueMutate(RowMutation mutation)
                   throws BlurException,
                          TException
Description copied from interface: Blur.Iface
Enqueue a RowMutation. Note that the effect of the RowMutation will occur at some point in the future, volume and load will play a role in how much time will pass before the mutation goes into effect.

Specified by:
enqueueMutate in interface Blur.Iface
Parameters:
mutation - the RowMutation.
Throws:
BlurException
TException

send_enqueueMutate

public void send_enqueueMutate(RowMutation mutation)
                        throws TException
Throws:
TException

recv_enqueueMutate

public void recv_enqueueMutate()
                        throws BlurException,
                               TException
Throws:
BlurException
TException

mutateBatch

public void mutateBatch(List<RowMutation> mutations)
                 throws BlurException,
                        TException
Description copied from interface: Blur.Iface
Mutates a group of Rows given the list of RowMutations that are provided. Note: This is not an atomic operation.

Specified by:
mutateBatch in interface Blur.Iface
Parameters:
mutations - the batch of RowMutations.
Throws:
BlurException
TException

send_mutateBatch

public void send_mutateBatch(List<RowMutation> mutations)
                      throws TException
Throws:
TException

recv_mutateBatch

public void recv_mutateBatch()
                      throws BlurException,
                             TException
Throws:
BlurException
TException

enqueueMutateBatch

public void enqueueMutateBatch(List<RowMutation> mutations)
                        throws BlurException,
                               TException
Description copied from interface: Blur.Iface
Enqueue a batch of RowMutations. Note that the effect of the RowMutation will occur at some point in the future, volume and load will play a role in how much time will pass before the mutation goes into effect.

Specified by:
enqueueMutateBatch in interface Blur.Iface
Parameters:
mutations - the batch of RowMutations.
Throws:
BlurException
TException

send_enqueueMutateBatch

public void send_enqueueMutateBatch(List<RowMutation> mutations)
                             throws TException
Throws:
TException

recv_enqueueMutateBatch

public void recv_enqueueMutateBatch()
                             throws BlurException,
                                    TException
Throws:
BlurException
TException

cancelQuery

public void cancelQuery(String table,
                        String uuid)
                 throws BlurException,
                        TException
Description copied from interface: Blur.Iface
Cancels a query that is executing against the given table with the given uuid. Note, the cancel call maybe take some time for the query actually stops executing.

Specified by:
cancelQuery in interface Blur.Iface
Parameters:
table - the table name.
uuid - the uuid of the query.
Throws:
BlurException
TException

send_cancelQuery

public void send_cancelQuery(String table,
                             String uuid)
                      throws TException
Throws:
TException

recv_cancelQuery

public void recv_cancelQuery()
                      throws BlurException,
                             TException
Throws:
BlurException
TException

queryStatusIdList

public List<String> queryStatusIdList(String table)
                               throws BlurException,
                                      TException
Description copied from interface: Blur.Iface
Returns a list of the query ids of queries that have recently been executed for the given table.

Specified by:
queryStatusIdList in interface Blur.Iface
Parameters:
table - the table name.
Returns:
list of all the uuids of the queries uuids.
Throws:
BlurException
TException

send_queryStatusIdList

public void send_queryStatusIdList(String table)
                            throws TException
Throws:
TException

recv_queryStatusIdList

public List<String> recv_queryStatusIdList()
                                    throws BlurException,
                                           TException
Throws:
BlurException
TException

queryStatusById

public BlurQueryStatus queryStatusById(String table,
                                       String uuid)
                                throws BlurException,
                                       TException
Description copied from interface: Blur.Iface
Returns the query status for the given table and query uuid.

Specified by:
queryStatusById in interface Blur.Iface
Parameters:
table - the table name.
uuid - the uuid of the query.
Returns:
fetches the BlurQueryStatus for the given table and uuid.
Throws:
BlurException
TException

send_queryStatusById

public void send_queryStatusById(String table,
                                 String uuid)
                          throws TException
Throws:
TException

recv_queryStatusById

public BlurQueryStatus recv_queryStatusById()
                                     throws BlurException,
                                            TException
Throws:
BlurException
TException

terms

public List<String> terms(String table,
                          String columnFamily,
                          String columnName,
                          String startWith,
                          short size)
                   throws BlurException,
                          TException
Description copied from interface: Blur.Iface
Gets the terms list from the index for the given table, family, column using the startWith value to page through the results. This method only makes sense to use with string and text field types.

Specified by:
terms in interface Blur.Iface
Parameters:
table - the table name.
columnFamily - the column family. If the frequency requested is a system field like "rowid", "recordid", "family", etc then columnFamily can be null.
columnName - the column name.
startWith - the term to start with assuming that you are paging through the term list.
size - the number to fetch at once.
Returns:
the list of terms for the given column.
Throws:
BlurException
TException

send_terms

public void send_terms(String table,
                       String columnFamily,
                       String columnName,
                       String startWith,
                       short size)
                throws TException
Throws:
TException

recv_terms

public List<String> recv_terms()
                        throws BlurException,
                               TException
Throws:
BlurException
TException

recordFrequency

public long recordFrequency(String table,
                            String columnFamily,
                            String columnName,
                            String value)
                     throws BlurException,
                            TException
Description copied from interface: Blur.Iface
Gets the record frequency for the provided table, family, column and value.

Specified by:
recordFrequency in interface Blur.Iface
Parameters:
table - the table name.
columnFamily - the column family. If the frequency requested is a system field like "rowid", "recordid", "family", etc then columnFamily can be null.
columnName - the column name.
value - the value.
Returns:
the count for the entire table.
Throws:
BlurException
TException

send_recordFrequency

public void send_recordFrequency(String table,
                                 String columnFamily,
                                 String columnName,
                                 String value)
                          throws TException
Throws:
TException

recv_recordFrequency

public long recv_recordFrequency()
                          throws BlurException,
                                 TException
Throws:
BlurException
TException

shardClusterList

public List<String> shardClusterList()
                              throws BlurException,
                                     TException
Description copied from interface: Blur.Iface
Returns a list of all the shard clusters.

Specified by:
shardClusterList in interface Blur.Iface
Returns:
list of all the shard clusters.
Throws:
BlurException
TException

send_shardClusterList

public void send_shardClusterList()
                           throws TException
Throws:
TException

recv_shardClusterList

public List<String> recv_shardClusterList()
                                   throws BlurException,
                                          TException
Throws:
BlurException
TException

shardServerList

public List<String> shardServerList(String cluster)
                             throws BlurException,
                                    TException
Description copied from interface: Blur.Iface
Returns a list of all the shard servers for the given cluster.

Specified by:
shardServerList in interface Blur.Iface
Parameters:
cluster - the cluster name.
Returns:
list of all the shard servers within the cluster.
Throws:
BlurException
TException

send_shardServerList

public void send_shardServerList(String cluster)
                          throws TException
Throws:
TException

recv_shardServerList

public List<String> recv_shardServerList()
                                  throws BlurException,
                                         TException
Throws:
BlurException
TException

controllerServerList

public List<String> controllerServerList()
                                  throws BlurException,
                                         TException
Description copied from interface: Blur.Iface
Returns a list of all the controller servers.

Specified by:
controllerServerList in interface Blur.Iface
Returns:
list of all the controllers.
Throws:
BlurException
TException

send_controllerServerList

public void send_controllerServerList()
                               throws TException
Throws:
TException

recv_controllerServerList

public List<String> recv_controllerServerList()
                                       throws BlurException,
                                              TException
Throws:
BlurException
TException

shardServerLayout

public Map<String,String> shardServerLayout(String table)
                                     throws BlurException,
                                            TException
Description copied from interface: Blur.Iface
Returns a map of the layout of the given table, where the key is the shard name and the value is the shard server.

This method will return the "correct" layout for the given shard, or the "correct" layout of cluster if called on a controller.

The meaning of correct:
Given the current state of the shard cluster with failures taken into account, the correct layout is what the layout should be given the current state. In other words, what the shard server should be serving. The act of calling the shard server layout method with the NORMAL option will block until the layout shard server matches the correct layout. Meaning it will block until indexes that should be open are open and ready for queries. However indexes are lazily closed, so if a table is being disabled then the call will return immediately with an empty map, but the indexes may not be close yet.

Specified by:
shardServerLayout in interface Blur.Iface
Parameters:
table - the table name.
Returns:
map of shards in a table to the shard servers.
Throws:
BlurException
TException

send_shardServerLayout

public void send_shardServerLayout(String table)
                            throws TException
Throws:
TException

recv_shardServerLayout

public Map<String,String> recv_shardServerLayout()
                                          throws BlurException,
                                                 TException
Throws:
BlurException
TException

shardServerLayoutState

public Map<String,Map<String,ShardState>> shardServerLayoutState(String table)
                                                          throws BlurException,
                                                                 TException
Description copied from interface: Blur.Iface
Returns a map of the layout of the given table, where the key is the shard name and the value is the shard server.

This method will return immediately with what shards are currently open in the shard server. So if a shard is being moved to another server and is being closed by this server it WILL be returned in the map. The shardServerLayout method would not return the shard given the same situation.

Specified by:
shardServerLayoutState in interface Blur.Iface
Parameters:
table - the table name.
Returns:
map of shards to a map of shard servers with the state of the shard.
Throws:
BlurException
TException

send_shardServerLayoutState

public void send_shardServerLayoutState(String table)
                                 throws TException
Throws:
TException

recv_shardServerLayoutState

public Map<String,Map<String,ShardState>> recv_shardServerLayoutState()
                                                               throws BlurException,
                                                                      TException
Throws:
BlurException
TException

isInSafeMode

public boolean isInSafeMode(String cluster)
                     throws BlurException,
                            TException
Description copied from interface: Blur.Iface
Checks to see if the given cluster is in safemode.

Specified by:
isInSafeMode in interface Blur.Iface
Parameters:
cluster - the name of the cluster.
Returns:
boolean.
Throws:
BlurException
TException

send_isInSafeMode

public void send_isInSafeMode(String cluster)
                       throws TException
Throws:
TException

recv_isInSafeMode

public boolean recv_isInSafeMode()
                          throws BlurException,
                                 TException
Throws:
BlurException
TException

configuration

public Map<String,String> configuration()
                                 throws BlurException,
                                        TException
Description copied from interface: Blur.Iface
Fetches the Blur configuration.

Specified by:
configuration in interface Blur.Iface
Returns:
Map of property name to value.
Throws:
BlurException
TException

send_configuration

public void send_configuration()
                        throws TException
Throws:
TException

recv_configuration

public Map<String,String> recv_configuration()
                                      throws BlurException,
                                             TException
Throws:
BlurException
TException

metrics

public Map<String,Metric> metrics(Set<String> metrics)
                           throws BlurException,
                                  TException
Description copied from interface: Blur.Iface
Fetches the Blur metrics by name. If the metrics parameter is null all the Metrics are returned.

Specified by:
metrics in interface Blur.Iface
Parameters:
metrics - the names of the metrics to return. If null all are returned.
Returns:
Map of metric name to Metric.
Throws:
BlurException
TException

send_metrics

public void send_metrics(Set<String> metrics)
                  throws TException
Throws:
TException

recv_metrics

public Map<String,Metric> recv_metrics()
                                throws BlurException,
                                       TException
Throws:
BlurException
TException

startTrace

public void startTrace(String traceId,
                       String requestId)
                throws TException
Description copied from interface: Blur.Iface
Starts a trace with the given trace id.

Specified by:
startTrace in interface Blur.Iface
Parameters:
traceId - the trace id.
requestId - the request id, used to connected remote calls together. Client can pass null.
Throws:
TException

send_startTrace

public void send_startTrace(String traceId,
                            String requestId)
                     throws TException
Throws:
TException

traceList

public List<String> traceList()
                       throws BlurException,
                              TException
Description copied from interface: Blur.Iface
Get a list of all the traces.

Specified by:
traceList in interface Blur.Iface
Returns:
the list of trace ids.
Throws:
BlurException
TException

send_traceList

public void send_traceList()
                    throws TException
Throws:
TException

recv_traceList

public List<String> recv_traceList()
                            throws BlurException,
                                   TException
Throws:
BlurException
TException

traceRequestList

public List<String> traceRequestList(String traceId)
                              throws BlurException,
                                     TException
Description copied from interface: Blur.Iface
Gets a request list for the given trace.

Specified by:
traceRequestList in interface Blur.Iface
Parameters:
traceId - the trace id.
Returns:
the list of request ids for the given trace id.
Throws:
BlurException
TException

send_traceRequestList

public void send_traceRequestList(String traceId)
                           throws TException
Throws:
TException

recv_traceRequestList

public List<String> recv_traceRequestList()
                                   throws BlurException,
                                          TException
Throws:
BlurException
TException

traceRequestFetch

public String traceRequestFetch(String traceId,
                                String requestId)
                         throws BlurException,
                                TException
Description copied from interface: Blur.Iface
Fetches the given trace.

Specified by:
traceRequestFetch in interface Blur.Iface
Parameters:
traceId - the trace id.
requestId - the request id.
Returns:
the json for the given trace request.
Throws:
BlurException
TException

send_traceRequestFetch

public void send_traceRequestFetch(String traceId,
                                   String requestId)
                            throws TException
Throws:
TException

recv_traceRequestFetch

public String recv_traceRequestFetch()
                              throws BlurException,
                                     TException
Throws:
BlurException
TException

traceRemove

public void traceRemove(String traceId)
                 throws BlurException,
                        TException
Description copied from interface: Blur.Iface
Remove the trace for the given trace id.

Specified by:
traceRemove in interface Blur.Iface
Parameters:
traceId - the trace id.
Throws:
BlurException
TException

send_traceRemove

public void send_traceRemove(String traceId)
                      throws TException
Throws:
TException

recv_traceRemove

public void recv_traceRemove()
                      throws BlurException,
                             TException
Throws:
BlurException
TException

ping

public void ping()
          throws TException
Description copied from interface: Blur.Iface
A way to ping a server to make sure the connection is still valid.

Specified by:
ping in interface Blur.Iface
Throws:
TException

send_ping

public void send_ping()
               throws TException
Throws:
TException

recv_ping

public void recv_ping()
               throws TException
Throws:
TException

logging

public void logging(String classNameOrLoggerName,
                    Level level)
             throws BlurException,
                    TException
Description copied from interface: Blur.Iface
Changes the logging level for the given instance dynamically at runtime.

Specified by:
logging in interface Blur.Iface
Parameters:
classNameOrLoggerName - the className or Logger Name of the Logger to be changed.
level - the logging level.
Throws:
BlurException
TException

send_logging

public void send_logging(String classNameOrLoggerName,
                         Level level)
                  throws TException
Throws:
TException

recv_logging

public void recv_logging()
                  throws BlurException,
                         TException
Throws:
BlurException
TException

resetLogging

public void resetLogging()
                  throws BlurException,
                         TException
Description copied from interface: Blur.Iface
Resets the logging for this instance to match the log4j file. NOTE: This will allow for dynamically changing to logging file at runtime.

Specified by:
resetLogging in interface Blur.Iface
Throws:
BlurException
TException

send_resetLogging

public void send_resetLogging()
                       throws TException
Throws:
TException

recv_resetLogging

public void recv_resetLogging()
                       throws BlurException,
                              TException
Throws:
BlurException
TException


Copyright © 2012-2014 The Apache Software Foundation. All Rights Reserved.