mytardis schema

usage: mytardis schema [-h] {list,get} ...

Positional Arguments

command

Possible choices: list, get

available commands

Sub-commands:

list

Display a list of schema records.

mytardis schema list
    [--limit LIMIT] [--offset OFFSET] [--order_by ORDER_BY] [--json]

  EXAMPLE

  $ mytardis schema list

  Model: Schema
  Query: http://mytardisdemo.erc.monash.edu.au/api/v1/schema/?format=json
  Total Count: 13
  Limit: 20
  Offset: 0

  +----+---------------------------+-----------------------------------------------------------+-------------------+---------+-----------+--------+
  | ID |           Name            |                         Namespace                         |       Type        | Subtype | Immutable | Hidden |
  +====+===========================+===========================================================+===================+=========+===========+========+
  |  1 | Publication               | http://www.tardis.edu.au/schemas/publication/             | Experiment schema |         | True      | True   |
  +----+---------------------------+-----------------------------------------------------------+-------------------+---------+-----------+--------+
  |  2 | Draft Publication         | http://www.tardis.edu.au/schemas/publication/draft/       | Experiment schema |         | True      | True   |
  +----+---------------------------+-----------------------------------------------------------+-------------------+---------+-----------+--------+
  |  3 | Publication Details       | http://www.tardis.edu.au/schemas/publication/details/     | Experiment schema |         | True      | False  |
  +----+---------------------------+-----------------------------------------------------------+-------------------+---------+-----------+--------+
  |  8 | MyData Default Experiment | http://mytardis.org/schemas/mydata/defaultexperiment      | Experiment schema |         | True      | True   |
  +----+---------------------------+-----------------------------------------------------------+-------------------+---------+-----------+--------+
  | 13 | Sample Dataset Schema     | https://mytardis.org/schemas/sample-dataset-schema        | Dataset schema    |         | False     | False  |
  +----+---------------------------+-----------------------------------------------------------+-------------------+---------+-----------+--------+
  | 12 | Sample Experiment Schema  | https://mytardis.org/schemas/sample-experiment-schema     | Experiment schema |         | False     | False  |
  +----+---------------------------+-----------------------------------------------------------+-------------------+---------+-----------+--------+

Named Arguments

--limit

Maximum number of results to return.

--offset

Skip this many records from the start of the result set.

--order_by

Order by this field.

--json

Display results in JSON format.

Default: False

get

Display a single schema record.

mytardis schema get [--params] [--json] schema_id

  EXAMPLE

  $ mytardis schema get 12
  +--------------+-------------------------------------------------------+
  | Schema field |                         Value                         |
  +==============+=======================================================+
  | ID           | 12                                                    |
  +--------------+-------------------------------------------------------+
  | Name         | Sample Experiment Schema                              |
  +--------------+-------------------------------------------------------+
  | Namespace    | https://mytardis.org/schemas/sample-experiment-schema |
  +--------------+-------------------------------------------------------+
  | Type         | Experiment schema                                     |
  +--------------+-------------------------------------------------------+
  | Subtype      |                                                       |
  +--------------+-------------------------------------------------------+
  | Immutable    | False                                                 |
  +--------------+-------------------------------------------------------+
  | Hidden       | False                                                 |
  +--------------+-------------------------------------------------------+

  +------------------+-----------------------+-----------------------+-----------+-------+-----------+---------------+-------+---------+-----------------+
  | ParameterName ID |       Full Name       |         Name          | Data Type | Units | Immutable | Is Searchable | Order | Choices | Comparison Type |
  +==================+=======================+=======================+===========+=======+===========+===============+=======+=========+=================+
  |               33 | Sample Parameter Name | sample_parameter_name | String    |       | False     | False         | 9999  |         | Exact value     |
  +------------------+-----------------------+-----------------------+-----------+-------+-----------+---------------+-------+---------+-----------------+

Positional Arguments

schema_id

The schema ID.

Named Arguments

--params

Display parameter names.

Default: False

--json

Display results in JSON format.

Default: False