Skip to content

Commit 7862a1c

Browse files
authored
Reformat readme as Markdown, indent code examples
1 parent 4bf285c commit 7862a1c

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ We hope you enjoy using the MSSQL-Django 3rd party backend.
1616
- Compatible with
1717
[Micosoft ODBC Driver for SQL Server](https://docs.microsoft.com/en-us/sql/connect/odbc/microsoft-odbc-driver-for-sql-server),
1818
[SQL Server Native Client](https://msdn.microsoft.com/en-us/library/ms131321(v=sql.120).aspx),
19-
and [FreeTDS](http://www.freetds.org/) ODBC drivers
19+
and [FreeTDS](https://www.freetds.org/) ODBC drivers
2020

2121
## Dependencies
2222

@@ -27,14 +27,14 @@ We hope you enjoy using the MSSQL-Django 3rd party backend.
2727

2828
1. Install pyodbc 3.0 (or newer) and Django 2.2 (or newer)
2929

30-
2. Install mssql-django ::
30+
2. Install mssql-django:
3131

32-
pip install mssql-django
32+
pip install mssql-django
3333

34-
3. Set the ``ENGINE`` setting in the `settings.py` file used by
35-
your Django application or project to ``'mssql'``
34+
3. Set the `ENGINE` setting in the `settings.py` file used by
35+
your Django application or project to `'mssql'`:
3636

37-
``'ENGINE': 'mssql'``
37+
'ENGINE': 'mssql'
3838

3939
## Configuration
4040

@@ -45,15 +45,15 @@ in DATABASES control the behavior of the backend:
4545

4646
- ENGINE
4747

48-
String. It must be ``"mssql"``.
48+
String. It must be `"mssql"`.
4949

5050
- NAME
5151

5252
String. Database name. Required.
5353

5454
- HOST
5555

56-
String. SQL Server instance in ``"server\instance"`` format.
56+
String. SQL Server instance in `"server\instance"` format.
5757

5858
- PORT
5959

@@ -62,7 +62,7 @@ in DATABASES control the behavior of the backend:
6262

6363
- USER
6464

65-
String. Database user name in ``"user"`` format.
65+
String. Database user name in `"user"` format.
6666
If not given then MS Integrated Security will be used.
6767

6868
- PASSWORD
@@ -71,22 +71,22 @@ in DATABASES control the behavior of the backend:
7171

7272
- AUTOCOMMIT
7373

74-
Boolean. Set this to False if you want to disable
74+
Boolean. Set this to `False` if you want to disable
7575
Django's transaction management and implement your own.
7676

77-
and the following entries are also available in the TEST dictionary
77+
and the following entries are also available in the `TEST` dictionary
7878
for any given database-level settings dictionary:
7979

8080
- NAME
8181

8282
String. The name of database to use when running the test suite.
83-
If the default value (``None``) is used, the test database will use
84-
the name "test\_" + ``NAME``.
83+
If the default value (`None`) is used, the test database will use
84+
the name `"test\_" + NAME`.
8585

8686
- COLLATION
8787

8888
String. The collation order to use when creating the test database.
89-
If the default value (``None``) is used, the test database is assigned
89+
If the default value (`None`) is used, the test database is assigned
9090
the default collation of the instance of SQL Server.
9191

9292
- DEPENDENCIES
@@ -97,7 +97,7 @@ for any given database-level settings dictionary:
9797
- MIRROR
9898

9999
String. The alias of the database that this database should
100-
mirror during testing. Default value is ``None``.
100+
mirror during testing. Default value is `None`.
101101
See the official Django documentation for more details.
102102

103103
### OPTIONS
@@ -106,22 +106,22 @@ Dictionary. Current available keys are:
106106

107107
- driver
108108

109-
String. ODBC Driver to use (``"ODBC Driver 17 for SQL Server"``,
110-
``"SQL Server Native Client 11.0"``, ``"FreeTDS"`` etc).
111-
Default is ``"ODBC Driver 17 for SQL Server"``.
109+
String. ODBC Driver to use (`"ODBC Driver 17 for SQL Server"`,
110+
`"SQL Server Native Client 11.0"`, `"FreeTDS"` etc).
111+
Default is `"ODBC Driver 17 for SQL Server"`.
112112

113113
- isolation_level
114114

115115
String. Sets [transaction isolation level](https://docs.microsoft.com/en-us/sql/t-sql/statements/set-transaction-isolation-level-transact-sql)
116116
for each database session. Valid values for this entry are
117-
``READ UNCOMMITTED``, ``READ COMMITTED``, ``REPEATABLE READ``,
118-
``SNAPSHOT``, and ``SERIALIZABLE``. Default is ``None`` which means
117+
`READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`,
118+
`SNAPSHOT`, and `SERIALIZABLE`. Default is `None` which means
119119
no isolation levei is set to a database session and SQL Server default
120120
will be used.
121121

122122
- dsn
123123

124-
String. A named DSN can be used instead of ``HOST``.
124+
String. A named DSN can be used instead of `HOST`.
125125

126126
- host_is_server
127127

@@ -192,7 +192,7 @@ The following project-level settings also control the behavior of the backend:
192192

193193
Here is an example of the database settings:
194194

195-
```
195+
```python
196196
DATABASES = {
197197
'default': {
198198
'ENGINE': 'mssql',
@@ -211,6 +211,7 @@ Here is an example of the database settings:
211211
# set this to False if you want to turn off pyodbc's connection pooling
212212
DATABASE_CONNECTION_POOLING = False
213213
```
214+
214215
## Limitations
215216

216217
The following features are currently not supported:
@@ -238,7 +239,7 @@ contact [[email protected]](mailto:[email protected]) with any additio
238239

239240
## Security Reporting Instructions
240241

241-
For security reporting instructions please refer to the SECURITY.md file in this repository.
242+
For security reporting instructions please refer to the [`SECURITY.md`](SECURITY.md) file in this repository.
242243

243244
## Trademarks
244245

0 commit comments

Comments
 (0)