Skip to content

Commit 8d25c1f

Browse files
kianmengkianmeng
committed
Misc doc changes
Besides other documentation changes, this commit ensures the generated HTML doc for HexDocs.pm will become the source of truth for this Elixir library and leverage on latest features of ExDoc.
1 parent e1d817b commit 8d25c1f

14 files changed

+474
-215
lines changed

‎.formatter.exs

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Used by "mix format"
12
[
23
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
34
]

‎.gitignore

+26-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,31 @@
1-
/doc
2-
.elixir_ls
3-
.vscode
4-
/_build
5-
/deps
1+
# The directory Mix will write compiled artifacts to.
2+
/_build/
3+
4+
# If you run "mix test --cover", coverage assets end up here.
5+
/cover/
6+
7+
# The directory Mix downloads your dependencies sources to.
8+
/deps/
9+
10+
# Where third-party dependencies like ExDoc output generated docs.
11+
/doc/
12+
13+
# Ignore .fetch files in case you like to edit your project deps locally.
14+
/.fetch
15+
16+
# If the VM crashes, it generates a dump, let's ignore it too.
617
erl_crash.dump
18+
19+
# Also ignore archive artifacts (built via "mix archive.build").
720
*.ez
8-
cover/
21+
22+
# Ignore package tarball (built via "mix hex.build").
23+
tds-*.tar
24+
25+
# Temporary files, for example, from tests.
26+
/tmp/
27+
28+
# Misc.
929
.idea/
1030
.code/
1131
.tool-versions

‎CHANGELOG.md

+105-99
Large diffs are not rendered by default.

‎LICENSE

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎README.md

+39-34
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
11
# Tds - MSSQL Driver for Elixir
22

3-
[![Hex.pm](https://img.shields.io/hexpm/v/tds.svg)](https://hex.pm/packages/tds)
3+
[![Hex.pm](https://img.shields.io/hexpm/v/tds.svg)](https://hex.pm/packages/tds)
44
![Elixir TDS CI](https://github.com/elixir-ecto/tds/workflows/Elixir%20TDS%20CI/badge.svg)
55

66
MSSQL / TDS Database driver for Elixir.
77

8-
## Usage
8+
### NOTE:
9+
Since TDS version 2.0, `tds_ecto` package is deprecated, this version supports `ecto_sql` since version 3.3.4.
10+
11+
Please check out the issues for a more complete overview. This branch should not be considered stable or ready for production yet.
912

13+
For stable versions always use [hex.pm](https://hex.pm/packages/tds) as source for your mix.exs.
14+
15+
## Usage
1016

1117
Add `:tds` as a dependency in your `mix.exs` file.
1218

1319
```elixir
1420
def deps do
15-
[{:tds, "~> 2.0"}]
21+
[
22+
{:tds, "~> 2.0"}
23+
]
1624
end
1725
```
1826

19-
As of TDS version `>= 1.2`, tds can support windows codepages other than `windows-1252` (latin1).
20-
If you need such support you will need to include additional dependency `{:tds_encoding, "~> 1.0"}`
27+
As of TDS version `>= 1.2`, tds can support windows codepages other than `windows-1252` (latin1).
28+
If you need such support you will need to include additional dependency `{:tds_encoding, "~> 1.0"}`
2129
and configure `:tds` app to use `Tds.Encoding` module like this:
2230

2331

@@ -27,15 +35,14 @@ import Mix.Config
2735
config :tds, :text_encoder, Tds.Encoding
2836
```
2937

30-
Note that `:tds_encoding` requires Rust compiler installed in order to compile nif.
31-
In previous versions only SQL_Latin1_General was suported (codepage `windows-1252`).
32-
Please follow instructions at [rust website](https://www.rust-lang.org/tools/install)
33-
to install rust.
38+
Note that `:tds_encoding` requires Rust compiler installed in order to compile nif.
39+
In previous versions only `SQL_Latin1_General` was supported (codepage `windows-1252`).
40+
Please follow instructions at [Rust website](https://www.rust-lang.org/tools/install) to install Rust.
3441

35-
When you are done, run `mix deps.get` in your shell to fetch and compile Tds.
42+
When you are done, run `mix deps.get` in your shell to fetch and compile Tds.
3643
Start an interactive Elixir shell with `iex -S mix`.
3744

38-
```iex
45+
```elixir
3946
iex> {:ok, pid} = Tds.start_link([hostname: "localhost", username: "test_user", password: "test_password", database: "test_db", port: 4000])
4047
{:ok, #PID<0.69.0>}
4148

@@ -60,34 +67,34 @@ Example configuration
6067
import Mix.Config
6168

6269
config :your_app, :tds_conn,
63-
hostname: "localhost",
64-
username: "test_user",
65-
password: "test_password",
66-
database: "test_db",
70+
hostname: "localhost",
71+
username: "test_user",
72+
password: "test_password",
73+
database: "test_db",
6774
port: 1433
6875
```
6976

7077
Then using `Application.get_env(:your_app, :tds_conn)` use this as first parameter in `Tds.start_link/1` function.
7178

72-
There is additional parameter that can be used in configuration and
73-
can improve query execution in SQL Server. If you find out that
79+
There is additional parameter that can be used in configuration and
80+
can improve query execution in SQL Server. If you find out that
7481
your queries suffer from "density estimation" as described [here](https://www.brentozar.com/archive/2018/03/sp_prepare-isnt-good-sp_executesql-performance/)
7582

76-
you can try switching how tds executes queries as below:
83+
You can try switching how tds executes queries as below:
7784

7885
```elixir
7986
import Mix.Config
8087

8188
config :your_app, :tds_conn,
82-
hostname: "localhost",
83-
username: "test_user",
84-
password: "test_password",
85-
database: "test_db",
89+
hostname: "localhost",
90+
username: "test_user",
91+
password: "test_password",
92+
database: "test_db",
8693
port: 1433,
8794
execution_mode: :executesql
8895
```
89-
This will skip calling `sp_prepare` and query will be executed using `sp_executesql` instead.
90-
Please note that only one execution mode can be set at a time, and SQL Server will probably
96+
This will skip calling `sp_prepare` and query will be executed using `sp_executesql` instead.
97+
Please note that only one execution mode can be set at a time, and SQL Server will probably
9198
use single execution plan (since it is NOT estimated by checking data density!).
9299

93100
## SSL / TLS support
@@ -134,8 +141,8 @@ Since v1.0.16, additional connection parameters are:
134141
- `:set_allow_snapshot_isolation` - atom, one of `:on | :off`
135142
- `:set_read_committed_snapshot` - atom, one of `:on | :off`
136143

137-
Set this option to enable snapshot isolation on the database level.
138-
Requires connecting with a user with appropriate rights.
144+
Set this option to enable snapshot isolation on the database level.
145+
Requires connecting with a user with appropriate rights.
139146
More info [here](https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/sql/snapshot-isolation-in-sql-server).
140147

141148
## Data representation
@@ -181,7 +188,7 @@ Note that the DateTimeOffset tuple expects the date and time in UTC and the offs
181188
format](https://dba.stackexchange.com/a/121878), and these mixed-endian UUIDs
182189
are returned in [Tds.Result](https://hexdocs.pm/tds/Tds.Result.html).
183190

184-
To convert a mixed-endian UUID binary to a big-endian string, use
191+
To convert a mixed-endian UUID binary to a big-endian string, use
185192
[Tds.Types.UUID.load/1](https://hexdocs.pm/tds/Tds.Types.UUID.html#load/1)
186193

187194
To convert a big-endian UUID string to a mixed-endian binary, use
@@ -203,11 +210,11 @@ use it for the first time.
203210

204211
### Development SQL Server Setup
205212

206-
The tests require an SQL Server database to be available on localhost.
213+
The tests require an SQL Server database to be available on localhost.
207214
If you are not using Windows OS you can start sql server instance using Docker.
208215
Official SQL Server Docker image can be found [here](https://hub.docker.com/r/microsoft/mssql-server-linux).
209216

210-
If you do not have specific requirements on how you would like to start sql server
217+
If you do not have specific requirements on how you would like to start sql server
211218
in docker, you can use script for this repo.
212219

213220
```bash
@@ -234,15 +241,13 @@ Thanks to [ericmj](https://github.com/ericmj), this driver takes a lot of inspir
234241

235242
Also thanks to everyone in the Elixir Google group and on the Elixir IRC Channel.
236243

237-
## License
244+
## Copyright and License
238245

239-
Copyright 2014, 2015, 2017 LiveHelpNow
246+
Copyright (c) 2015 LiveHelpNow
240247

241248
Licensed under the Apache License, Version 2.0 (the "License");
242249
you may not use this file except in compliance with the License.
243-
You may obtain a copy of the License at
244-
245-
http://www.apache.org/licenses/LICENSE-2.0
250+
You may obtain a copy of the License at [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
246251

247252
Unless required by applicable law or agreed to in writing, software
248253
distributed under the License is distributed on an "AS IS" BASIS,

0 commit comments

Comments
 (0)