Skip to content
This repository has been archived by the owner on Jan 7, 2021. It is now read-only.

XP-1007 Document toolbox load command #1

Merged
merged 1 commit into from
Jul 14, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/reference/toolbox/dump.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
dump
====

Export every branch in specified repository. This is used to backup the entire
repository when doing a upgrade. The result will be stored in
Export every repository branch. This is used to backup the entire
repository when doing an upgrade. The result will be stored in
the ``$XP_HOME/data/dump`` directory.

**Usage:**

.. code-block:: none

NAME
toolbox dump - Export every branch in specified repository.
toolbox dump - Export all nodes.

SYNOPSIS
toolbox dump -a <auth> [-h <host>] [-p <port>] -t <target>
Expand Down
4 changes: 2 additions & 2 deletions doc/reference/toolbox/export.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
export
======

Extract data for a given repo and content path. The result will be stored in the
Extract data for a given repo, branch and content path. The result will be stored in the
``$XP_HOME/data/export`` directory.

**Usage:**

.. code-block:: none

NAME
toolbox export - Export node from a branch in a repository.
toolbox export - Export nodes from a repository branch.

SYNOPSIS
toolbox export -a <auth> [-h <host>] [-p <port>] -s <sourceRepoPath>
Expand Down
6 changes: 4 additions & 2 deletions doc/reference/toolbox/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@ To get help for the commands, just type the following::

The most commonly used toolbox commands are:
delete-snapshots Deletes snapshots, either before a given timestamp or by name.
dump Export every branch in specified repository.
export Export node from a branch in a repository.
dump Export all nodes.
export Export nodes from a repository branch.
help Display help information
import Import nodes from an export into a repository branch.
list-snapshots Returns a list of existing snapshots with name and status.
load Import nodes from a dump.
reindex Reindex content in search indices for the given repository and branches.
restore Restores a snapshot of a previous state of the repository.
snapshot Stores a snapshot of the current state of the repository.
Expand All @@ -44,3 +45,4 @@ Here's a list of all the commands that you can do with the toolbox:
import
reindex
dump
load
34 changes: 34 additions & 0 deletions doc/reference/toolbox/load.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
load
====

Load will take data from a named dump and load it into Enonic XP. The dump read has to be stored in
the ``$XP_HOME/data/dump`` directory.

**Usage:**

.. code-block:: none

NAME
toolbox load - Import nodes from a dump.

SYNOPSIS
toolbox load -a <auth> [-h <host>] [-p <port>] -s <source>

OPTIONS
-a <auth>
Authentication token for basic authentication (user:password).

-h <host>
Host name for server (default is localhost).

-p <port>
Port number for server (default is 8080).

-s <source>
Dump name.

**Example:**

.. code-block:: none

$ ./toolbox.sh load -a su:password -s myDump