{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Show command"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Help\n",
    "The help text for the `show` subcommand can be shown by passing  the `-h` flag."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "usage: metacatalog show [-h] [--version] [--connection CONNECTION] [--verbose]\n",
      "                        [--quiet] [--dev] [--logfile LOGFILE] [--names-only]\n",
      "                        [--limit LIMIT] [--where WHERE] [--truncate]\n",
      "                        {attributes,records} table\n",
      "\n",
      "positional arguments:\n",
      "  {attributes,records}  Element to be shown. attributes Show table attributes.\n",
      "                        records Show raw table records\n",
      "  table                 Table name.\n",
      "\n",
      "optional arguments:\n",
      "  -h, --help            show this help message and exit\n",
      "  --version, -v         Returns the module version\n",
      "  --connection CONNECTION, -C CONNECTION\n",
      "                        Connection string to the database instance.Follows the\n",
      "                        syntax: driver://user:password@host:port/database\n",
      "  --verbose, -V         Activate extended output.\n",
      "  --quiet, -q           Suppress any kind of output.\n",
      "  --dev                 Development mode. Unexpected errors will not be\n",
      "                        handled and the full traceback is printed to the\n",
      "                        screen.\n",
      "  --logfile LOGFILE     If a file is given, output will be written to that\n",
      "                        file instead of printed to StdOut.\n",
      "  --names-only          Show only the attribute names. Only valid with\n",
      "                        'attribute' action.\n",
      "  --limit LIMIT, -L LIMIT\n",
      "                        Only valid with 'records' action. Will limit the\n",
      "                        number of records returned\n",
      "  --where WHERE         Only valid with 'records' action. Raw SQL WHERE clause\n",
      "                        to filter the results. Use carefully.\n",
      "  --truncate, -T        Only valid with 'records' action. Truncates string\n",
      "                        output to 12 signs.\n"
     ]
    }
   ],
   "source": [
    "%%bash\n",
    "metacatalog show -h"
   ]
  },
  {
   "cell_type": "raw",
   "metadata": {
    "raw_mimetype": "text/restructuredtext"
   },
   "source": [
    ".. warning::\n",
    "\n",
    "    The ``show`` command might be completely replaced by a ``export`` command."
   ]
  }
 ],
 "metadata": {
  "celltoolbar": "Raw Cell Format",
  "finalized": {
   "timestamp": 1590129908857,
   "trusted": true
  },
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.7"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}