You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by st...@apache.org on 2009/10/13 01:57:13 UTC
svn commit: r824546 - in /hadoop/hbase/trunk: ./ src/contrib/transactional/
src/contrib/transactional/bin/
src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/
Author: stack
Date: Mon Oct 12 23:57:13 2009
New Revision: 824546
URL: http://svn.apache.org/viewvc?rev=824546&view=rev
Log:
HBASE-1885 Simplify use of IndexedTable outside Java API
Added:
hadoop/hbase/trunk/src/contrib/transactional/bin/
hadoop/hbase/trunk/src/contrib/transactional/bin/TableIndexed.rb
hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/UniqueIndexKeyGenerator.java
Modified:
hadoop/hbase/trunk/CHANGES.txt
hadoop/hbase/trunk/src/contrib/transactional/build.xml
hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/IndexSpecification.java
hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/SimpleIndexKeyGenerator.java
hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/package.html
Modified: hadoop/hbase/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/CHANGES.txt?rev=824546&r1=824545&r2=824546&view=diff
==============================================================================
--- hadoop/hbase/trunk/CHANGES.txt (original)
+++ hadoop/hbase/trunk/CHANGES.txt Mon Oct 12 23:57:13 2009
@@ -113,6 +113,8 @@
all test sync/append
HBASE-1902 Let PerformanceEvaluation support setting tableName and compress
algorithm (Schubert Zhang via Stack)
+ HBASE-1885 Simplify use of IndexedTable outside Java API
+ (Kevin Patterson via Stack)
OPTIMIZATIONS
Added: hadoop/hbase/trunk/src/contrib/transactional/bin/TableIndexed.rb
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/contrib/transactional/bin/TableIndexed.rb?rev=824546&view=auto
==============================================================================
--- hadoop/hbase/trunk/src/contrib/transactional/bin/TableIndexed.rb (added)
+++ hadoop/hbase/trunk/src/contrib/transactional/bin/TableIndexed.rb Mon Oct 12 23:57:13 2009
@@ -0,0 +1,54 @@
+# Copyright 2009 The Apache Software Foundation
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# TableIndexed.rb
+# Extends HBase shell with operations on IndexedTables.
+
+# Usage: within the HBase shell, load 'TableIndexed.rb'. Transactional
+# jar must be in the classpath.
+
+import org.apache.hadoop.hbase.client.tableindexed.IndexedTableAdmin
+import org.apache.hadoop.hbase.client.tableindexed.IndexSpecification
+
+# Creates an index using the supplied index specification.
+# [table_name] the name of the table to index.
+# [index_spec] the IndexSpecification describing the index wanted.
+def create_index(table_name, index_spec)
+ @iadmin ||= IndexedTableAdmin.new(@configuration)
+ @iadmin.addIndex(table_name.to_java_bytes, index_spec)
+end
+
+# Creates an index for a field guaranteed to have unique values. If
+# application code does not ensure uniqueness, behavior is undefined.
+# [table_name] the name of the table to index.
+# [index_name] the name of the index.
+# [column] the column name to be indexed, must respond_to to_java_bytes.
+def create_unique_index(table_name, index_name, column)
+ spec = IndexSpecification.for_unique_index(index_name, column.to_java_bytes)
+ create_index(table_name, spec)
+end
+
+# Creates an index using the standard simple index key. Supports one
+# to many mappings from indexed values to rows in the primary table.
+# [table_name] the name of the table to index.
+# [index_name] the name of the index.
+# [column] the column name to be indexed, must respond_to to_java_bytes.
+def create_simple_index(table_name, index_name, column)
+ spec = new IndexSpecification(index_name, column.to_java_bytes)
+ create_index(table_name, spec)
+end
Modified: hadoop/hbase/trunk/src/contrib/transactional/build.xml
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/contrib/transactional/build.xml?rev=824546&r1=824545&r2=824546&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/contrib/transactional/build.xml (original)
+++ hadoop/hbase/trunk/src/contrib/transactional/build.xml Mon Oct 12 23:57:13 2009
@@ -23,4 +23,19 @@
-->
<project name="transactional" default="jar">
<import file="../build-contrib.xml"/>
+ <!-- ====================================================== -->
+ <!-- Override standard contrib package target to include
+ IndexedTable.rb in the same directory as the jar -->
+ <!-- ====================================================== -->
+ <target name="package" depends="jar, jar-examples" unless="skip.contrib">
+ <mkdir dir="${dist.dir}/contrib/${name}"/>
+ <copy todir="${dist.dir}/contrib/${name}" includeEmptyDirs="false" flatten="true">
+ <fileset dir="${build.dir}">
+ <include name="hbase-${version}-${name}.jar" />
+ </fileset>
+ <fileset dir="${root}/bin">
+ <include name="TableIndexed.rb" />
+ </fileset>
+ </copy>
+ </target>
</project>
Modified: hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/IndexSpecification.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/IndexSpecification.java?rev=824546&r1=824545&r2=824546&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/IndexSpecification.java (original)
+++ hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/IndexSpecification.java Mon Oct 12 23:57:13 2009
@@ -56,6 +56,16 @@
new SimpleIndexKeyGenerator(indexedColumn));
}
+ /**Construct an index spec for a single column that has only unique values.
+ * @param indexId the name of the index
+ * @param indexedColumn the column to index
+ * @return the IndexSpecification
+ */
+ public static IndexSpecification forUniqueIndex(String indexId, byte[] indexedColumn) {
+ return new IndexSpecification(indexId, new byte[][] { indexedColumn },
+ null, new UniqueIndexKeyGenerator(indexedColumn));
+ }
+
/**
* Construct an index spec by specifying everything.
*
Modified: hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/SimpleIndexKeyGenerator.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/SimpleIndexKeyGenerator.java?rev=824546&r1=824545&r2=824546&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/SimpleIndexKeyGenerator.java (original)
+++ hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/SimpleIndexKeyGenerator.java Mon Oct 12 23:57:13 2009
@@ -26,7 +26,11 @@
import org.apache.hadoop.hbase.util.Bytes;
-/** Creates indexed keys for a single column....
+/**Creates indexed keys for a single column. Index key consists of the column
+ * value followed by the row key of the indexed table to disambiguate.
+ *
+ * If the column values are guaranteed to be unique, consider
+ * {@link UniqueIndexKeyGenerator}.
*
*/
public class SimpleIndexKeyGenerator implements IndexKeyGenerator {
Added: hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/UniqueIndexKeyGenerator.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/UniqueIndexKeyGenerator.java?rev=824546&view=auto
==============================================================================
--- hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/UniqueIndexKeyGenerator.java (added)
+++ hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/UniqueIndexKeyGenerator.java Mon Oct 12 23:57:13 2009
@@ -0,0 +1,66 @@
+/**
+ * Copyright 2009 The Apache Software Foundation
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.hadoop.hbase.client.tableindexed;
+
+import java.io.DataInput;
+import java.io.DataOutput;
+import java.io.IOException;
+import java.util.Map;
+
+import org.apache.hadoop.hbase.util.Bytes;
+
+/**
+ * Creates index row keys which exactly match the indexed column. This allows a
+ * direct get() lookup on the index table, but at the cost that the column
+ * values must be unique.
+ *
+ * If you are indexing a column which can have duplicated values, consider
+ * {@link SimpleIndexKeyGenerator}.
+ */
+public class UniqueIndexKeyGenerator implements IndexKeyGenerator {
+ private byte[] column;
+
+ /**
+ * @param column the column to index
+ */
+ public UniqueIndexKeyGenerator(byte[] column) {
+ this.column = column;
+ }
+
+ public UniqueIndexKeyGenerator() {
+ // For Writable
+ }
+
+ /** {@inheritDoc} */
+ public byte[] createIndexKey(byte[] rowKey, Map<byte[], byte[]> columns) {
+ return columns.get(column).clone();
+ }
+
+ /** {@inheritDoc} */
+ public void readFields(DataInput in) throws IOException {
+ column = Bytes.readByteArray(in);
+ }
+
+ /** {@inheritDoc} */
+ public void write(DataOutput out) throws IOException {
+ Bytes.writeByteArray(out, column);
+ }
+
+}
Modified: hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/package.html
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/package.html?rev=824546&r1=824545&r2=824546&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/package.html (original)
+++ hadoop/hbase/trunk/src/contrib/transactional/src/java/org/apache/hadoop/hbase/client/tableindexed/package.html Mon Oct 12 23:57:13 2009
@@ -33,7 +33,8 @@
IndexesSpecifications can be added to a table's metadata (HTableDescriptor) before the table is constructed.
Afterwards, updates and deletes to the original table will trigger the updates in the index, and
-the indexes can be scanned using the API on IndexedTable.
+the indexes can be scanned using the API on IndexedTable. If you prefer not to use the Java API, you can
+load IndexedTable.rb to create indexes from within the HBase shell.
For a simple example, look at the unit test in org.apache.hadoop.hbase.client.tableIndexed.