Skip to content

Update Dependency section in README #18

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.

Sign up for GitHub

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
ahmad-ibra merged 5 commits into from
Nov 25, 2016
Merged

Update Dependency section in README #18

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d6436d6
Merge remote-tracking branch 'refs/remotes/origin/master' into dev
v-nisidh Nov 22, 2016
ee34b8a
ISSUE-17
v-nisidh Nov 22, 2016
ccb6712
Changes made as per review comments.
v-nisidh Nov 24, 2016
bbfc72e
Merge remote-tracking branch 'refs/remotes/Microsoft/dev' into dev
v-nisidh Nov 24, 2016
5c7d6bb
Merge remote-tracking branch 'refs/remotes/Microsoft/dev' into dev
v-nisidh Nov 25, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 90 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ SQL Server Team
## Announcements
What's coming next? We will look into adding a more comprehensive set of tests, improving our javadocs, and start developing the next set of features.

## Get Started
* [**Ubuntu + SQL Server + Java**](https://www.microsoft.com/en-us/sql-server/developer-get-started/java-ubuntu)
* [**Red Hat + SQL Server + Java**](https://www.microsoft.com/en-us/sql-server/developer-get-started/java-rhel)
* [**Mac + SQL Server + Java**](https://www.microsoft.com/en-us/sql-server/developer-get-started/java-mac)
* [**Windows + SQL Server + Java**](https://www.microsoft.com/en-us/sql-server/developer-get-started/java-windows)


## Build
### Prerequisites
* Java 8
Expand All @@ -36,13 +43,6 @@ To build the jar files, you must use Java 8 with either Ant (with Ivy) or Maven.
* Run `mvn install -Pbuild41`. This creates JDBC 4.1 compliant jar in \target directory
* Run `mvn install -Pbuild42`. This creates JDBC 4.2 compliant jar in \target directory

## Get Started
* [**Ubuntu + SQL Server + Java**](https://www.microsoft.com/en-us/sql-server/developer-get-started/java-ubuntu)
* [**Red Hat + SQL Server + Java**](https://www.microsoft.com/en-us/sql-server/developer-get-started/java-rhel)
* [**Mac + SQL Server + Java**](https://www.microsoft.com/en-us/sql-server/developer-get-started/java-mac)
* [**Windows + SQL Server + Java**](https://www.microsoft.com/en-us/sql-server/developer-get-started/java-windows)


## Resources

### Documentation
Expand All @@ -52,7 +52,7 @@ This driver is documented on [Microsoft's Documentation web site](https://msdn.m
For samples, please see the src\sample directory.

### Download the DLLs
For some features (e.g. Integrated Authentication and Distributed Transactions), you may need to use the sqljdbc_xa and sqljdbc_auth DLLs. They can be downloaded from the [Microsoft Download Center](https://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=11774)
For some features (e.g. Integrated Authentication and Distributed Transactions), you may need to use the `sqljdbc_xa` and `sqljdbc_auth` DLLs. They can be downloaded from the [Microsoft Download Center](https://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=11774)

### Download the driver
Don't want to compile anything?
Expand All @@ -69,6 +69,88 @@ We're now on the Maven Central Repository. Add the following to your POM file:

The driver can be downloaded from the [Microsoft Download Center](https://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=11774)

##Dependencies
This project has following dependencies:

Compile Time:

- `azure-keyvault`

@v-mabarw v-mabarw Nov 24, 2016

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Can we add what this dependency is used for? E.g. used for Azure Key Vault Provider for Always Encrypted


Test Time:

- `junit:jar`

If anybody wants to use driver as a run-time dependency but not using Azure Web Services for authentication then you either describe as optional dependency or exclude azure.

@v-mabarw v-mabarw Nov 24, 2016 •
edited
Loading

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Let's make this more generic in case we need to add more dependencies in the future. I'd suggest something like this:

###Exclude Dependencies
If you wish to limit the number of run-time dependencies, and your project does not require the features named above, you can explicitly exclude them. For example:

@v-nisidh v-nisidh Nov 24, 2016

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added Exclude Dependencies section.


```
<dependency>
<groupId>com.microsoft.sqlserver</groupId>
<artifactId>mssql-jdbc</artifactId>
<version>6.1.0.jre8</version>
<scope>runtime</scope>
<exclusions>
<exclusion>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-keyvault</artifactId>
</exclusion>
</exclusions>
</dependency>
```

###Dependency Tree

@v-mabarw v-mabarw Nov 24, 2016

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Instead of listing the output for the dependency tree, perhaps you can describe how someone can get this information for themselves? (This list will be hard to maintain if it changes in the future.)

```
mvn dependency:tree
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Microsoft JDBC Driver for SQL Server 6.1.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-dependency-plugin:2.8:tree (default-cli) @ mssql-jdbc ---
[INFO] com.microsoft.sqlserver:mssql-jdbc:jar:6.1.0
[INFO] +- com.microsoft.azure:azure-keyvault:jar:0.9.3:compile
[INFO] | +- com.microsoft.azure:azure-core:jar:0.9.3:compile
[INFO] | | +- commons-codec:commons-codec:jar:1.10:compile
[INFO] | | +- commons-lang:commons-lang:jar:2.6:compile
[INFO] | | +- javax.mail:mail:jar:1.4.5:compile
[INFO] | | | \- javax.activation:activation:jar:1.1:compile
[INFO] | | +- com.sun.jersey:jersey-client:jar:1.13:compile
[INFO] | | | \- com.sun.jersey:jersey-core:jar:1.13:compile
[INFO] | | \- com.sun.jersey:jersey-json:jar:1.13:compile
[INFO] | | +- org.codehaus.jettison:jettison:jar:1.1:compile
[INFO] | | | \- stax:stax-api:jar:1.0.1:compile
[INFO] | | +- com.sun.xml.bind:jaxb-impl:jar:2.2.3-1:compile
[INFO] | | | \- javax.xml.bind:jaxb-api:jar:2.2.2:compile
[INFO] | | | \- javax.xml.stream:stax-api:jar:1.0-2:compile
[INFO] | | +- org.codehaus.jackson:jackson-core-asl:jar:1.9.2:compile
[INFO] | | +- org.codehaus.jackson:jackson-mapper-asl:jar:1.9.2:compile
[INFO] | | +- org.codehaus.jackson:jackson-jaxrs:jar:1.9.2:compile
[INFO] | | \- org.codehaus.jackson:jackson-xc:jar:1.9.2:compile
[INFO] | +- org.apache.httpcomponents:httpclient:jar:4.3.6:compile
[INFO] | | +- org.apache.httpcomponents:httpcore:jar:4.3.3:compile
[INFO] | | \- commons-logging:commons-logging:jar:1.1.3:compile
[INFO] | +- javax.inject:javax.inject:jar:1:compile
[INFO] | \- com.microsoft.azure:adal4j:jar:1.0.0:compile
[INFO] | +- com.nimbusds:oauth2-oidc-sdk:jar:4.5:compile
[INFO] | | +- net.jcip:jcip-annotations:jar:1.0:compile
[INFO] | | +- org.apache.commons:commons-lang3:jar:3.3.1:compile
[INFO] | | +- net.minidev:json-smart:jar:1.1.1:compile
[INFO] | | +- com.nimbusds:lang-tag:jar:1.4:compile
[INFO] | | \- com.nimbusds:nimbus-jose-jwt:jar:3.1.2:compile
[INFO] | | \- org.bouncycastle:bcprov-jdk15on:jar:1.51:compile
[INFO] | +- com.google.code.gson:gson:jar:2.2.4:compile
[INFO] | \- org.slf4j:slf4j-api:jar:1.7.5:compile
[INFO] \- junit:junit:jar:4.12:test
[INFO] \- org.hamcrest:hamcrest-core:jar:1.3:test
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.423 s
[INFO] Finished at: 2016-11-22T13:13:55-08:00
[INFO] Final Memory: 12M/304M
[INFO] ------------------------------------------------------------------------
```


## Guidelines for Reporting Issues
We appreciate you taking the time to test the driver, provide feedback and report any issues. It would be extremely helpful if you:
Expand Down