Skip to content

Commit

Permalink
fixup! visual update of hdfs paramters in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Beer committed Nov 2, 2015
1 parent c44c0c8 commit 6daba80
Showing 1 changed file with 33 additions and 38 deletions.
71 changes: 33 additions & 38 deletions docs/sql/reference/create_repository.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Synopsis
Description
===========

CREATE REPOSITORY will register a new repository in the cluster.
``CREATE REPOSITORY`` will register a new repository in the cluster.

.. note::

Expand Down Expand Up @@ -79,38 +79,30 @@ by all master and data nodes in the cluster.
the possible locations for repositories inside the ``crate.yml`` file
under ``path.repo`` as list of strings.

Configuration parameters:
Parameters
~~~~~~~~~~

.. _ref-create-repository-types-fs-location:

location
~~~~~~~~

**Required**
location (**Required**)
An absolute or relative path to the directory where snapshots get stored.
If the path is relative, it will be appended to the first entry in the
:ref:`path.repo <conf-path-repo>` setting.

An absolute or relative path to the directory where snapshots get stored.
If the path is relative, it will be appended to the first entry in the
:ref:`path.repo <conf-path-repo>` setting.
Windows UNC paths are allowed as well, given server name and share are specified
and backslashes are properly escaped.

Windows UNC paths are allowed as well, given server name and share are specified
and backslashes are properly escaped.

Only paths starting with an entry from :ref:`path.repo <conf-path-repo>` are possible.
Only paths starting with an entry from :ref:`path.repo <conf-path-repo>` are possible.

compress
~~~~~~~~

``true`` (Default) or ``false``.
``true`` (Default) or ``false``.

Whether the metadata part of the snapshot should be compressed or not.
The actual table data is not compressed.
Whether the metadata part of the snapshot should be compressed or not.
The actual table data is not compressed.

chunk_size
~~~~~~~~~~

Defines the maximum size of a single file that gets created during snapshot creation.
Defaults to ``null``. So big files will not be split up into smaller chunks.

Defines the maximum size of a single file that gets created during snapshot creation.
Defaults to ``null``. So big files will not be split up into smaller chunks.

.. _ref-create-repository-types-hdfs:

Expand All @@ -124,30 +116,33 @@ Parameters

uri
HDFS uri of the form ``hdfs:// <host>:<port>/`` (optional).

If not given, the default filesystem URI for the given Hadoop HDFS configuration
is used.

user
The HDFS user as string (optional).
The HDFS user as string (optional).

path
HDFS filesystem path to where the data gets stored.
HDFS filesystem path to where the data gets stored.

load_defaults
``true`` (Default) or ``false``.
Whether or not to load the default Hadoop Configuration.

Whether or not to load the default Hadoop Configuration.

conf_location
Comma separated string of files to Hadoop XML configuration files to load.
Comma separated string of files to Hadoop XML configuration files to load.

conf.<key>
dynamic config values added to the Hadoop configuration.
dynamic config values added to the Hadoop configuration.

concurrent_streams
The number of concurrent streams to use for backup and restore (Default: 5).

The number of concurrent streams to use for backup and restore (Default: 5).
compress
``true`` (Default) or ``false``.

Whether the metadata part of the snapshot should be compressed or not.
The actual table data is not compressed.

Expand All @@ -164,13 +159,13 @@ A read-only repository that points to the location of
a :ref:`ref-create-repository-types-fs` repository via "http", "https", "ftp",
"file" and "jar" urls. It only allows for :ref:`ref-restore-snapshot` operations.

Parameters
~~~~~~~~~~

url
~~~

This url must point to the root of the shared :ref:`ref-create-repository-types-fs`
repository.
This url must point to the root of the shared :ref:`ref-create-repository-types-fs`
repository.

Due to security reasons only URLs that are whitelisted can be used. URLs can be
whitelisted in the ``crate.yml`` configuration file. See
:ref:`ref-configuration-repositories`.
Due to security reasons only URLs that are whitelisted can be used. URLs can be
whitelisted in the ``crate.yml`` configuration file. See
:ref:`ref-configuration-repositories`.

0 comments on commit 6daba80

Please sign in to comment.