Delete Document

Deletes a document. For a bulk deletion use DATA IMPORT command with --mode delete.

• CLI Installation

• Commands Reference

• Universal Parameters

• URL-based Input/Output

Command

# local game data (windows)
Charon.exe DATA DELETE --dataBase "c:\my app\gamedata.json" --schema Item --id "Sword"

# remote game data
Charon.exe DATA DELETE --dataBase "https://charon.live/view/data/My_Game/develop/" --schema Item --id "Sword" --credentials "<API-Key>"

Parameters

--dataBase

Absolute or relative path to game data. Use quotation marks if your path contains spaces.

# local file
--dataBase "c:\my app\gamedata.json"

# remote server
--dataBase "https://charon.live/view/data/My_Game/develop/"

--credentials

The API key used to access remote server in case of –dataBase being URL.

--schema

Name or identifier of the type (schema) of deleting document.

# name
--schema Item

# id
--schema 55a4f32faca22e191098f3d9

--id

Identifier of deleting document.

# text
--id Sword

# number
--id 101

--output

The path to a file where the deleted document should be placed. If the file exists, it will be overwritten. The directory must already exist. Alternatively, you can output to Standard Error, Standard Output, /dev/null, or a URL.

# standart output
--output out
--output con

# standart error
--output err

# null device (default)
--output null

# absolute path (windows)
--output "c:\my app\deleted_item.json"

# absolute path (unix)
--output /user/data/deleted_item.json

# relative path (universal)
--output "./deleted_item.json"

# remote location (HTTP)
--output "http://example.com/deleted_item.json"

# remote location with authentication (FTP)
--output "ftp://user:password@example.com/deleted_item.json"

--outputFormat

Format for deleted document.

# JSON (default)
--outputFormat json

# BSON
--outputFormat bson

# Message Pack
--outputFormat msgpack

# XML
--outputFormat xml

--outputFormattingOptions

Additional options for specified format.

This command supports universal parameters.