Skip to content

Commit fce7664

Browse files
mShan0mShan0
authored
Prepare for 1.2 release
2 parents 60d25da + 1ee487d commit fce7664

28 files changed

+1193
-253
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
There are some features which are not supported yet. Please check the [Limitations](https://github.com/microsoft/mssql-django#limitations) first to see if your bug is listed.
11+
12+
**Software versions**
13+
* Django:
14+
* mssql-django:
15+
* python:
16+
* SQL Server:
17+
* OS:
18+
19+
**Table schema and Model**
20+
<!-- Provide the table schema and model from models.py to reproduce the issue. -->
21+
22+
**Database Connection Settings**
23+
`
24+
// Paste your database settings from Settings.py here.
25+
`
26+
27+
**Problem description and steps to reproduce**
28+
<!-- Provide full details of the problem, including steps to reproduce the issue. -->
29+
30+
**Expected behavior and actual behavior**
31+
<!-- A clear and concise description of what you expected to happen. -->
32+
33+
**Error message/stack trace**
34+
<!-- Complete error message and stack trace. -->
35+
36+
**Any other details that can be helpful**
37+
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/feature_request.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE REQUEST]"
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? If so, please give a short summary of the problem and how the feature would resolve it**
11+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
12+
13+
**Describe the preferred solution**
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
**Describe alternatives you've considered**
17+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
18+
19+
**Additional context**
20+
<!-- Add any other context or screenshots about the feature request here. -->
21+
22+
**Reference Documentations/Specifications**
23+
<!-- Provide links to any related documentation. -->

‎.github/ISSUE_TEMPLATE/question.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Question
3+
about: Ask a question
4+
title: "[QUESTION]"
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
**Question**
11+
<!-- What is the question that you have? Please be detailed and give examples. -->
12+
13+
**Relevant Issues and Pull Requests**
14+
<!-- If there are relevant issues and pull requests please list and link them here. -->

‎README.md

+23-4
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Dictionary. Current available keys are:
125125
for each database session. Valid values for this entry are
126126
`READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`,
127127
`SNAPSHOT`, and `SERIALIZABLE`. Default is `None` which means
128-
no isolation levei is set to a database session and SQL Server default
128+
no isolation level is set to a database session and SQL Server default
129129
will be used.
130130

131131
- dsn
@@ -204,6 +204,27 @@ Dictionary. Current available keys are:
204204
},
205205
```
206206

207+
- return_rows_bulk_insert
208+
209+
Boolean. Sets if backend can return rows from bulk insert.
210+
Default value is False which doesn't allows for the backend to
211+
return rows from bulk insert. Must be set to False if database
212+
has tables with triggers to prevent errors when inserting.
213+
214+
```python
215+
# Examples
216+
"OPTIONS": {
217+
# This database doesn't have any triggers so can use return
218+
# rows from bulk insert feature
219+
"return_rows_bulk_insert": True
220+
}
221+
222+
"OPTIONS": {
223+
# This database has triggers so leave return_rows_bulk_insert as blank (False)
224+
# to prevent errors related to inserting and returning rows from bulk insert
225+
}
226+
```
227+
207228
### Backend-specific settings
208229

209230
The following project-level settings also control the behavior of the backend:
@@ -248,11 +269,9 @@ The following features are currently not fully supported:
248269
- Timezones, timedeltas not fully supported
249270
- Rename field/model with foreign key constraint
250271
- Database level constraints
251-
- Math degrees power or radians
252-
- Bit-shift operators
253272
- Filtered index
254273
- Date extract function
255-
- Hashing functions
274+
- Bulk insert into a table with a trigger and returning the rows inserted
256275

257276
JSONField lookups have limitations, more details [here](https://github.com/microsoft/mssql-django/wiki/JSONField).
258277

‎azure-pipelines.yml

+34-69
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ schedules:
1111
- dev
1212
always: true
1313

14+
variables:
15+
- group: DjangoTestApp
16+
1417
jobs:
1518
- job: Windows
1619
pool:
@@ -21,6 +24,16 @@ jobs:
2124

2225
strategy:
2326
matrix:
27+
Python3.10 - Django 4.1:
28+
python.version: '3.10'
29+
tox.env: 'py310-django41'
30+
Python 3.9 - Django 4.1:
31+
python.version: '3.9'
32+
tox.env: 'py39-django41'
33+
Python 3.8 - Django 4.1:
34+
python.version: '3.8'
35+
tox.env: 'py38-django41'
36+
2437
Python3.10 - Django 4.0:
2538
python.version: '3.10'
2639
tox.env: 'py310-django40'
@@ -44,39 +57,6 @@ jobs:
4457
python.version: '3.6'
4558
tox.env: 'py36-django32'
4659

47-
Python 3.9 - Django 3.1:
48-
python.version: '3.9'
49-
tox.env: 'py39-django31'
50-
Python 3.8 - Django 3.1:
51-
python.version: '3.8'
52-
tox.env: 'py38-django31'
53-
Python 3.7 - Django 3.1:
54-
python.version: '3.7'
55-
tox.env: 'py37-django31'
56-
Python 3.6 - Django 3.1:
57-
python.version: '3.6'
58-
tox.env: 'py36-django31'
59-
60-
Python 3.9 - Django 3.0:
61-
python.version: '3.9'
62-
tox.env: 'py39-django30'
63-
Python 3.8 - Django 3.0:
64-
python.version: '3.8'
65-
tox.env: 'py38-django30'
66-
Python 3.7 - Django 3.0:
67-
python.version: '3.7'
68-
tox.env: 'py37-django30'
69-
Python 3.6 - Django 3.0:
70-
python.version: '3.6'
71-
tox.env: 'py36-django30'
72-
73-
Python 3.7 - Django 2.2:
74-
python.version: '3.7'
75-
tox.env: 'py37-django22'
76-
Python 3.6 - Django 2.2:
77-
python.version: '3.6'
78-
tox.env: 'py36-django22'
79-
8060
steps:
8161
- task: CredScan@2
8262
inputs:
@@ -102,14 +82,18 @@ jobs:
10282
Invoke-Sqlcmd @"
10383
EXEC xp_instance_regwrite N'HKEY_LOCAL_MACHINE', N'Software\Microsoft\MSSQLServer\MSSQLServer', N'LoginMode', REG_DWORD, 2
10484
ALTER LOGIN [sa] ENABLE;
105-
ALTER LOGIN [sa] WITH PASSWORD = 'MyPassword42', CHECK_POLICY=OFF;
85+
ALTER LOGIN [sa] WITH PASSWORD = '$(TestAppPassword)', CHECK_POLICY=OFF;
10686
"@
10787
displayName: Set up SQL Server
10888
10989
- powershell: |
11090
Restart-Service -Name MSSQLSERVER -Force
11191
displayName: Restart SQL Server
11292
93+
- powershell: |
94+
(Get-Content -ReadCount 0 testapp\settings.py) -replace 'MyPassword42', '$(TestAppPassWord)' | Set-Content testapp\settings.py
95+
displayName: Change PASSWORD in settings.py
96+
11397
- powershell: |
11498
python -m pip install --upgrade pip wheel setuptools
11599
python -m pip install tox
@@ -127,6 +111,16 @@ jobs:
127111

128112
strategy:
129113
matrix:
114+
Python3.10 - Django 4.1:
115+
python.version: '3.10'
116+
tox.env: 'py310-django41'
117+
Python 3.9 - Django 4.1:
118+
python.version: '3.9'
119+
tox.env: 'py39-django41'
120+
Python 3.8 - Django 4.1:
121+
python.version: '3.8'
122+
tox.env: 'py38-django41'
123+
130124
Python3.10 - Django 4.0:
131125
python.version: '3.10'
132126
tox.env: 'py310-django40'
@@ -150,48 +144,15 @@ jobs:
150144
python.version: '3.6'
151145
tox.env: 'py36-django32'
152146

153-
Python 3.9 - Django 3.1:
154-
python.version: '3.9'
155-
tox.env: 'py39-django31'
156-
Python 3.8 - Django 3.1:
157-
python.version: '3.8'
158-
tox.env: 'py38-django31'
159-
Python 3.7 - Django 3.1:
160-
python.version: '3.7'
161-
tox.env: 'py37-django31'
162-
Python 3.6 - Django 3.1:
163-
python.version: '3.6'
164-
tox.env: 'py36-django31'
165-
166-
Python 3.9 - Django 3.0:
167-
python.version: '3.9'
168-
tox.env: 'py39-django30'
169-
Python 3.8 - Django 3.0:
170-
python.version: '3.8'
171-
tox.env: 'py38-django30'
172-
Python 3.7 - Django 3.0:
173-
python.version: '3.7'
174-
tox.env: 'py37-django30'
175-
Python 3.6 - Django 3.0:
176-
python.version: '3.6'
177-
tox.env: 'py36-django30'
178-
179-
Python 3.7 - Django 2.2:
180-
python.version: '3.7'
181-
tox.env: 'py37-django22'
182-
Python 3.6 - Django 2.2:
183-
python.version: '3.6'
184-
tox.env: 'py36-django22'
185-
186147
steps:
187148
- task: UsePythonVersion@0
188149
inputs:
189150
versionSpec: "$(python.version)"
190151
displayName: Use Python $(python.version)
191152

192153
- script: |
193-
docker pull mcr.microsoft.com/mssql/server:2019-latest
194-
docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=MyPassword42' -p 1433:1433 -d mcr.microsoft.com/mssql/server:2019-latest
154+
docker pull mcr.microsoft.com/mssql/server:2022-latest
155+
docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=$(TestAppPassword)' -p 1433:1433 -d mcr.microsoft.com/mssql/server:2022-latest
195156
curl https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
196157
curl https://packages.microsoft.com/config/ubuntu/20.04/prod.list | sudo tee /etc/apt/sources.list.d/mssql-release.list
197158
sudo apt-get update
@@ -204,6 +165,10 @@ jobs:
204165
git clone https://github.com/django/django.git
205166
displayName: Install requirements
206167
168+
- script: |
169+
sed -i 's/MyPassword42/$(TestAppPassword)/g' testapp/settings.py
170+
displayName: Change PASSWORD in settings.py
171+
207172
- script: tox -e $(tox.env)
208173
displayName: Run tox
209174

‎mssql/base.py

+24-3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
import re
99
import time
1010
import struct
11+
import datetime
1112

1213
from django.core.exceptions import ImproperlyConfigured
1314

@@ -35,12 +36,12 @@
3536
from .client import DatabaseClient # noqa
3637
from .creation import DatabaseCreation # noqa
3738
from .features import DatabaseFeatures # noqa
38-
from .introspection import DatabaseIntrospection # noqa
39+
from .introspection import DatabaseIntrospection, SQL_TIMESTAMP_WITH_TIMEZONE # noqa
3940
from .operations import DatabaseOperations # noqa
4041
from .schema import DatabaseSchemaEditor # noqa
4142

4243
EDITION_AZURE_SQL_DB = 5
43-
44+
EDITION_AZURE_SQL_MANAGED_INSTANCE = 8
4445

4546
def encode_connection_string(fields):
4647
"""Encode dictionary of keys and values as an ODBC connection String.
@@ -80,6 +81,13 @@ def encode_value(v):
8081
return v
8182

8283

84+
def handle_datetimeoffset(dto_value):
85+
# Decode bytes returned from SQL Server
86+
# source: https://github.com/mkleehammer/pyodbc/wiki/Using-an-Output-Converter-function
87+
tup = struct.unpack("<6hI2h", dto_value) # e.g., (2017, 3, 16, 10, 35, 18, 500000000)
88+
return datetime.datetime(tup[0], tup[1], tup[2], tup[3], tup[4], tup[5], tup[6] // 1000)
89+
90+
8391
class DatabaseWrapper(BaseDatabaseWrapper):
8492
vendor = 'microsoft'
8593
display_name = 'SQL Server'
@@ -184,6 +192,7 @@ class DatabaseWrapper(BaseDatabaseWrapper):
184192
13: 2016,
185193
14: 2017,
186194
15: 2019,
195+
16: 2022,
187196
}
188197

189198
# https://azure.microsoft.com/en-us/documentation/articles/sql-database-develop-csharp-retry-windows/
@@ -234,6 +243,9 @@ def __init__(self, *args, **kwargs):
234243
ops[op] = '%s COLLATE %s' % (sql, collation)
235244
self.operators.update(ops)
236245

246+
if (settings.USE_TZ):
247+
self.data_types['DateTimeField'] ='datetimeoffset'
248+
237249
def create_cursor(self, name=None):
238250
return CursorWrapper(self.connection.cursor(), self)
239251

@@ -364,6 +376,9 @@ def get_new_connection(self, conn_params):
364376
if not need_to_retry:
365377
raise
366378

379+
# Handling values from DATETIMEOFFSET columns
380+
# source: https://github.com/mkleehammer/pyodbc/wiki/Using-an-Output-Converter-function
381+
conn.add_output_converter(SQL_TIMESTAMP_WITH_TIMEZONE, handle_datetimeoffset)
367382
conn.timeout = query_timeout
368383
if setencoding:
369384
for entry in setencoding:
@@ -410,6 +425,11 @@ def init_connection_state(self):
410425
datefirst = options.get('datefirst', 7)
411426
cursor.execute('SET DATEFORMAT ymd; SET DATEFIRST %s' % datefirst)
412427

428+
# Let user choose if driver can return rows from bulk insert since
429+
# inserting into tables with triggers causes errors. See issue #130
430+
if (options.get('return_rows_bulk_insert', False)):
431+
self.features_class.can_return_rows_from_bulk_insert = True
432+
413433
val = self.get_system_datetime()
414434
if isinstance(val, str):
415435
raise ImproperlyConfigured(
@@ -464,7 +484,8 @@ def to_azure_sql_db(self, _known_azures={}):
464484
if self.alias not in _known_azures:
465485
with self.temporary_connection() as cursor:
466486
cursor.execute("SELECT CAST(SERVERPROPERTY('EngineEdition') AS integer)")
467-
_known_azures[self.alias] = cursor.fetchone()[0] == EDITION_AZURE_SQL_DB
487+
edition = cursor.fetchone()[0]
488+
_known_azures[self.alias] = edition == EDITION_AZURE_SQL_DB or edition == EDITION_AZURE_SQL_MANAGED_INSTANCE
468489
return _known_azures[self.alias]
469490

470491
def _execute_foreach(self, sql, table_names=None):

0 commit comments

Comments
 (0)