devel/psql/docopts.md

<!---
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->
# Tasks  `ops devel psql`

OpenServerless PostrgreSQL Utilities.

## Synopsis

```text
Usage:
    psql describe <table> [--format=json|table]
    psql sql [<file>] [--format=json|table]
```

## Commands

```
    describe  perfoms a query to describe the given table if it exists in the user PostgresSQL database
    sql       submits a SQL snippet (like SELECT *, CREATE TABLE etc) from stdin or as a file and print-out the corresponding results
```

## Options

```
--format         Output data as table or as json. default is json
```