diff --git a/cmd/neofs-cli/modules/object/search.go b/cmd/neofs-cli/modules/object/search.go index 72f0052217..946d2b9ab2 100644 --- a/cmd/neofs-cli/modules/object/search.go +++ b/cmd/neofs-cli/modules/object/search.go @@ -31,19 +31,33 @@ var ( var ( searchFilters []string + searchFiltersUsage = "Repeated filter expressions ('key OP value' or 'key NOPRESENT') or files with protobuf JSON" + + searchExample = ` neofs-cli object search --cid --filters 'FilePath EQ cat.jpg' + neofs-cli object search --cid --filters 'Timestamp GE 1710000000' --filters 'Timestamp LE 1719999999' + neofs-cli object search --cid --filters 'FileName NOPRESENT' + neofs-cli object search --cid --filters filters.json` + + searchV2Example = ` neofs-cli object searchv2 --cid --filters 'FilePath EQ cat.jpg' + neofs-cli object searchv2 --cid --filters 'Timestamp GE 1710000000' --filters 'Timestamp LE 1719999999' + neofs-cli object searchv2 --cid --filters 'FileName NOPRESENT' + neofs-cli object searchv2 --cid --filters filters.json` + objectSearchCmd = &cobra.Command{ - Use: "search", - Short: "Search object", - Long: "Search object", - Args: cobra.NoArgs, - RunE: searchV2, + Use: "search", + Short: "Search object", + Long: "Search object", + Example: searchExample, + Args: cobra.NoArgs, + RunE: searchV2, } searchV2Cmd = &cobra.Command{ - Use: objectSearchCmd.Use + "v2", - Short: objectSearchCmd.Short + " (deprecated)", // TODO: drop suffix on old search deprecation - Long: objectSearchCmd.Long + " (compatibility, deprecated)", // TODO: desc in details - Args: objectSearchCmd.Args, - RunE: searchV2, + Use: objectSearchCmd.Use + "v2", + Short: objectSearchCmd.Short + " (deprecated)", // TODO: drop suffix on old search deprecation + Long: objectSearchCmd.Long + " (compatibility, deprecated)", // TODO: desc in details + Example: searchV2Example, + Args: objectSearchCmd.Args, + RunE: searchV2, } ) @@ -61,10 +75,8 @@ func initObjectSearchCmd() { flags2.String(commonflags.CIDFlag, "", commonflags.CIDFlagUsage) _ = searchV2Cmd.MarkFlagRequired(commonflags.CIDFlag) - flags.StringSliceVarP(&searchFilters, "filters", "f", nil, - "Repeated filter expressions or files with protobuf JSON") - flags2.StringSliceVarP(&searchFilters, "filters", "f", nil, - "Repeated filter expressions or files with protobuf JSON") + flags.StringSliceVarP(&searchFilters, "filters", "f", nil, searchFiltersUsage) + flags2.StringSliceVarP(&searchFilters, "filters", "f", nil, searchFiltersUsage) flags.Bool("root", false, "Search for user objects") flags2.Bool("root", false, "Search for user objects") diff --git a/docs/cli-commands/neofs-cli_object_search.md b/docs/cli-commands/neofs-cli_object_search.md index 5934560e10..f1f1930da6 100644 --- a/docs/cli-commands/neofs-cli_object_search.md +++ b/docs/cli-commands/neofs-cli_object_search.md @@ -10,6 +10,15 @@ Search object neofs-cli object search [flags] ``` +### Examples + +``` + neofs-cli object search --cid --filters 'FilePath EQ cat.jpg' + neofs-cli object search --cid --filters 'Timestamp GE 1710000000' --filters 'Timestamp LE 1719999999' + neofs-cli object search --cid --filters 'FileName NOPRESENT' + neofs-cli object search --cid --filters filters.json +``` + ### Options ``` @@ -19,7 +28,7 @@ neofs-cli object search [flags] --cid string Container ID. --count uint16 Max number of resulting items. Must not exceed 1000 --cursor string Cursor to continue previous search - -f, --filters strings Repeated filter expressions or files with protobuf JSON + -f, --filters strings Repeated filter expressions ('key OP value' or 'key NOPRESENT') or files with protobuf JSON -g, --generate-key Generate new private key -h, --help help for search --phy Search physically stored objects diff --git a/docs/cli-commands/neofs-cli_object_searchv2.md b/docs/cli-commands/neofs-cli_object_searchv2.md index 5216836c30..9d72bfeb8b 100644 --- a/docs/cli-commands/neofs-cli_object_searchv2.md +++ b/docs/cli-commands/neofs-cli_object_searchv2.md @@ -10,6 +10,15 @@ Search object (compatibility, deprecated) neofs-cli object searchv2 [flags] ``` +### Examples + +``` + neofs-cli object searchv2 --cid --filters 'FilePath EQ cat.jpg' + neofs-cli object searchv2 --cid --filters 'Timestamp GE 1710000000' --filters 'Timestamp LE 1719999999' + neofs-cli object searchv2 --cid --filters 'FileName NOPRESENT' + neofs-cli object searchv2 --cid --filters filters.json +``` + ### Options ``` @@ -19,7 +28,7 @@ neofs-cli object searchv2 [flags] --cid string Container ID. --count uint16 Max number of resulting items. Must not exceed 1000 --cursor string Cursor to continue previous search - -f, --filters strings Repeated filter expressions or files with protobuf JSON + -f, --filters strings Repeated filter expressions ('key OP value' or 'key NOPRESENT') or files with protobuf JSON -g, --generate-key Generate new private key -h, --help help for searchv2 --phy Search physically stored objects