Page tree

This page has not yet been translated to English.

Skip to end of metadata
Go to start of metadata

Deleting an existing document. ID is provided by input document or by id parameter. Input data must meet the requirements. Only the first document from the document array will be processed.

Example:

Charon.exe DATA DELETE --dataBase c:\myapp\gamedata.json --entity Character --id MyCharacter

Command parameters

ParameterTypeRequiredDescriptionExample
dataBase

string

yes

Path to game data file. Use quotation marks if your path contains spaces.

"c:\my app\gamedata.json"
/User/Data/gamedata.json
entity

list of strings

yes

Name or identifier of a entity of document.

Character

id

string

no

ID of a document being deleted. Either ID or path to input data is required.

MyCharacter

input

file, in, url

no

Path to a file containing the document being deleted. Alternatively, you can use Standart Input & URL.

"c:\my app\input.json"
/User/Data/input.json
http://example.com/input.json
inputFormat

auto, json, bson, msgpack, xml, xlsx

no

Format of the input data. See Supported data formats for more information. Can be identified automatically from file extension.

Default: auto.


inputFormattingOptions

See Supported data formats

no

Additional formatting parameters for input data. Depend on selected data format.


output

file, err, null, out, url

no

Path to the file to which deleted document (or error message) will be written. If the file exists, it will be overwritten. The directory must already exist. Alternatively, you can use output to Standart Error, Standart Output, dev/null & URL.
Default: null.

"c:\my app\output.json"
/User/Data/output.json
http://example.com/output.json
outputFormat

json, bson, msgpack, xml, xlsx

no

Format to use when saving output data. See Supported data formats for more information.

Default: json.


outputFormattingOptions

See Supported data formats

no

Additional formatting parameters for output data. Depend on selected data format.


Related pages