datalad
0.9.x
  • Getting started
  • Change log
  • Acknowledgments
  • Background and motivation
  • Delineation from related solutions
  • Basic principles
  • Data management use cases
  • Meta data
  • Customization and extension of functionality
  • Frequently asked questions
  • Glossary
  • Command line reference
    • Main command
    • Dataset operations
    • Meta data handling
      • datalad-search
        • Synopsis
        • Description
        • Options
        • Authors
      • datalad-metadata
      • datalad-aggregate-metadata
    • Reproducible execution
    • Miscellaneous commands
    • Plumbing commands
  • Python module reference
  • Configuration
  • Automatic creation and maintenance of datasets by crawling external resources
datalad
  • Docs »
  • Command line reference »
  • datalad-search
  • Edit on GitHub

datalad-search¶

Synopsis¶

datalad-search [-h] [-d DATASET] [-s PROPERTY] [-r PROPERTY] [-R] [-f FORMAT] [--regex] STRING [STRING ...]

Description¶

Search within available in datasets’ meta data

Options¶

STRING¶

a string (or a regular expression if –regex) to search for in all meta data values. If multiple provided, all must have a match among some fields of a dataset.

-h, –help, –help-np¶

show this help message. –help-np forcefully disables the use of a pager for displaying the help message

-d DATASET, –dataset DATASET¶

specify the dataset to perform the query operation on. If no dataset is given, an attempt is made to identify the dataset based on the current working directory and/or the PATH given. Constraints: Value must be a Dataset or a valid identifier of a Dataset (e.g. a path) [Default: None]

-s PROPERTY, –search PROPERTY¶

name of the property to search for any match. This option can be given multiple times. By default, all properties are searched. [Default: None]

-r PROPERTY, –report PROPERTY¶

name of the property to report for any match. This option can be given multiple times. If ‘*’ is given, all properties are reported. [Default: None]

-R, –report-matched¶

flag to report those fields which have matches. If REPORT option values are provided, union of matched and those in REPORT will be output. [Default: False]

-f FORMAT, –format FORMAT¶

format for output. Constraints: value must be one of (‘custom’, ‘json’, ‘yaml’) [Default: ‘custom’]

–regex¶

flag for STRING to be used as a (Python) regular expression which should match the value. [Default: False]

Authors¶

datalad is developed by The DataLad Team and Contributors <team@datalad.org>.

Next Previous

© Copyright 2016, DataLad team. Revision bce2a330.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: 0.9.x
Versions
latest
stable
docs
0.9.x
Downloads
pdf
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.