Documentation

Unity Gaming Services CLI

GitHub Repository

Unity Gaming Services CLI

Query Custom Data

Query custom entity data using an existing index.
Read time 1 minuteLast updated 21 hours ago
Query custom data. If no index is available to fulfill the query then the query will fail. Authentication Required: 
Yes
 
ugs cloud-save data custom query [options]

Arguments

<visibility>
A string representing the visibility of the index. Must be one of 
default
or 
private
. 
<body>
The index query in JSON. If this is a file path, the content of the file is used; otherwise, the raw string is used. Sample Query String 
--body "{"fields":\[{"key":"EXAMPLE_KEY","value":"example_value","op":"EQ","asc":true}],"returnKeys":\["EXAMPLE_KEY"],"offset":0,"limit":100,"sampleSize":100}"
 Sample Query Body File 
{  "fields": [    {      "key": "EXAMPLE_KEY",      "value": "example_value",      "op": "EQ",      "asc": true    }  ],  "returnKeys": [    "EXAMPLE_KEY"  ],  "offset": 0,  "limit": 100,  "sampleSize": 100}

Documentation

For more documentation on querying indexes, see the Unity Service API Docs.

Options

Option

Alias

Description

project-id-p, --project-idThe Unity cloud project ID.
environment-name-e, --environment-nameThe services environment name.
help-?, -h, --helpDisplay help and usage information.
quiet-q, --quietReduce logging to a minimum.
json-j, --jsonUse JSON as the output format.