clojure-hbase.core — clojure-hbase 0.92.4

as-map clj

(as-map result & args)

Extracts the contents of the Result object and sticks them into a 3-level map, indexed by family, qualifier, and then timestamp.

Functions can be passed in with arguments :map-family, :map-qualifier, :map-timestamp, and :map-value. You can also use :map-default to pick a default function, which will be overriden by the more specific directives.

as-vector clj

(as-vector result & args)

Extracts the contents of the Result object and sticks them into a vector tuple of [family qualifier timestamp value]; returns a sequence of such vectors.

Functions can be passed in with arguments :map-family, :map-qualifier, :map-timestamp, and :map-value. You can also use :map-default to pick a default function, which will be overriden by the more specific directives.

check-and-delete clj

(check-and-delete table [row family qualifier value] delete)

(check-and-delete table row family qualifier value delete)

Atomically checks that the row-family-qualifier-value match the values we give, and if so, executes the Delete. A nil value checks for the non-existence of the column.

check-and-put clj

(check-and-put table [row family qualifier value] put)

(check-and-put table row family qualifier value put)

Atomically checks that the row-family-qualifier-value match the values we give, and if so, executes the Put. A nil value checks for the non-existence of the column.

default-config clj

(default-config)

Returns the default HBaseConfiguration as a map.

delete clj

(delete table row & args)

Creates and executes a Delete object against the given table. Options are the same as for delete.

delete* clj

(delete* row & args)

Returns a Delete object suitable for performing a delete on an HTable. To make modifications to an existing Delete object, pass it as the argument to :use-existing; to use an existing RowLock, pass it as the argument to :row-lock.

execute clj

(execute table & ops)

Performs the given HBase table operations (anything implementing the HBaseOperation protocol, such as Get/Scan/Put/Delete) on the given HTableInterface. The return value will be a sequence of equal length, with each slot containing the results of the query in the corresponding position.

get clj

(get table row & args)

Creates and executes a Get object against the given table. Options are the same as for get.

get* clj

(get* row & args)

Returns a Get object suitable for performing a get on an HTable. To make modifications to an existing Get object, pass it as the argument to :use-existing; to use an existing RowLock, pass it as the argument to :row-lock.

HBaseOperation clj protocol

This protocol defines an execute operation that can be defined on an object that represents some request against a table. Implement it for objects that you wish to use with the execute function and which can be expressed in this way.

execute-operation clj

(execute-operation operation table)

Run the given operation object on the HTable given.

insert clj

(insert table family qualifier put)

If the family and qualifier are non-existent, the Put will be committed. The row is taken from the Put object, but the family and qualifier cannot be determined from a Put object, so they must be specified.

latest-as-map clj

(latest-as-map result & args)

Extracts the contents of the Result object and sticks them into a 2-level map, indexed by family and qualifier. The latest timestamp is used.

Functions can be passed in with arguments :map-family, :map-qualifier, and :map-value. You can also use :map-default to pick a default function, which will be overriden by the more specific directives.

make-config clj

(make-config config-map)

Constructs a default HBaseConfiguration object and sets the options given in config-map.

Example: (make-config {"hbase.zookeeper.dns.interface" "lo" :hbase.zookeeper.quorum "127.0.0.1"})

modify clj deprecated

(modify table & ops)

Performs the given modifying actions (Put/Delete) on the given HTable.

DEPRECATED: Use 'execute' instead.

put clj

(put table row & args)

Creates and executes a Put object against the given table. Options are the same as for put.

put* clj

(put* row & args)

Returns a Put object suitable for performing a put on an HTable. To make modifications to an existing Put object, pass it as the argument to :use-existing; to use an existing RowLock, pass it as the argument to :row-lock.

query clj deprecated

(query table & ops)

Performs the given query actions (Get/Scan) on the given HTable. The return value will be a sequence of equal length, with each slot containing the results of the query in the corresponding position.

DEPRECATED: Use 'execute' instead.

release-table clj

(release-table table)

Puts an HTable back into the open HTablePool.

row-lock clj

(row-lock table row)

Returns a RowLock on the given row of the given table.

row-unlock clj

(row-unlock table row-lock)

Unlocks the row locked by the given RowLock.

scan clj

(scan table & args)

Creates and runs a Scan object. All arguments are the same as scan. ResultScanner implements Iterable, so you should be able to just use it directly, but don't forget to .close it! Better yet, use with-scanner.

scan* clj

(scan* & args)

Returns a Scan object suitable for performing a scan on an HTable. To make modifications to an existing Scan object, pass it as the argument to :use-existing.

scanner clj

(scanner table scan)

Creates a Scanner on the given table using the given Scan.

set-config clj

(set-config config-obj)

Resets the db atom, so that subsequent calls to htable-pool use the new configuration (a HBaseConfiguration object).

Example: (set-config (make-config {"hbase.zookeeper.dns.interface" "lo" :hbase.zookeeper.quorum "127.0.0.1"})

table clj

(table table-name)

Gets an HTable from the open HTablePool by name.

to-bytes clj deprecated

(to-bytes arg)

Converts its argument to an array of bytes using the to-bytes-impl multimethod. We can't type hint a multimethod, so we type hint this shell function and calls all over this module don't need reflection.

Deprecated: This method is now intended mainly for internal use and may be made private in a future release. You should be handling the serialization and deserialization yourself at the user level. That is, prefer giving the API functions byte arrays or Strings that you have written to and will read from.

to-bytes-impl clj multimethod deprecated

Converts its argument into an array of bytes. By default, uses HBase's Bytes/toBytes and does nothing to byte arrays. Since it is a multimethod you can redefine it to create your own serialization routines for new types.

This multimethod is mainly for internal use, and may be made private in a future release. You should probably be handling the serialization and deserialization yourself at the user level. That is, prefer giving the API functions byte arrays or Strings that you have written to and will read from. Note: This multimethod does not serialize everything so that clojure's read function will read them back.

with-scanner clj macro

(with-scanner bindings & body)

Executes body, after creating the scanners given in the bindings. Any scanner created in this way (use the function scanner or scan!) will automatically be closed when the body finishes.

with-table clj macro

(with-table bindings & body)

Executes body, after creating the tables given in bindings. Any table created in this way (use the function table) will automatically be returned to the HTablePool when the body finishes.