HBASE-2558 [mvn] Our javadoc overview -- 'Getting Started', requirements, etc. -- is not carried across by mvn javadoc:javadoc target
git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@952565 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack
parent
a01c22af11
commit
e6de46ef37
|
|
@ -672,7 +672,9 @@ Release 0.21.0 - Unreleased
|
|||
HBASE-2651 Allow alternate column separators to be specified for ImportTsv
|
||||
HBASE-2661 Add test case for row atomicity guarantee
|
||||
HBASE-2578 Add ability for tests to override server-side timestamp
|
||||
setting (currentTimeMillis) (Daniel Ploeg via Ryan Rawson)
|
||||
setting (currentTimeMillis) (Daniel Ploeg via Ryan Rawson)
|
||||
HBASE-2558 Our javadoc overview -- "Getting Started", requirements, etc. --
|
||||
is not carried across by mvn javadoc:javadoc target
|
||||
|
||||
NEW FEATURES
|
||||
HBASE-1961 HBase EC2 scripts
|
||||
|
|
|
|||
10
pom.xml
10
pom.xml
|
|
@ -7,7 +7,8 @@
|
|||
<packaging>jar</packaging>
|
||||
<version>0.21.0-SNAPSHOT</version>
|
||||
<name>HBase</name>
|
||||
<description>HBase is the Hadoop database. Use it when you need random, realtime read/write access to your Big Data.
|
||||
<description>
|
||||
HBase is the &lt;a href="http://hadoop.apache.org"&rt;Hadoop</a&rt; database. Use it when you need random, realtime read/write access to your Big Data.
|
||||
This project's goal is the hosting of very large tables -- billions of rows X millions of columns -- atop clusters
|
||||
of commodity hardware.
|
||||
</description>
|
||||
|
|
@ -22,6 +23,11 @@
|
|||
</license>
|
||||
</licenses>
|
||||
|
||||
<organization>
|
||||
<name>Apache Software Foundation</name>
|
||||
<url>http://www.apache.org</url>
|
||||
</organization>
|
||||
|
||||
<scm>
|
||||
<connection>scm:svn:http://svn.apache.org/repos/asf/hbase/trunk</connection>
|
||||
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/hbase/trunk</developerConnection>
|
||||
|
|
@ -881,10 +887,12 @@
|
|||
<artifactId>maven-surefire-report-plugin</artifactId>
|
||||
<version>2.5</version>
|
||||
</plugin>
|
||||
<!--
|
||||
<plugin>
|
||||
<artifactId>maven-dependency-plugin</artifactId>
|
||||
<version>2.1</version>
|
||||
</plugin>
|
||||
-->
|
||||
<plugin>
|
||||
<groupId>org.apache.rat</groupId>
|
||||
<artifactId>apache-rat-plugin</artifactId>
|
||||
|
|
|
|||
|
|
@ -40,6 +40,17 @@
|
|||
<exclude>**/*.jsp</exclude>
|
||||
</excludes>
|
||||
</fileSet>
|
||||
<fileSet>
|
||||
<directory>target/site</directory>
|
||||
<outputDirectory>docs</outputDirectory>
|
||||
</fileSet>
|
||||
<fileSet>
|
||||
<directory>src/main/resources/</directory>
|
||||
<outputDirectory>conf</outputDirectory>
|
||||
<includes>
|
||||
<include>hbase-default.xml</include>
|
||||
</includes>
|
||||
</fileSet>
|
||||
</fileSets>
|
||||
<dependencySets>
|
||||
<dependencySet>
|
||||
|
|
|
|||
|
|
@ -1,104 +0,0 @@
|
|||
# Copyright 2002-2004 The Apache Software Foundation
|
||||
#
|
||||
# Licensed 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.
|
||||
|
||||
##############
|
||||
# Properties used by forrest.build.xml for building the website
|
||||
# These are the defaults, un-comment them if you need to change them.
|
||||
##############
|
||||
|
||||
# Prints out a summary of Forrest settings for this project
|
||||
#forrest.echo=true
|
||||
|
||||
# Project name (used to name .war file)
|
||||
#project.name=my-project
|
||||
|
||||
# Specifies name of Forrest skin to use
|
||||
#project.skin=tigris
|
||||
#project.skin=pelt
|
||||
|
||||
# comma separated list, file:// is supported
|
||||
#forrest.skins.descriptors=http://forrest.apache.org/skins/skins.xml,file:///c:/myskins/skins.xml
|
||||
|
||||
##############
|
||||
# behavioural properties
|
||||
#project.menu-scheme=tab_attributes
|
||||
#project.menu-scheme=directories
|
||||
|
||||
##############
|
||||
# layout properties
|
||||
|
||||
# Properties that can be set to override the default locations
|
||||
#
|
||||
# Parent properties must be set. This usually means uncommenting
|
||||
# project.content-dir if any other property using it is uncommented
|
||||
|
||||
#project.status=status.xml
|
||||
#project.content-dir=src/documentation
|
||||
#project.raw-content-dir=${project.content-dir}/content
|
||||
#project.conf-dir=${project.content-dir}/conf
|
||||
#project.sitemap-dir=${project.content-dir}
|
||||
#project.xdocs-dir=${project.content-dir}/content/xdocs
|
||||
#project.resources-dir=${project.content-dir}/resources
|
||||
#project.stylesheets-dir=${project.resources-dir}/stylesheets
|
||||
#project.images-dir=${project.resources-dir}/images
|
||||
#project.schema-dir=${project.resources-dir}/schema
|
||||
#project.skins-dir=${project.content-dir}/skins
|
||||
#project.skinconf=${project.content-dir}/skinconf.xml
|
||||
#project.lib-dir=${project.content-dir}/lib
|
||||
#project.classes-dir=${project.content-dir}/classes
|
||||
#project.translations-dir=${project.content-dir}/translations
|
||||
|
||||
##############
|
||||
# validation properties
|
||||
|
||||
# This set of properties determine if validation is performed
|
||||
# Values are inherited unless overridden.
|
||||
# e.g. if forrest.validate=false then all others are false unless set to true.
|
||||
forrest.validate=false
|
||||
#forrest.validate.xdocs=${forrest.validate}
|
||||
#forrest.validate.skinconf=${forrest.validate}
|
||||
#forrest.validate.sitemap=${forrest.validate}
|
||||
#forrest.validate.stylesheets=${forrest.validate}
|
||||
#forrest.validate.skins=${forrest.validate}
|
||||
#forrest.validate.skins.stylesheets=${forrest.validate.skins}
|
||||
|
||||
# *.failonerror=(true|false) - stop when an XML file is invalid
|
||||
#forrest.validate.failonerror=true
|
||||
|
||||
# *.excludes=(pattern) - comma-separated list of path patterns to not validate
|
||||
# e.g.
|
||||
#forrest.validate.xdocs.excludes=samples/subdir/**, samples/faq.xml
|
||||
#forrest.validate.xdocs.excludes=
|
||||
|
||||
|
||||
##############
|
||||
# General Forrest properties
|
||||
|
||||
# The URL to start crawling from
|
||||
#project.start-uri=linkmap.html
|
||||
# Set logging level for messages printed to the console
|
||||
# (DEBUG, INFO, WARN, ERROR, FATAL_ERROR)
|
||||
#project.debuglevel=ERROR
|
||||
# Max memory to allocate to Java
|
||||
#forrest.maxmemory=64m
|
||||
# Any other arguments to pass to the JVM. For example, to run on an X-less
|
||||
# server, set to -Djava.awt.headless=true
|
||||
#forrest.jvmargs=
|
||||
# The bugtracking URL - the issue number will be appended
|
||||
#project.bugtracking-url=http://issues.apache.org/bugzilla/show_bug.cgi?id=
|
||||
#project.bugtracking-url=http://issues.apache.org/jira/browse/
|
||||
# The issues list as rss
|
||||
#project.issues-rss-url=
|
||||
#I18n Property only works for the "forrest run" target.
|
||||
#project.i18n=true
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
This is the base documentation directory.
|
||||
|
||||
skinconf.xml # This file customizes Forrest for your project. In it, you
|
||||
# tell forrest the project name, logo, copyright info, etc
|
||||
|
||||
sitemap.xmap # Optional. This sitemap is consulted before all core sitemaps.
|
||||
# See http://forrest.apache.org/docs/project-sitemap.html
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
# Copyright 2002-2004 The Apache Software Foundation
|
||||
#
|
||||
# Licensed 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.
|
||||
|
||||
#=======================================================================
|
||||
# CatalogManager.properties
|
||||
#
|
||||
# This is the default properties file for Apache Forrest.
|
||||
# This facilitates local configuration of application-specific catalogs.
|
||||
#
|
||||
# See the Apache Forrest documentation:
|
||||
# http://forrest.apache.org/docs/your-project.html
|
||||
# http://forrest.apache.org/docs/validation.html
|
||||
|
||||
# verbosity ... level of messages for status/debug
|
||||
# See forrest/src/core/context/WEB-INF/cocoon.xconf
|
||||
|
||||
# catalogs ... list of additional catalogs to load
|
||||
# (Note that Apache Forrest will automatically load its own default catalog
|
||||
# from src/core/context/resources/schema/catalog.xcat)
|
||||
# use full pathnames
|
||||
# pathname separator is always semi-colon (;) regardless of operating system
|
||||
# directory separator is always slash (/) regardless of operating system
|
||||
#
|
||||
#catalogs=/home/me/forrest/my-site/src/documentation/resources/schema/catalog.xcat
|
||||
catalogs=
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
<!--
|
||||
Copyright 2002-2004 The Apache Software Foundation
|
||||
|
||||
Licensed 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.
|
||||
-->
|
||||
|
||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
|
||||
|
||||
<document>
|
||||
|
||||
<header>
|
||||
<title>HBase Documentation</title>
|
||||
</header>
|
||||
|
||||
<body>
|
||||
<p>
|
||||
The following documents provide concepts and procedures that will help you
|
||||
get started using HBase. If you have more questions, you can ask the
|
||||
<a href="ext:lists">mailing list</a> or browse the archives.
|
||||
</p>
|
||||
<ul>
|
||||
<li><a href="ext:api/started">Getting Started</a></li>
|
||||
<li><a href="ext:api/index">API Docs</a></li>
|
||||
<li><a href="ext:wiki">Wiki</a></li>
|
||||
<li><a href="ext:faq">FAQ</a></li>
|
||||
</ul>
|
||||
</body>
|
||||
|
||||
</document>
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
<!--
|
||||
Copyright 2002-2004 The Apache Software Foundation
|
||||
|
||||
Licensed 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.
|
||||
-->
|
||||
|
||||
<!--
|
||||
Forrest site.xml
|
||||
|
||||
This file contains an outline of the site's information content. It is used to:
|
||||
- Generate the website menus (though these can be overridden - see docs)
|
||||
- Provide semantic, location-independent aliases for internal 'site:' URIs, eg
|
||||
<link href="site:changes"> links to changes.html (or ../changes.html if in
|
||||
subdir).
|
||||
- Provide aliases for external URLs in the external-refs section. Eg, <link
|
||||
href="ext:cocoon"> links to http://xml.apache.org/cocoon/
|
||||
|
||||
See http://forrest.apache.org/docs/linking.html for more info.
|
||||
-->
|
||||
|
||||
<site label="Hadoop" href="" xmlns="http://apache.org/forrest/linkmap/1.0">
|
||||
|
||||
<docs label="Documentation">
|
||||
<overview label="Overview" href="index.html" />
|
||||
<started label="Getting Started" href="ext:api/started" />
|
||||
<api label="API Docs" href="ext:api/index" />
|
||||
<api label="Bulk Loads" href="bulk-load.html" />
|
||||
<api label="HBase Metrics" href="metrics.html" />
|
||||
<api label="HBase Semantics" href="acid-semantics.html" />
|
||||
<api label="HBase Default Configuration" href="hbase-conf.html" />
|
||||
<api label="HBase on Windows" href="cygwin.html" />
|
||||
<wiki label="Wiki" href="ext:wiki" />
|
||||
<faq label="FAQ" href="ext:faq" />
|
||||
<lists label="Mailing Lists" href="ext:lists" />
|
||||
</docs>
|
||||
|
||||
<external-refs>
|
||||
<site href="http://hadoop.apache.org/hbase/"/>
|
||||
<lists href="http://hadoop.apache.org/hbase/mailing_lists.html"/>
|
||||
<releases href="http://hadoop.apache.org/hbase/releases.html">
|
||||
<download href="#Download" />
|
||||
</releases>
|
||||
<jira href="http://hadoop.apache.org/hbase/issue_tracking.html"/>
|
||||
<wiki href="http://wiki.apache.org/hadoop/Hbase" />
|
||||
<faq href="http://wiki.apache.org/hadoop/Hbase/FAQ" />
|
||||
<zlib href="http://www.zlib.net/" />
|
||||
<lzo href="http://www.oberhumer.com/opensource/lzo/" />
|
||||
<gzip href="http://www.gzip.org/" />
|
||||
<cygwin href="http://www.cygwin.com/" />
|
||||
<osx href="http://www.apple.com/macosx" />
|
||||
<api href="api/">
|
||||
<started href="overview-summary.html#overview_description" />
|
||||
<index href="index.html" />
|
||||
<org href="org/">
|
||||
<apache href="apache/">
|
||||
<hadoop href="hadoop/">
|
||||
<hbase href="hbase/">
|
||||
</hbase>
|
||||
</hadoop>
|
||||
</apache>
|
||||
</org>
|
||||
</api>
|
||||
</external-refs>
|
||||
|
||||
</site>
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
<!--
|
||||
Copyright 2002-2004 The Apache Software Foundation
|
||||
|
||||
Licensed 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.
|
||||
-->
|
||||
|
||||
<!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab V1.0//EN"
|
||||
"http://forrest.apache.org/dtd/tab-cocoon-v10.dtd">
|
||||
|
||||
<tabs software="HBase"
|
||||
title="HBase"
|
||||
copyright="The Apache Software Foundation"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
|
||||
<!-- The rules are:
|
||||
@dir will always have /index.html added.
|
||||
@href is not modified unless it is root-relative and obviously specifies a
|
||||
directory (ends in '/'), in which case /index.html will be added
|
||||
-->
|
||||
|
||||
<tab label="Project" href="http://hadoop.apache.org/hbase/" />
|
||||
<tab label="Wiki" href="http://wiki.apache.org/hadoop/Hbase" />
|
||||
<tab label="HBase Documentation" dir="" />
|
||||
</tabs>
|
||||
|
|
@ -1,345 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
<!--
|
||||
Copyright 2002-2004 The Apache Software Foundation
|
||||
|
||||
Licensed 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.
|
||||
-->
|
||||
|
||||
<!--
|
||||
Skin configuration file. This file contains details of your project,
|
||||
which will be used to configure the chosen Forrest skin.
|
||||
-->
|
||||
|
||||
<!DOCTYPE skinconfig PUBLIC "-//APACHE//DTD Skin Configuration V0.6-3//EN" "http://forrest.apache.org/dtd/skinconfig-v06-3.dtd">
|
||||
<skinconfig>
|
||||
<!-- To enable lucene search add provider="lucene" (default is google).
|
||||
Add box-location="alt" to move the search box to an alternate location
|
||||
(if the skin supports it) and box-location="all" to show it in all
|
||||
available locations on the page. Remove the <search> element to show
|
||||
no search box. @domain will enable sitesearch for the specific domain with google.
|
||||
In other words google will search the @domain for the query string.
|
||||
|
||||
-->
|
||||
<search name="HBase" domain="hadoop.apache.org" provider="google"/>
|
||||
|
||||
<!-- Disable the print link? If enabled, invalid HTML 4.0.1 -->
|
||||
<disable-print-link>true</disable-print-link>
|
||||
<!-- Disable the PDF link? -->
|
||||
<disable-pdf-link>false</disable-pdf-link>
|
||||
<!-- Disable the POD link? -->
|
||||
<disable-pod-link>true</disable-pod-link>
|
||||
<!-- Disable the Text link? FIXME: NOT YET IMPLEMENETED. -->
|
||||
<disable-txt-link>true</disable-txt-link>
|
||||
<!-- Disable the xml source link? -->
|
||||
<!-- The xml source link makes it possible to access the xml rendition
|
||||
of the source frim the html page, and to have it generated statically.
|
||||
This can be used to enable other sites and services to reuse the
|
||||
xml format for their uses. Keep this disabled if you don't want other
|
||||
sites to easily reuse your pages.-->
|
||||
<disable-xml-link>true</disable-xml-link>
|
||||
|
||||
<!-- Disable navigation icons on all external links? -->
|
||||
<disable-external-link-image>true</disable-external-link-image>
|
||||
|
||||
<!-- Disable w3c compliance links?
|
||||
Use e.g. align="center" to move the compliance links logos to
|
||||
an alternate location default is left.
|
||||
(if the skin supports it) -->
|
||||
<disable-compliance-links>true</disable-compliance-links>
|
||||
|
||||
<!-- Render mailto: links unrecognisable by spam harvesters? -->
|
||||
<obfuscate-mail-links>false</obfuscate-mail-links>
|
||||
|
||||
<!-- Disable the javascript facility to change the font size -->
|
||||
<disable-font-script>true</disable-font-script>
|
||||
|
||||
<!-- project logo -->
|
||||
<project-name>HBase</project-name>
|
||||
<project-description>The Hadoop database</project-description>
|
||||
<project-url>http://hadoop.apache.org/hbase/</project-url>
|
||||
<project-logo>images/hbase_small.gif</project-logo>
|
||||
|
||||
<!-- group logo -->
|
||||
<group-name>Hadoop</group-name>
|
||||
<group-description>Apache Hadoop</group-description>
|
||||
<group-url>http://hadoop.apache.org/</group-url>
|
||||
<group-logo>images/hadoop-logo.jpg</group-logo>
|
||||
|
||||
<!-- optional host logo (e.g. sourceforge logo)
|
||||
default skin: renders it at the bottom-left corner -->
|
||||
<host-url></host-url>
|
||||
<host-logo></host-logo>
|
||||
|
||||
<!-- relative url of a favicon file, normally favicon.ico -->
|
||||
<favicon-url>images/favicon.ico</favicon-url>
|
||||
|
||||
<!-- The following are used to construct a copyright statement -->
|
||||
<year>2009</year>
|
||||
<vendor>The Apache Software Foundation.</vendor>
|
||||
<copyright-link>http://www.apache.org/licenses/</copyright-link>
|
||||
|
||||
<!-- Some skins use this to form a 'breadcrumb trail' of links.
|
||||
Use location="alt" to move the trail to an alternate location
|
||||
(if the skin supports it).
|
||||
Omit the location attribute to display the trail in the default location.
|
||||
Use location="none" to not display the trail (if the skin supports it).
|
||||
For some skins just set the attributes to blank.
|
||||
-->
|
||||
<trail>
|
||||
<link1 name="Apache" href="http://www.apache.org/"/>
|
||||
<link2 name="Hadoop" href="http://hadoop.apache.org/"/>
|
||||
<link3 name="HBase" href="http://hadoop.apache.org/hbase/"/>
|
||||
</trail>
|
||||
|
||||
<!-- Configure the TOC, i.e. the Table of Contents.
|
||||
@max-depth
|
||||
how many "section" levels need to be included in the
|
||||
generated Table of Contents (TOC).
|
||||
@min-sections
|
||||
Minimum required to create a TOC.
|
||||
@location ("page","menu","page,menu", "none")
|
||||
Where to show the TOC.
|
||||
-->
|
||||
<toc max-depth="2" min-sections="1" location="page"/>
|
||||
|
||||
<!-- Heading types can be clean|underlined|boxed -->
|
||||
<headings type="clean"/>
|
||||
|
||||
<!-- The optional feedback element will be used to construct a
|
||||
feedback link in the footer with the page pathname appended:
|
||||
<a href="@href">{@to}</a>
|
||||
<feedback to="webmaster@foo.com"
|
||||
href="mailto:webmaster@foo.com?subject=Feedback " >
|
||||
Send feedback about the website to:
|
||||
</feedback>
|
||||
-->
|
||||
<!--
|
||||
extra-css - here you can define custom css-elements that are
|
||||
a. overriding the fallback elements or
|
||||
b. adding the css definition from new elements that you may have
|
||||
used in your documentation.
|
||||
-->
|
||||
<extra-css>
|
||||
<!--Example of b.
|
||||
To define the css definition of a new element that you may have used
|
||||
in the class attribute of a <p> node.
|
||||
e.g. <p class="quote"/>
|
||||
-->
|
||||
p.quote {
|
||||
margin-left: 2em;
|
||||
padding: .5em;
|
||||
background-color: #f0f0f0;
|
||||
font-family: monospace;
|
||||
}
|
||||
</extra-css>
|
||||
|
||||
<colors>
|
||||
<!-- These values are used for the generated CSS files. -->
|
||||
|
||||
<!-- Krysalis -->
|
||||
<!--
|
||||
<color name="header" value="#FFFFFF"/>
|
||||
|
||||
<color name="tab-selected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
|
||||
<color name="tab-unselected" value="#F7F7F7" link="#000000" vlink="#000000" hlink="#000000"/>
|
||||
<color name="subtab-selected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
|
||||
<color name="subtab-unselected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
|
||||
|
||||
<color name="heading" value="#a5b6c6"/>
|
||||
<color name="subheading" value="#CFDCED"/>
|
||||
|
||||
<color name="navstrip" value="#CFDCED" font="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
|
||||
<color name="toolbox" value="#a5b6c6"/>
|
||||
<color name="border" value="#a5b6c6"/>
|
||||
|
||||
<color name="menu" value="#F7F7F7" link="#000000" vlink="#000000" hlink="#000000"/>
|
||||
<color name="dialog" value="#F7F7F7"/>
|
||||
|
||||
<color name="body" value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
|
||||
|
||||
<color name="table" value="#a5b6c6"/>
|
||||
<color name="table-cell" value="#ffffff"/>
|
||||
<color name="highlight" value="#ffff00"/>
|
||||
<color name="fixme" value="#cc6600"/>
|
||||
<color name="note" value="#006699"/>
|
||||
<color name="warning" value="#990000"/>
|
||||
<color name="code" value="#a5b6c6"/>
|
||||
|
||||
<color name="footer" value="#a5b6c6"/>
|
||||
-->
|
||||
|
||||
<!-- Forrest -->
|
||||
<!--
|
||||
<color name="header" value="#294563"/>
|
||||
|
||||
<color name="tab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
|
||||
<color name="tab-unselected" value="#b5c7e7" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
|
||||
<color name="subtab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
|
||||
<color name="subtab-unselected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
|
||||
|
||||
<color name="heading" value="#294563"/>
|
||||
<color name="subheading" value="#4a6d8c"/>
|
||||
|
||||
<color name="navstrip" value="#cedfef" font="#0F3660" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
|
||||
<color name="toolbox" value="#4a6d8c"/>
|
||||
<color name="border" value="#294563"/>
|
||||
|
||||
<color name="menu" value="#4a6d8c" font="#cedfef" link="#ffffff" vlink="#ffffff" hlink="#ffcf00"/>
|
||||
<color name="dialog" value="#4a6d8c"/>
|
||||
|
||||
<color name="body" value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
|
||||
|
||||
<color name="table" value="#7099C5"/>
|
||||
<color name="table-cell" value="#f0f0ff"/>
|
||||
<color name="highlight" value="#ffff00"/>
|
||||
<color name="fixme" value="#cc6600"/>
|
||||
<color name="note" value="#006699"/>
|
||||
<color name="warning" value="#990000"/>
|
||||
<color name="code" value="#CFDCED"/>
|
||||
|
||||
<color name="footer" value="#cedfef"/>
|
||||
-->
|
||||
|
||||
<!-- Collabnet -->
|
||||
<!--
|
||||
<color name="header" value="#003366"/>
|
||||
|
||||
<color name="tab-selected" value="#dddddd" link="#555555" vlink="#555555" hlink="#555555"/>
|
||||
<color name="tab-unselected" value="#999999" link="#ffffff" vlink="#ffffff" hlink="#ffffff"/>
|
||||
<color name="subtab-selected" value="#cccccc" link="#000000" vlink="#000000" hlink="#000000"/>
|
||||
<color name="subtab-unselected" value="#cccccc" link="#555555" vlink="#555555" hlink="#555555"/>
|
||||
|
||||
<color name="heading" value="#003366"/>
|
||||
<color name="subheading" value="#888888"/>
|
||||
|
||||
<color name="navstrip" value="#dddddd" font="#555555"/>
|
||||
<color name="toolbox" value="#dddddd" font="#555555"/>
|
||||
<color name="border" value="#999999"/>
|
||||
|
||||
<color name="menu" value="#ffffff"/>
|
||||
<color name="dialog" value="#eeeeee"/>
|
||||
|
||||
<color name="body" value="#ffffff"/>
|
||||
|
||||
<color name="table" value="#ccc"/>
|
||||
<color name="table-cell" value="#ffffff"/>
|
||||
<color name="highlight" value="#ffff00"/>
|
||||
<color name="fixme" value="#cc6600"/>
|
||||
<color name="note" value="#006699"/>
|
||||
<color name="warning" value="#990000"/>
|
||||
<color name="code" value="#003366"/>
|
||||
|
||||
<color name="footer" value="#ffffff"/>
|
||||
-->
|
||||
<!-- Lenya using pelt-->
|
||||
<!--
|
||||
<color name="header" value="#ffffff"/>
|
||||
|
||||
<color name="tab-selected" value="#4C6C8F" link="#ffffff" vlink="#ffffff" hlink="#ffffff"/>
|
||||
<color name="tab-unselected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
|
||||
<color name="subtab-selected" value="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
|
||||
<color name="subtab-unselected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
|
||||
|
||||
<color name="heading" value="#E5E4D9"/>
|
||||
<color name="subheading" value="#000000"/>
|
||||
<color name="published" value="#4C6C8F" font="#FFFFFF"/>
|
||||
<color name="feedback" value="#4C6C8F" font="#FFFFFF" align="center"/>
|
||||
<color name="navstrip" value="#E5E4D9" font="#000000"/>
|
||||
|
||||
<color name="toolbox" value="#CFDCED" font="#000000"/>
|
||||
|
||||
<color name="border" value="#999999"/>
|
||||
<color name="menu" value="#4C6C8F" font="#ffffff" link="#ffffff" vlink="#ffffff" hlink="#ffffff" current="#FFCC33" />
|
||||
<color name="menuheading" value="#cfdced" font="#000000" />
|
||||
<color name="searchbox" value="#E5E4D9" font="#000000"/>
|
||||
|
||||
<color name="dialog" value="#CFDCED"/>
|
||||
<color name="body" value="#ffffff" />
|
||||
|
||||
<color name="table" value="#ccc"/>
|
||||
<color name="table-cell" value="#ffffff"/>
|
||||
<color name="highlight" value="#ffff00"/>
|
||||
<color name="fixme" value="#cc6600"/>
|
||||
<color name="note" value="#006699"/>
|
||||
<color name="warning" value="#990000"/>
|
||||
<color name="code" value="#003366"/>
|
||||
|
||||
<color name="footer" value="#E5E4D9"/>
|
||||
-->
|
||||
</colors>
|
||||
|
||||
<!-- Settings specific to PDF output. -->
|
||||
<pdf>
|
||||
<!--
|
||||
Supported page sizes are a0, a1, a2, a3, a4, a5, executive,
|
||||
folio, legal, ledger, letter, quarto, tabloid (default letter).
|
||||
Supported page orientations are portrait, landscape (default
|
||||
portrait).
|
||||
Supported text alignments are left, right, justify (default left).
|
||||
-->
|
||||
<page size="letter" orientation="portrait" text-align="left"/>
|
||||
|
||||
<!--
|
||||
Margins can be specified for top, bottom, inner, and outer
|
||||
edges. If double-sided="false", the inner edge is always left
|
||||
and the outer is always right. If double-sided="true", the
|
||||
inner edge will be left on odd pages, right on even pages,
|
||||
the outer edge vice versa.
|
||||
Specified below are the default settings.
|
||||
-->
|
||||
<margins double-sided="false">
|
||||
<top>1in</top>
|
||||
<bottom>1in</bottom>
|
||||
<inner>1.25in</inner>
|
||||
<outer>1in</outer>
|
||||
</margins>
|
||||
|
||||
<!--
|
||||
Print the URL text next to all links going outside the file
|
||||
-->
|
||||
<show-external-urls>false</show-external-urls>
|
||||
|
||||
<!--
|
||||
Disable the copyright footer on each page of the PDF.
|
||||
A footer is composed for each page. By default, a "credit" with role=pdf
|
||||
will be used, as explained below. Otherwise a copyright statement
|
||||
will be generated. This latter can be disabled.
|
||||
-->
|
||||
<disable-copyright-footer>false</disable-copyright-footer>
|
||||
</pdf>
|
||||
|
||||
<!-- Credits are typically rendered as a set of small clickable
|
||||
images in the page footer.
|
||||
Use box-location="alt" to move the credit to an alternate location
|
||||
(if the skin supports it).
|
||||
-->
|
||||
<credits>
|
||||
<credit box-location="alt">
|
||||
<name>Built with Apache Forrest</name>
|
||||
<url>http://forrest.apache.org/</url>
|
||||
<image>images/built-with-forrest-button.png</image>
|
||||
<width>88</width>
|
||||
<height>31</height>
|
||||
</credit>
|
||||
<!-- A credit with @role="pdf" will be used to compose a footer
|
||||
for each page in the PDF, using either "name" or "url" or both.
|
||||
-->
|
||||
<!--
|
||||
<credit role="pdf">
|
||||
<name>Built with Apache Forrest</name>
|
||||
<url>http://forrest.apache.org/</url>
|
||||
</credit>
|
||||
-->
|
||||
</credits>
|
||||
|
||||
</skinconfig>
|
||||
|
|
@ -1,74 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
<!--
|
||||
Copyright 2002-2004 The Apache Software Foundation
|
||||
|
||||
Licensed 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.
|
||||
-->
|
||||
<status>
|
||||
|
||||
<developers>
|
||||
<person name="Joe Bloggs" email="joe@joescompany.org" id="JB" />
|
||||
<!-- Add more people here -->
|
||||
</developers>
|
||||
|
||||
<changes>
|
||||
<!-- Add new releases here -->
|
||||
<release version="0.1" date="unreleased">
|
||||
<!-- Some action types have associated images. By default, images are
|
||||
defined for 'add', 'fix', 'remove', 'update' and 'hack'. If you add
|
||||
src/documentation/resources/images/<foo>.jpg images, these will
|
||||
automatically be used for entries of type <foo>. -->
|
||||
|
||||
<action dev="JB" type="add" context="admin">
|
||||
Initial Import
|
||||
</action>
|
||||
<!-- Sample action:
|
||||
<action dev="JB" type="fix" due-to="Joe Contributor"
|
||||
due-to-email="joec@apache.org" fixes-bug="123">
|
||||
Fixed a bug in the Foo class.
|
||||
</action>
|
||||
-->
|
||||
</release>
|
||||
</changes>
|
||||
|
||||
<todo>
|
||||
<actions priority="high">
|
||||
<action context="docs" dev="JB">
|
||||
Customize this template project with your project's details. This
|
||||
TODO list is generated from 'status.xml'.
|
||||
</action>
|
||||
<action context="docs" dev="JB">
|
||||
Add lots of content. XML content goes in
|
||||
<code>src/documentation/content/xdocs</code>, or wherever the
|
||||
<code>${project.xdocs-dir}</code> property (set in
|
||||
<code>forrest.properties</code>) points.
|
||||
</action>
|
||||
<action context="feedback" dev="JB">
|
||||
Mail <link
|
||||
href="mailto:forrest-dev@xml.apache.org">forrest-dev@xml.apache.org</link>
|
||||
with feedback.
|
||||
</action>
|
||||
</actions>
|
||||
<!-- Add todo items. @context is an arbitrary string. Eg:
|
||||
<actions priority="high">
|
||||
<action context="code" dev="SN">
|
||||
</action>
|
||||
</actions>
|
||||
<actions priority="medium">
|
||||
<action context="docs" dev="open">
|
||||
</action>
|
||||
</actions>
|
||||
-->
|
||||
</todo>
|
||||
|
||||
</status>
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
/*
|
||||
* 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.
|
||||
*/
|
||||
|
||||
a.externalLink, a.externalLink:link, a.externalLink:visited, a.externalLink:active, a.externalLink:hover {
|
||||
background: none;
|
||||
padding-right: 0;
|
||||
}
|
||||
|
||||
/*
|
||||
body ul {
|
||||
list-style-type: square;
|
||||
}
|
||||
*/
|
||||
|
||||
#downloadbox {
|
||||
float: right;
|
||||
margin: 0 10px 20px 20px;
|
||||
padding: 5px;
|
||||
border: 1px solid #999;
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
#downloadbox h5 {
|
||||
color: #000;
|
||||
margin: 0;
|
||||
border-bottom: 1px solid #aaaaaa;
|
||||
font-size: smaller;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
#downloadbox p {
|
||||
margin-top: 1em;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
#downloadbox ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 1em;
|
||||
list-style-type: disc;
|
||||
}
|
||||
|
||||
#downloadbox li {
|
||||
font-size: smaller;
|
||||
}
|
||||
|
||||
/*
|
||||
h4 {
|
||||
padding: 0;
|
||||
border: none;
|
||||
color: #000;
|
||||
margin: 0;
|
||||
font-size: larger;
|
||||
font-weight: bold;
|
||||
}
|
||||
*/
|
||||
|
||||
#banner {
|
||||
background: none;
|
||||
}
|
||||
|
||||
#banner img {
|
||||
margin: 10px;
|
||||
}
|
||||
|
||||
.frontpagebox {
|
||||
float: left;
|
||||
text-align: center;
|
||||
width: 15em;
|
||||
margin-left: 0.5em;
|
||||
margin-right: 0.5em;
|
||||
margin-top: 2em;
|
||||
}
|
||||
|
||||
.headline {
|
||||
font-size: 120%;
|
||||
font-weight: bold;
|
||||
padding-top: 1px;
|
||||
padding-bottom: 5px;
|
||||
background-image: url(../images/breadcrumbs.jpg);
|
||||
background-repeat: repeat-x;
|
||||
}
|
||||
|
||||
/*
|
||||
#leftColumn {
|
||||
display: none !important
|
||||
}
|
||||
|
||||
#bodyColumn {
|
||||
margin-left: 1.5em;
|
||||
}
|
||||
*/
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.9 KiB |
|
Before Width: | Height: | Size: 766 B After Width: | Height: | Size: 766 B |
|
Before Width: | Height: | Size: 9.2 KiB After Width: | Height: | Size: 9.2 KiB |
|
Before Width: | Height: | Size: 3.5 KiB After Width: | Height: | Size: 3.5 KiB |
|
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
|
|
@ -0,0 +1,46 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
|
||||
<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
|
||||
<bannerLeft>
|
||||
<name>HBase</name>
|
||||
<src>http://hbase.apache.org/images/hbase_logo_med.gif</src>
|
||||
<href>http://hbase.apache.org/</href>
|
||||
</bannerLeft>
|
||||
<bannerRight>
|
||||
<src>http://hbase.apache.org/images/asf_logo_wide.png</src>
|
||||
<href>http://www.apache.org/</href>
|
||||
</bannerRight>
|
||||
<publishDate position="navigation-bottom" />
|
||||
<body>
|
||||
<links>
|
||||
<item name="Wiki" href="http://wiki.apache.org/hadoop/Hbase" />
|
||||
<item name="Hadoop" href="http://hadoop.apache.org/" />
|
||||
</links>
|
||||
|
||||
<menu name="HBase">
|
||||
<item name="Overview" href="index.html"/>
|
||||
<item name="License" href="license.html" />
|
||||
<item name="Downloads" href="http://www.apache.org/dyn/closer.cgi/hadoop/hbase/" />
|
||||
<item name="Release Notes" href="https://issues.apache.org/jira/browse/HBASE?report=com.atlassian.jira.plugin.system.project:changelog-panel" />
|
||||
<item name="Getting Started" href="apidocs/index.html#started" />
|
||||
<item name="API" href="apidocs/" />
|
||||
<item name="X-Ref" href="xref/" />
|
||||
<item name="Issue Tracking" href="issue-tracking.html" />
|
||||
<item name="Mailing Lists" href="mail-lists.html" />
|
||||
<item name="Source Repository" href="source-repository.html" />
|
||||
<item name="Wiki" href="http://wiki.apache.org/hadoop/Hbase" />
|
||||
<item name="ACID Semantics" href="acid-semantics.html" />
|
||||
<item name="Bulk Loads" href="bulk-loads.html" />
|
||||
<item name="Metrics" href="metrics.html" />
|
||||
<item name="HBase on Windows" href="cygwin.html" />
|
||||
<item name="Team" href="team-list.html" />
|
||||
</menu>
|
||||
</body>
|
||||
<skin>
|
||||
<groupId>org.apache.maven.skins</groupId>
|
||||
<artifactId>maven-stylus-skin</artifactId>
|
||||
</skin>
|
||||
</project>
|
||||
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
Copyright 2002-2008 The Apache Software Foundation
|
||||
Copyright 2010 The Apache Software Foundation
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
|
|
@ -18,24 +18,22 @@
|
|||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
|
||||
"http://forrest.apache.org/dtd/document-v20.dtd">
|
||||
|
||||
|
||||
<document>
|
||||
|
||||
<header>
|
||||
<document xmlns="http://maven.apache.org/XDOC/2.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
|
||||
<properties>
|
||||
<title>
|
||||
HBase ACID Properties
|
||||
</title>
|
||||
</header>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section>
|
||||
<title>About this Document</title>
|
||||
<section name="About this Document">
|
||||
<p>HBase is not an ACID compliant database. However, it does guarantee certain specific
|
||||
properties.</p>
|
||||
<p>This specification enumerates the ACID properties of HBase.</p>
|
||||
</section>
|
||||
<section>
|
||||
<title>Definitions</title>
|
||||
<section name="Definitions">
|
||||
<p>For the sake of common vocabulary, we define the following terms:</p>
|
||||
<dl>
|
||||
<dt>Atomicity</dt>
|
||||
|
|
@ -65,8 +63,7 @@
|
|||
is provided in a current release, users should not rely on it.
|
||||
</p>
|
||||
</section>
|
||||
<section>
|
||||
<title>APIs to consider</title>
|
||||
<section name="APIs to consider">
|
||||
<ul>
|
||||
<li>Read APIs
|
||||
<ul>
|
||||
|
|
@ -88,11 +85,9 @@
|
|||
</ul>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Guarantees Provided</title>
|
||||
<section name="Guarantees Provided">
|
||||
|
||||
<section>
|
||||
<title>Atomicity</title>
|
||||
<section name="Atomicity">
|
||||
|
||||
<ol>
|
||||
<li>All mutations are atomic within a row. Any put will either wholely succeed or wholely fail.</li>
|
||||
|
|
@ -119,8 +114,7 @@
|
|||
</ol>
|
||||
</ol>
|
||||
</section>
|
||||
<section>
|
||||
<title>Consistency and Isolation</title>
|
||||
<section name="Consistency and Isolation">
|
||||
<ol>
|
||||
<li>All rows returned via any access API will consist of a complete row that existed at
|
||||
some point in the table's history.</li>
|
||||
|
|
@ -130,7 +124,7 @@
|
|||
<li>The state of a row will only move forward through the history of edits to it.</li>
|
||||
</ol>
|
||||
|
||||
<section><title>Consistency of Scans</title>
|
||||
<section name="Consistency of Scans">
|
||||
<p>
|
||||
A scan is <strong>not</strong> a consistent view of a table. Scans do
|
||||
<strong>not</strong> exhibit <em>snapshot isolation</em>.
|
||||
|
|
@ -172,8 +166,7 @@
|
|||
</p>
|
||||
</section>
|
||||
</section>
|
||||
<section>
|
||||
<title>Visibility</title>
|
||||
<section name="Visibility">
|
||||
<ol>
|
||||
<li> When a client receives a "success" response for any mutation, that
|
||||
mutation is immediately visible to both that client and any client with whom it
|
||||
|
|
@ -191,8 +184,7 @@
|
|||
</ol>
|
||||
|
||||
</section>
|
||||
<section>
|
||||
<title>Durability</title>
|
||||
<section name="Durability">
|
||||
<ol>
|
||||
<li> All visible data is also durable data. That is to say, a read will never return
|
||||
data that has not been made durable on disk[1]</li>
|
||||
|
|
@ -204,8 +196,7 @@
|
|||
|
||||
</ol>
|
||||
</section>
|
||||
<section>
|
||||
<title>Tunability</title>
|
||||
<section name="Tunability">
|
||||
<p>All of the above guarantees must be possible within HBase. For users who would like to trade
|
||||
off some guarantees for performance, HBase may offer several tuning options. For example:</p>
|
||||
<ul>
|
||||
|
|
@ -214,8 +205,7 @@
|
|||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section>
|
||||
<title>Footnotes</title>
|
||||
<section name="Footnotes">
|
||||
|
||||
<p>[1] In the context of HBase, "durably on disk" implies an hflush() call on the transaction
|
||||
log. This does not actually imply an fsync() to magnetic media, but rather just that the data has been
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
Copyright 2010 The Apache Software Foundation
|
||||
|
||||
|
|
@ -14,21 +14,16 @@
|
|||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
|
||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
|
||||
"http://forrest.apache.org/dtd/document-v20.dtd">
|
||||
|
||||
|
||||
<document>
|
||||
|
||||
<header>
|
||||
<document xmlns="http://maven.apache.org/XDOC/2.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
|
||||
<properties>
|
||||
<title>
|
||||
Bulk Loads in HBase
|
||||
</title>
|
||||
</header>
|
||||
</properties>
|
||||
<body>
|
||||
<section>
|
||||
<title>Overview</title>
|
||||
<section name="Overview">
|
||||
<p>
|
||||
HBase includes several methods of loading data into tables.
|
||||
The most straightforward method is to either use the TableOutputFormat
|
||||
|
|
@ -42,13 +37,11 @@
|
|||
cluster.
|
||||
</p>
|
||||
</section>
|
||||
<section>
|
||||
<title>Bulk Load Architecture</title>
|
||||
<section name="Bulk Load Architecture">
|
||||
<p>
|
||||
The HBase bulk load process consists of two main steps.
|
||||
</p>
|
||||
<subsection>
|
||||
<title>Preparing data via a MapReduce job</title>
|
||||
<section name="Preparing data via a MapReduce job">
|
||||
<p>
|
||||
The first step of a bulk load is to generate HBase data files from
|
||||
a MapReduce job using HFileOutputFormat. This output format writes
|
||||
|
|
@ -67,9 +60,8 @@
|
|||
which automatically sets up a TotalOrderPartitioner based on the current
|
||||
region boundaries of a table.
|
||||
</p>
|
||||
</subsection>
|
||||
<subsection>
|
||||
<title>Completing the data load</title>
|
||||
</section>
|
||||
<section name="Completing the data load">
|
||||
<p>
|
||||
After the data has been prepared using <code>HFileOutputFormat</code>, it
|
||||
is loaded into the cluster using a command line tool. This command line tool
|
||||
|
|
@ -87,10 +79,9 @@
|
|||
preparing a bulk load and importing it into the cluster, especially
|
||||
if other clients are simultaneously loading data through other means.
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
</section>
|
||||
<section>
|
||||
<title>Preparing a bulk load using the <code>importtsv</code> tool</title>
|
||||
<section name="Preparing a bulk load using the importtsv tool">
|
||||
<p>
|
||||
HBase ships with a command line tool called <code>importtsv</code>. This tool
|
||||
is available by running <code>hadoop jar /path/to/hbase-VERSION.jar importtsv</code>.
|
||||
|
|
@ -115,8 +106,7 @@ Other options that may be specified with -D include:
|
|||
-Dimporttsv.skip.bad.lines=false - fail if encountering an invalid line
|
||||
</pre></code>
|
||||
</section>
|
||||
<section>
|
||||
<title>Importing the prepared data using the <code>completebulkload</code> tool</title>
|
||||
<section name="Importing the prepared data using the completebulkload tool">
|
||||
<p>
|
||||
After a data import has been prepared using the <code>importtsv</code> tool, the
|
||||
<code>completebulkload</code> tool is used to import the data into the running cluster.
|
||||
|
|
@ -131,8 +121,7 @@ Other options that may be specified with -D include:
|
|||
the cluster.
|
||||
</p>
|
||||
</section>
|
||||
<section>
|
||||
<title>Advanced Usage</title>
|
||||
<section name="Advanced Usage">
|
||||
<p>
|
||||
Although the <code>importtsv</code> tool is useful in many cases, advanced users may
|
||||
want to generate data programatically, or import data from other formats. To get
|
||||
|
|
@ -145,4 +134,4 @@ Other options that may be specified with -D include:
|
|||
</p>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
</document>
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
Copyright 2002-2008 The Apache Software Foundation
|
||||
Copyright 2010 The Apache Software Foundation
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
|
|
@ -14,36 +14,29 @@
|
|||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
|
||||
"http://forrest.apache.org/dtd/document-v20.dtd">
|
||||
|
||||
|
||||
<document>
|
||||
<header>
|
||||
<document xmlns="http://maven.apache.org/XDOC/2.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
|
||||
<properties>
|
||||
<title>Installing HBase on Windows using Cygwin</title>
|
||||
</header>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section>
|
||||
<title>Introduction</title>
|
||||
<section name="Introduction">
|
||||
<p><a title="HBase project" href="http://hadoop.apache.org/hbase" target="_blank">HBase</a> is a distributed, column-oriented store, modeled after Google's <a title="Google's BigTable" href="http://labs.google.com/papers/bigtable.html" target="_blank">BigTable</a>. HBase is built on top of <a title="Hadoop project" href="http://hadoop.apache.org">Hadoop</a> for its <a title="Hadoop MapReduce project" href="http://hadoop.apache.org/mapreduce" target="_blank">MapReduce </a>and <a title="Hadoop DFS project" href="http://hadoop.apache.org/hdfs">distributed file system</a> implementation. All these projects are open-source and part of the <a title="The Apache Software Foundation" href="http://www.apache.org/" target="_blank">Apache Software Foundation</a>.</p>
|
||||
|
||||
<p style="text-align: justify; ">As being distributed, large scale platforms, the Hadoop and HBase projects mainly focus on <em><strong>*nix</strong></em><strong> environments</strong> for production installations. However, being developed in <strong>Java</strong>, both projects are fully <strong>portable</strong> across platforms and, hence, also to the <strong>Windows operating system</strong>. For ease of development the projects rely on <a title="Cygwin site" href="http://www.cygwin.com/" target="_blank">Cygwin</a> to have a *nix-like environment on Windows to run the shell scripts.</p>
|
||||
</section>
|
||||
<section>
|
||||
<title>Purpose</title>
|
||||
<section name="Purpose">
|
||||
<p style="text-align: justify; ">This document explains the <strong>intricacies of running HBase on Windows using Cygwin</strong> as an all-in-one single-node installation for testing and development. The HBase <a title="HBase Overview" href="http://hadoop.apache.org/hbase/docs/current/api/overview-summary.html#overview_description" target="_blank">Overview</a> and <a title="HBase QuickStart" href="http://hadoop.apache.org/common/docs/current/quickstart.html" target="_blank">QuickStart</a> guides on the other hand go a long way in explaning how to setup <a title="HBase project" href="http://hadoop.apache.org/hbase" target="_blank">HBase</a> in more complex deployment scenario's.</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title >Installation</title>
|
||||
<section name="Installation">
|
||||
<p style="text-align: justify; ">For running HBase on Windows, 3 technologies are required: <strong>Java, Cygwin and SSH</strong>. The following paragraphs detail the installation of each of the aforementioned technologies.</p>
|
||||
<section>
|
||||
<title>Java</title>
|
||||
<section name="Java">
|
||||
<p style="text-align: justify; ">HBase depends on the <a title="Java Platform, Standard Edition, 6 Release" href="http://java.sun.com/javase/6/" target="_blank">Java Platform, Standard Edition, 6 Release</a>. So the target system has to be provided with at least the Java Runtime Environment (JRE); however if the system will also be used for development, the Jave Development Kit (JDK) is preferred. You can download the latest versions for both from <a title="Java SE Downloads" href="http://java.sun.com/javase/downloads/index.jsp" target="_blank">Sun's download page</a>. Installation is a simple GUI wizard that guides you through the process.</p>
|
||||
</section>
|
||||
<section>
|
||||
<title>Cygwin</title>
|
||||
<section name="Cygwin">
|
||||
<p style="text-align: justify; ">Cygwin is probably the oddest technology in this solution stack. It provides a dynamic link library that emulates most of a *nix environment on Windows. On top of that a whole bunch of the most common *nix tools are supplied. Combined, the DLL with the tools form a very *nix-alike environment on Windows.</p>
|
||||
|
||||
<p style="text-align: justify; ">For installation, Cygwin provides the <a title="Cygwin Setup Utility" href="http://cygwin.com/setup.exe" target="_blank"><strong><code>setup.exe</code> utility</strong></a> that tracks the versions of all installed components on the target system and provides the mechanism for <strong>installing</strong> or <strong>updating </strong>everything from the mirror sites of Cygwin.</p>
|
||||
|
|
@ -80,7 +73,7 @@
|
|||
<li>When needed, to <strong>uninstall</strong> Cygwin you can simply delete the <strong>Root</strong> and <strong>Local Package</strong> directory, and the <strong>shortcuts</strong> that were created during installation.</li>
|
||||
</ol>
|
||||
</section>
|
||||
<section><title>SSH</title>
|
||||
<section name="SSH">
|
||||
<p style="text-align: justify; ">HBase (and Hadoop) rely on <a title="Secure Shell" href="http://nl.wikipedia.org/wiki/Secure_Shell" target="_blank"><strong>SSH</strong></a> for interprocess/-node <strong>communication</strong> and launching<strong> remote commands</strong>. SSH will be provisioned on the target system via Cygwin, which supports running Cygwin programs as <strong>Windows services</strong>!</p>
|
||||
|
||||
<ol style="text-align: justify; ">
|
||||
|
|
@ -98,18 +91,15 @@
|
|||
<li>Wait for the install to complete and finish the installation.</li>
|
||||
</ol>
|
||||
</section>
|
||||
<section>
|
||||
<title>HBase</title>
|
||||
<section name="HBase">
|
||||
<p style="text-align: justify; ">Download the <strong>latest release </strong>of HBase from the <a title="HBase Releases" href="http://hadoop.apache.org/hbase/releases.html" target="_blank">website</a>. As the HBase distributable is just a zipped archive, installation is as simple as unpacking the archive so it ends up in its final <strong>installation</strong> directory. Notice that HBase has to be installed in Cygwin and a good directory suggestion is to use <code>/usr/local/</code> (or [<code><strong>Root</strong> directory]\usr\local</code> in Windows slang). You should end up with a <code>/usr/local/hbase-<em><version></em></code> installation in Cygwin.</p>
|
||||
|
||||
This finishes installation. We go on with the configuration.
|
||||
</section>
|
||||
</section>
|
||||
<section>
|
||||
<title>Configuration</title>
|
||||
<section name="Configuration">
|
||||
<p style="text-align: justify; ">There are 3 parts left to configure: <strong>Java, SSH and HBase</strong> itself. Following paragraphs explain eacht topic in detail.</p>
|
||||
<section>
|
||||
<title>Java</title>
|
||||
<section name="Java">
|
||||
<p style="text-align: justify; ">One important thing to remember in shell scripting in general (i.e. *nix and Windows) is that managing, manipulating and assembling path names that contains spaces can be very hard, due to the need to escape and quote those characters and strings. So we try to stay away from spaces in path names. *nix environments can help us out here very easily by using <strong>symbolic links</strong>.</p>
|
||||
|
||||
<ol style="text-align: justify; ">
|
||||
|
|
@ -180,8 +170,7 @@ This finishes installation. We go on with the configuration.
|
|||
</li>
|
||||
</ol>
|
||||
</section>
|
||||
<section>
|
||||
<title>HBase</title>
|
||||
<section name="HBase">
|
||||
If all previous configurations are working properly, we just need some tinkering at the <strong>HBase config</strong> files to properly resolve on Windows/Cygwin. All files and paths referenced here start from the HBase <code>[<strong>installation</strong> directory]</code> as working directory.
|
||||
<ol>
|
||||
<li>HBase uses the <code>./conf/<strong>hbase-env.sh</strong></code> to configure its dependencies on the runtime environment. Copy and uncomment following lines just underneath their original, change them to fit your environemnt. They should read something like:
|
||||
|
|
@ -244,8 +233,7 @@ put 'test', 'row3', 'data:3', 'value3'</pre>
|
|||
</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Conclusion</title>
|
||||
<section name="Conclusion">
|
||||
<p>
|
||||
Now your <strong>HBase </strong>server is running, <strong>start coding</strong> and build that next killer app on this particular, but scalable datastore!
|
||||
</p>
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
Copyright 2010 The Apache Software Foundation
|
||||
|
||||
Licensed 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.
|
||||
-->
|
||||
<document xmlns="http://maven.apache.org/XDOC/2.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
|
||||
<properties>
|
||||
<title>HBase Home</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="This is Apache HBase">
|
||||
<p>HBase is the <a href="http://hadoop.apache.org">Hadoop</a> database. Use it when you need random, realtime read/write access to your Big Data.
|
||||
This project's goal is the hosting of very large tables -- billions of rows X millions of columns -- atop clusters
|
||||
of commodity hardware.
|
||||
<img src="http://hbase.apache.org/images/hadoop-logo.jpg" align="right" style="border-style;none" />
|
||||
</p>
|
||||
</section>
|
||||
<section name="News">
|
||||
<p>June 30th, <a href="http://www.meetup.com/hbaseusergroup/calendar/13562846/">HBase Contributor Workshop</a> (Day after Hadoop Summit)</p>
|
||||
<p>May 10th, 2010: HBase graduates from Hadoop sub-project to Apache Top Level Project </p>
|
||||
<p>Signup for <a href="http://www.meetup.com/hbaseusergroup/calendar/12689490/">HBase User Group Meeting, HUG10</a> hosted by Trend Micro, April 19th, 2010</p>
|
||||
|
||||
<p><a href="http://www.meetup.com/hbaseusergroup/calendar/12689351/">HBase User Group Meeting, HUG9</a> hosted by Mozilla, March 10th, 2010</p>
|
||||
<p>Sign up for the <a href="http://www.meetup.com/hbaseusergroup/calendar/12241393/">HBase User Group Meeting, HUG8</a>, January 27th, 2010 at StumbleUpon in SF</p>
|
||||
<p>September 8th, 2010: HBase 0.20.0 is faster, stronger, slimmer, and sweeter tasting than any previous HBase release. Get it off the <a href="releases.html">Releases</a> page.</p>
|
||||
<p><a href="http://dev.us.apachecon.com/c/acus2009/">ApacheCon</a> in Oakland: November 2-6th, 2009:
|
||||
The Apache Foundation will be celebrating its 10th anniversary in beautiful Oakland by the Bay. Lots of good talks and meetups including an HBase presentation by a couple of the lads.</p>
|
||||
<p>HBase at Hadoop World in NYC: October 2nd, 2009: A few of us will be talking on Practical HBase out east at <a href="http://www.cloudera.com/hadoop-world-nyc">Hadoop World: NYC</a>.</p>
|
||||
<p>HUG7 and HBase Hackathon: August 7th-9th, 2009 at StumbleUpon in SF: Sign up for the <a href="http://www.meetup.com/hbaseusergroup/calendar/10950511/">HBase User Group Meeting, HUG7</a> or for the <a href="http://www.meetup.com/hackathon/calendar/10951718/">Hackathon</a> or for both (all are welcome!).</p>
|
||||
<p>June, 2009 -- HBase at HadoopSummit2009 and at NOSQL: See the <a href="http://wiki.apache.org/hadoop/HBase/HBasePresentations">presentations</a></p>
|
||||
<p>March 3rd, 2009 -- HUG6: <a href="http://www.meetup.com/hbaseusergroup/calendar/9764004/">HBase User Group 6</a></p>
|
||||
<p>January 30th, 2009 -- LA Hbackathon:<a href="http://www.meetup.com/hbasela/calendar/9450876/">HBase January Hackathon Los Angeles</a> at <a href="http://streamy.com" >Streamy</a> in Manhattan Beach</p>
|
||||
</section>
|
||||
</body>
|
||||
|
||||
</document>
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
Copyright 2002-2008 The Apache Software Foundation
|
||||
Copyright 2010 The Apache Software Foundation
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
|
|
@ -14,22 +14,17 @@
|
|||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
|
||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
|
||||
"http://forrest.apache.org/dtd/document-v20.dtd">
|
||||
|
||||
|
||||
<document>
|
||||
|
||||
<header>
|
||||
<document xmlns="http://maven.apache.org/XDOC/2.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
|
||||
<properties>
|
||||
<title>
|
||||
HBase Metrics
|
||||
</title>
|
||||
</header>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section>
|
||||
<title> Introduction </title>
|
||||
<section name="Introduction">
|
||||
<p>
|
||||
HBase emits Hadoop <a href="http://hadoop.apache.org/core/docs/current/api/org/apache/hadoop/metrics/package-summary.html">metrics</a>.
|
||||
</p>
|
||||
|
|
@ -64,16 +59,14 @@
|
|||
</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title> Using with JMX </title>
|
||||
<section name="Using with JMX">
|
||||
<p>
|
||||
In addition to the standard output contexts supported by the Hadoop
|
||||
metrics package, you can also export HBase metrics via Java Management
|
||||
Extensions (JMX). This will allow viewing HBase stats in JConsole or
|
||||
any other JMX client.
|
||||
</p>
|
||||
<section>
|
||||
<title>Enable HBase stats collection</title>
|
||||
<section name="Enable HBase stats collection">
|
||||
<p>
|
||||
To enable JMX support in HBase, first edit
|
||||
<code>$HBASE_HOME/conf/hadoop-metrics.properties</code> to support
|
||||
|
|
@ -95,8 +88,7 @@ rpc.class=org.apache.hadoop.metrics.spi.NullContextWithUpdateThread
|
|||
rpc.period=60
|
||||
</source>
|
||||
</section>
|
||||
<section>
|
||||
<title>Setup JMX remote access</title>
|
||||
<section name="Setup JMX remote access">
|
||||
<p>
|
||||
For remote access, you will need to configure JMX remote passwords
|
||||
and access profiles. Create the files:
|
||||
|
|
@ -120,8 +112,7 @@ controlRole readwrite
|
|||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section>
|
||||
<title>Configure JMX in HBase startup</title>
|
||||
<section name="Configure JMX in HBase startup">
|
||||
<p>
|
||||
Finally, edit the <code>$HBASE_HOME/conf/hbase-env.sh</code>
|
||||
script to add JMX support:
|
||||
Loading…
Reference in New Issue