Skip to content

Commit 7abea0e

Browse files
authored
Adding troubleshooting steps for unknown glyps icon in the prompt. (#153)
* Adding troubleshooting steps for unknown glyps icon in the prompt. * Adding trouble shooting guide for usage and installation issues. * Update troubleshooting_guide.md * Adding filing issues information needed step. * Updating reporting issues paragraph. * Adding python and pip location to issue reporting guidelines. * Adding command used to install mssql-cli to issue reporting guideline. * Adding back anchor headers for table of contents link.
1 parent bb54fbe commit 7abea0e

File tree

4 files changed

+76
-42
lines changed

4 files changed

+76
-42
lines changed

doc/installation_guide.md

+1-42
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ installed using the --user option, which does not require sudo.
1313
$ pip install --user mssql-cli
1414
```
1515

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

1818

1919
## Detailed Instructions
@@ -140,44 +140,3 @@ $ sudo zypper update
140140
$ sudo zypper install libunwind libicu python-pip
141141
$ sudo pip install mssql-cli
142142
```
143-
144-
# Troubleshooting
145-
146-
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.
147-
148-
## Error: No module named mssqlcli
149-
If the installation was successful and this error message is encountered, this may be caused by different versions of python in the environment.
150-
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.
151-
152-
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.
153-
More information can be found at:
154-
155-
- [Virtual Environment Info](virtual_environment_info.md)
156-
157-
- [Development guide](development_guide.md#Environment_Setup)
158-
159-
## Error: Could not find version that satisfies the requirement mssql-cli
160-
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.
161-
162-
## Error: System.DllNotFoundException: Unable to load DLL 'System.Security.Cryptography.Native': The specified module could not be found.
163-
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:
164-
```shell
165-
$ brew update
166-
$ brew install openssl
167-
$ mkdir -p /usr/local/lib
168-
$ ln -s /usr/local/opt/openssl/lib/libcrypto.1.0.0.dylib /usr/local/lib/
169-
$ ln -s /usr/local/opt/openssl/lib/libssl.1.0.0.dylib /usr/local/lib/
170-
```
171-
172-
## Error: libunwind.so: cannot open shared object file
173-
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.
174-
```shell
175-
Failed to load /usr/local/lib/python2.7/dist-packages/mssqltoolsservice/bin/libcoreclr.so, error
176-
libunwind.so.8: cannot open shared object file: No such file or directory
177-
```
178-
179-
## Error: Failed to initialize CoreCLR, HRESULT: 0x80131500
180-
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.
181-
```shell
182-
Failed to initialize CoreCLR, HRESULT: 0x80131500
183-
```

doc/troubleshooting_guide.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
Troubleshooting Guide
2+
========================================
3+
## Table of Contents
4+
1. [Installation Issues](#Installation_Issues)
5+
2. [Usage Issues](#Usage_Issues)
6+
3. [Reporting Issues](#Reporting_Issues)
7+
8+
## <a name="Installation_Issues"></a>Installation Issues:
9+
10+
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.
11+
12+
### Error: No module named mssqlcli
13+
If the installation was successful and this error message is encountered, this may be caused by different versions of python in the environment.
14+
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.
15+
16+
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.
17+
More information can be found at:
18+
19+
- [Virtual Environment Info](virtual_environment_info.md)
20+
21+
- [Development guide](development_guide.md#Environment_Setup)
22+
23+
### Error: Could not find version that satisfies the requirement mssql-cli
24+
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.
25+
26+
### Error: System.DllNotFoundException: Unable to load DLL 'System.Security.Cryptography.Native': The specified module could not be found.
27+
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:
28+
```shell
29+
$ brew update
30+
$ brew install openssl
31+
$ mkdir -p /usr/local/lib
32+
$ ln -s /usr/local/opt/openssl/lib/libcrypto.1.0.0.dylib /usr/local/lib/
33+
$ ln -s /usr/local/opt/openssl/lib/libssl.1.0.0.dylib /usr/local/lib/
34+
```
35+
36+
### Error: libunwind.so: cannot open shared object file
37+
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.
38+
```shell
39+
Failed to load /usr/local/lib/python2.7/dist-packages/mssqltoolsservice/bin/libcoreclr.so, error
40+
libunwind.so.8: cannot open shared object file: No such file or directory
41+
```
42+
43+
### Error: Failed to initialize CoreCLR, HRESULT: 0x80131500
44+
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.
45+
```shell
46+
Failed to initialize CoreCLR, HRESULT: 0x80131500
47+
```
48+
49+
## <a name="Usage_Issues"></a>Usage Issues:
50+
51+
### Unknown glyph fills up prompt:
52+
If you encounter the display below, it is a Windows 10 issue that can pop up on the command prompt or powershell prompt.
53+
The current workaround for this issue is to change the font of the prompt to Consolas.
54+
![alt text](https://github.com/dbcli/mssql-cli/tree/master/screenshots/mssql-cli-display-issue.png "mssql-cli display issue")
55+
56+
57+
### <a name="Reporting_Issues"></a>Reporting Issues:
58+
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.
59+
60+
* Command used to install mssql-cli
61+
* Python version and location
62+
```
63+
python -V
64+
where python
65+
```
66+
* Pip Version and location
67+
```
68+
pip -V
69+
where pip
70+
```
71+
* OS Distribution and version
72+
* Target Server and Database version and edition
73+
* Python environment variables set

doc/usage_guide.md

+2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ mssql-cli provides the following key enhancements over sqlcmd in the Terminal en
1515
- Multi-line edit mode
1616
- Configuration file support
1717

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

1921
## Options
2022
Type **mssql-cli --help** to also see these options.
22.6 KB
Loading

0 commit comments

Comments
 (0)