Skip to content

Commit 6e121f4

Browse files
author
Elliot Boschwitz
authored
Added pypager installation instructions (#473)
1 parent 30aae92 commit 6e121f4

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

doc/usage_guide.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This article explores mssql-cli features. Click a link below to jump to a specif
66
* [Special Commands](#special-commands)
77
* [Non-Interactive Options](#non-interactive-options)
88
* [Configuration](#configuration)
9+
* [Horizontal Paging Options on Windows](#horizontal-paging-options-on-windows)
910
* [Troubleshooting](#troubleshooting)
1011

1112
## Options
@@ -267,5 +268,19 @@ To print the results of your [non-interactive query](#executing-a-query-in-non-i
267268
## Configuration
268269
Customization and persistence of settings can be achieved with a config file, whose path can be passed as the `--mssqlclirc <file>` command line argument. Otherwise it is read from the default path `~/.config/mssqlcli/config` on macOS and Linux, and `%LOCALAPPDATA%\dbcli\mssqlcli\config` on Windows. See the [config file](https://github.com/dbcli/mssql-cli/blob/master/mssqlcli/mssqlclirc) itself for a description of all available options.
269270
271+
## Horizontal Paging Options on Windows
272+
mssql-cli on Windows will default to a vertical layout when table results would otherwise exceed the window width. Horizontal paging may present an improved experience, however is not supported out-of-the-box for mssql-cli on Windows.
273+
274+
A workaround for horizontal paging support on Windows is provided with installation of pypager:
275+
> **Disclaimer**: pypager will enter paging mode for every query.
276+
```sh
277+
python -m pip install pypager
278+
```
279+
280+
After installation of pypager, update the `pager` value in the [config](#configuration) file with:
281+
```
282+
pager=pypager
283+
```
284+
270285
## Troubleshooting
271286
If you encounter any issues, see the [troubleshooting](troubleshooting_guide.md) section for known issues and workarounds.

0 commit comments

Comments
 (0)