Find Document

Seaches for a document.

• CLI Installation

• Commands Reference

• Universal Parameters

• URL-based Input/Output

Command

# local game data (windows)
dotnet charon DATA FIND --dataBase "c:\my app\gamedata.json" --schema Character --id John

# remote game data
dotnet charon DATA FIND --dataBase "https://charon.live/view/data/My_Game/develop/" --schema Character --id John --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 document.

# name
--schema Item

# id
--schema 55a4f32faca22e191098f3d9

--id

Identifier of document.

# text
--id Sword

# number
--id 101

--output

Path to a found document file. 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 (default)
--output out
--output con

# standart error
--output err

# null device
--output null

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

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

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

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

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

--outputFormat

Format of exported data.

# JSON (default)
--outputFormat json

# BSON
--outputFormat bson

# Message Pack
--outputFormat msgpack

# XML (removed in 2025.1.1)
--outputFormat xml

--outputFormattingOptions

Additional options for specified format.

This command supports universal parameters.

Output

Outputs the found document.

{
  "Id": "John"

  /* rest of properties of found document */
}