Skip to content

Adding troubleshooting steps for unknown glyps icon in the prompt. #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Feb 1, 2018
43 changes: 1 addition & 42 deletions doc/installation_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ installed using the --user option, which does not require sudo.
$ pip install --user mssql-cli
```

If you are having installation issues, see the [troubleshooting](#troubleshooting) section for known issues and workarounds.
If you are having installation issues, see the [troubleshooting](#troubleshooting_guide.md) section for known issues and workarounds.


## Detailed Instructions
Expand Down Expand Up @@ -140,44 +140,3 @@ $ sudo zypper update
$ sudo zypper install libunwind libicu python-pip
$ sudo pip install mssql-cli
```

# Troubleshooting

If you're having installation issues, please check the below known issues and workarounds. If you're having a different issue, please check the [issues](https://github.com/dbcli/mssql-cli/issues) page to see if the issue has already been reported. If you don't see your issue there, filing a new issue would be appreciated.

## Error: No module named mssqlcli
If the installation was successful and this error message is encountered, this may be caused by different versions of python in the environment.
i.e Used python 3.6 to install mssql-cli, but PATH has python 2.7 so it uses the python 2.7 interpreter which has no visibility to packages installed into python 3.6.

The workaround to prevent this is to use a virtual environment, which will provide a isolated environment that is tied to a specific python version.
More information can be found at:

- [Virtual Environment Info](virtual_environment_info.md)

- [Development guide](development_guide.md#Environment_Setup)

## Error: Could not find version that satisfies the requirement mssql-cli
If you see the above error running `pip install mssql-cli`, this means the pip version used is out-of-date. Please upgrade your pip installation for your python platform and OS distribution.

## Error: System.DllNotFoundException: Unable to load DLL 'System.Security.Cryptography.Native': The specified module could not be found.
If you encounter this error on MacOS, this means you need the latest version of OpenSSL. Later version of macOS (Sierra, and High Sierra) should not have this issue. To install OpenSSL use the following commands:
```shell
$ brew update
$ brew install openssl
$ mkdir -p /usr/local/lib
$ ln -s /usr/local/opt/openssl/lib/libcrypto.1.0.0.dylib /usr/local/lib/
$ ln -s /usr/local/opt/openssl/lib/libssl.1.0.0.dylib /usr/local/lib/
```

## Error: libunwind.so: cannot open shared object file
If you encounter the below error running mssql-cli, this means the libunwind package is not installed. Please install the libunwind package for your Linux distribution.
```shell
Failed to load /usr/local/lib/python2.7/dist-packages/mssqltoolsservice/bin/libcoreclr.so, error
libunwind.so.8: cannot open shared object file: No such file or directory
```

## Error: Failed to initialize CoreCLR, HRESULT: 0x80131500
If you encounter the below error running mssql-cli, this means the libicu package is not installed. Please install the libicu package for your Linux distribution.
```shell
Failed to initialize CoreCLR, HRESULT: 0x80131500
```
72 changes: 72 additions & 0 deletions doc/troubleshooting_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
Troubleshooting Guide
========================================
## Table of Contents
1. [Installation Issues](#Installation_Issues)
2. [Usage Issues](#Usage_Issues)
3. [Reporting Issues](#Reporting_Issues)

## <a name="Installation_Issues"></a>Installation Issues:

If you're having installation issues, please check the below known issues and workarounds. If you're having a different issue, please check the [issues](https://github.com/dbcli/mssql-cli/issues) page to see if the issue has already been reported. If you don't see your issue there, filing a new issue would be appreciated.

### Error: No module named mssqlcli
If the installation was successful and this error message is encountered, this may be caused by different versions of python in the environment.
i.e Used python 3.6 to install mssql-cli, but PATH has python 2.7 so it uses the python 2.7 interpreter which has no visibility to packages installed into python 3.6.

The workaround to prevent this is to use a virtual environment, which will provide a isolated environment that is tied to a specific python version.
More information can be found at:

- [Virtual Environment Info](virtual_environment_info.md)

- [Development guide](development_guide.md#Environment_Setup)

### Error: Could not find version that satisfies the requirement mssql-cli
If you see the above error running `pip install mssql-cli`, this means the pip version used is out-of-date. Please upgrade your pip installation for your python platform and OS distribution.

### Error: System.DllNotFoundException: Unable to load DLL 'System.Security.Cryptography.Native': The specified module could not be found.
If you encounter this error on MacOS, this means you need the latest version of OpenSSL. Later version of macOS (Sierra, and High Sierra) should not have this issue. To install OpenSSL use the following commands:
```shell
$ brew update
$ brew install openssl
$ mkdir -p /usr/local/lib
$ ln -s /usr/local/opt/openssl/lib/libcrypto.1.0.0.dylib /usr/local/lib/
$ ln -s /usr/local/opt/openssl/lib/libssl.1.0.0.dylib /usr/local/lib/
```

### Error: libunwind.so: cannot open shared object file
If you encounter the below error running mssql-cli, this means the libunwind package is not installed. Please install the libunwind package for your Linux distribution.
```shell
Failed to load /usr/local/lib/python2.7/dist-packages/mssqltoolsservice/bin/libcoreclr.so, error
libunwind.so.8: cannot open shared object file: No such file or directory
```

### Error: Failed to initialize CoreCLR, HRESULT: 0x80131500
If you encounter the below error running mssql-cli, this means the libicu package is not installed. Please install the libicu package for your Linux distribution.
```shell
Failed to initialize CoreCLR, HRESULT: 0x80131500
```

## <a name="Usage_Issues"></a>Usage Issues:

### Unknown glyph fills up prompt:
If you encounter the display below, it is a Windows 10 issue that can pop up on the command prompt or powershell prompt.
The current workaround for this issue is to change the font of the prompt to Consolas.
![alt text](https://github.com/dbcli/mssql-cli/tree/master/screenshots/mssql-cli-display-issue.png "mssql-cli display issue")


### <a name="Reporting_Issues"></a>Reporting Issues:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we remove the anchor tags...they aren't needed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need the anchors to reference our headers since they have spaces in between them.

If the issue you are encountering is not listed above nor filed on our github, please file a issue here [issues](#https://github.com/dbcli/mssql-cli/issues) with the following information listed below and any other additional symptoms of your issue.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add 'which pip' and 'which python' to the commands to report.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also have the user post the commands used to install mssql-cli?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


* Python version
```
python -V
```
* Pip Version
```
pip -V
```
* OS Distribution and version

* Target Server and Database version and edition

* Python environment variables set
2 changes: 2 additions & 0 deletions doc/usage_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ mssql-cli provides the following key enhancements over sqlcmd in the Terminal en
- Multi-line edit mode
- Configuration file support

If you encounter any issues, see the[troubleshooting](#troubleshooting_guide.md)section for known issues and workarounds.


## Options
Type **mssql-cli --help** to also see these options.
Expand Down
Binary file added screenshots/mssql-cli-display-issue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.