xrpl-dev-portal/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/node_to_shard.md

html, parent, seo, labels

html	parent	seo	labels
node_to_shard.html	logging-and-data-management-methods.html	description Copy data from the ledger store into the shard store.	Data Retention

node_to_shard

[Source]

The {% code-page-name /%} method manages copying data from the ledger store to the shard store. It can start, stop, or check the status of copying the data.

The {% code-page-name /%} method is an admin method that cannot be run by unprivileged users.

Request Format

An example of the request format:

{% tabs %}

{% tab label="WebSocket" %}

{
    "command": "{% $frontmatter.seo.title %}",
    "action": "start"
}

{% /tab %}

{% tab label="JSON-RPC" %}

{
    "method": "{% $frontmatter.seo.title %}",
    "params": [{
        "action": "start"
    }]
}

{% /tab %}

{% tab label="Commandline" %}

#Syntax: {% $frontmatter.seo.title %} start|stop|status
rippled {% $frontmatter.seo.title %} start

{% /tab %}

{% /tabs %}

The request includes the following parameters:

Field	Type	Description
action	String	Either start, stop or status depending on what action to take.

Response Format

An example of a successful response:

{% tabs %}

{% tab label="WebSocket" %}

{
  "result": {
    "message": "Database import initiated..."
  },
  "status": "success",
  "type": "response"
}

{% /tab %}

{% tab label="JSON-RPC" %}

{
   "result" : {
      "message" : "Database import initiated...",
      "status" : "success"
   }
}

{% /tab %}

{% tab label="Commandline" %}

Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005

{
   "result" : {
      "message" : "Database import initiated...",
      "status" : "success"
   }
}

{% /tab %}

{% /tabs %}

The response follows the [standard format][], with a successful result containing the following fields:

Field	Type	Description
message	String	A human-readable message indicating the action taken in response to the command.

Possible Errors

• Any of the [universal error types][].
• internal - If you attempt an invalid operation like checking the status of a copy when one isn't running.
• notEnabled - If the server is not configured to store history shards.
• invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.

{% raw-partial file="/_snippets/common-links.md" /%}