|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface Blur.Iface
The Blur service API. This API is the same for both controller servers as well as shards servers. Each of the methods are documented.
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. |
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 |
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. |
Method Detail |
---|
void createTable(TableDescriptor tableDescriptor) throws BlurException, TException
tableDescriptor
- the TableDescriptor.
BlurException
TException
void enableTable(String table) throws BlurException, TException
table
- the table name.
BlurException
TException
void disableTable(String table) throws BlurException, TException
table
- the table name.
BlurException
TException
void removeTable(String table, boolean deleteIndexFiles) throws BlurException, TException
table
- the table name.deleteIndexFiles
- true to remove the index storage and false if to preserve.
BlurException
TException
boolean addColumnDefinition(String table, ColumnDefinition columnDefinition) throws BlurException, TException
table
- the name of the table.columnDefinition
- the ColumnDefinition.
BlurException
TException
List<String> tableList() throws BlurException, TException
BlurException
TException
List<String> tableListByCluster(String cluster) throws BlurException, TException
cluster
- the cluster name.
BlurException
TException
TableDescriptor describe(String table) throws BlurException, TException
table
- the table name.
BlurException
TException
Schema schema(String table) throws BlurException, TException
table
- the table name.
BlurException
TException
String parseQuery(String table, Query query) throws BlurException, TException
table
- the table name.query
- the query to parse.
BlurException
TException
TableStats tableStats(String table) throws BlurException, TException
table
- the table name.
BlurException
TException
void optimize(String table, int numberOfSegmentsPerShard) throws BlurException, TException
table
- table the name of the table.numberOfSegmentsPerShard
- the maximum of segments per shard index after the operation is completed.
BlurException
TException
void createSnapshot(String table, String name) throws BlurException, TException
table
- name
-
BlurException
TException
void removeSnapshot(String table, String name) throws BlurException, TException
table
- name
-
BlurException
TException
Map<String,List<String>> listSnapshots(String table) throws BlurException, TException
table
-
BlurException
TException
void setUser(User user) throws TException
user
- the User object.
TException
BlurResults query(String table, BlurQuery blurQuery) throws BlurException, TException
table
- the table name.blurQuery
- the query to execute.
BlurException
TException
FetchResult fetchRow(String table, Selector selector) throws BlurException, TException
table
- the table name.selector
- the Selector to use to fetch the Row or Record.
BlurException
TException
List<FetchResult> fetchRowBatch(String table, List<Selector> selectors) throws BlurException, TException
table
- the table name.selectors
- the Selector to use to fetch the Row or Record.
BlurException
TException
void mutate(RowMutation mutation) throws BlurException, TException
mutation
- the RowMutation.
BlurException
TException
void enqueueMutate(RowMutation mutation) throws BlurException, TException
mutation
- the RowMutation.
BlurException
TException
void mutateBatch(List<RowMutation> mutations) throws BlurException, TException
mutations
- the batch of RowMutations.
BlurException
TException
void enqueueMutateBatch(List<RowMutation> mutations) throws BlurException, TException
mutations
- the batch of RowMutations.
BlurException
TException
void cancelQuery(String table, String uuid) throws BlurException, TException
table
- the table name.uuid
- the uuid of the query.
BlurException
TException
List<String> queryStatusIdList(String table) throws BlurException, TException
table
- the table name.
BlurException
TException
BlurQueryStatus queryStatusById(String table, String uuid) throws BlurException, TException
table
- the table name.uuid
- the uuid of the query.
BlurException
TException
List<String> terms(String table, String columnFamily, String columnName, String startWith, short size) throws BlurException, TException
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.
BlurException
TException
long recordFrequency(String table, String columnFamily, String columnName, String value) throws BlurException, TException
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.
BlurException
TException
List<String> shardClusterList() throws BlurException, TException
BlurException
TException
List<String> shardServerList(String cluster) throws BlurException, TException
cluster
- the cluster name.
BlurException
TException
List<String> controllerServerList() throws BlurException, TException
BlurException
TException
Map<String,String> shardServerLayout(String table) throws BlurException, TException
table
- the table name.
BlurException
TException
Map<String,Map<String,ShardState>> shardServerLayoutState(String table) throws BlurException, TException
table
- the table name.
BlurException
TException
boolean isInSafeMode(String cluster) throws BlurException, TException
cluster
- the name of the cluster.
BlurException
TException
Map<String,String> configuration() throws BlurException, TException
BlurException
TException
Map<String,Metric> metrics(Set<String> metrics) throws BlurException, TException
metrics
- the names of the metrics to return. If null all are returned.
BlurException
TException
void startTrace(String traceId, String requestId) throws TException
traceId
- the trace id.requestId
- the request id, used to connected remote calls together. Client can pass null.
TException
List<String> traceList() throws BlurException, TException
BlurException
TException
List<String> traceRequestList(String traceId) throws BlurException, TException
traceId
- the trace id.
BlurException
TException
String traceRequestFetch(String traceId, String requestId) throws BlurException, TException
traceId
- the trace id.requestId
- the request id.
BlurException
TException
void traceRemove(String traceId) throws BlurException, TException
traceId
- the trace id.
BlurException
TException
void ping() throws TException
TException
void logging(String classNameOrLoggerName, Level level) throws BlurException, TException
classNameOrLoggerName
- the className or Logger Name of the Logger to be changed.level
- the logging level.
BlurException
TException
void resetLogging() throws BlurException, TException
BlurException
TException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |