Skip to content

Commit 705fa4f

Browse files
SNOW-1020059: Describe driver installation from source (#1617)
1 parent bc893a6 commit 705fa4f

File tree

1 file changed

+44
-15
lines changed

1 file changed

+44
-15
lines changed

README.rst

+44-15
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Installation
2525

2626
Maven
2727
-----
28-
Add following code block as a dependency
28+
Add following dependency for fat-jar
2929

3030
.. code-block:: xml
3131
@@ -35,6 +35,25 @@ Add following code block as a dependency
3535
<version>{version}</version>
3636
</dependency>
3737
38+
or for FIPS compliant fat-jar
39+
40+
.. code-block:: xml
41+
42+
<dependency>
43+
<groupId>net.snowflake</groupId>
44+
<artifactId>snowflake-jdbc-fips</artifactId>
45+
<version>{version}</version>
46+
</dependency>
47+
48+
or for experimental thin-jar
49+
50+
.. code-block:: xml
51+
52+
<dependency>
53+
<groupId>net.snowflake</groupId>
54+
<artifactId>snowflake-jdbc-thin</artifactId>
55+
<version>{version}</version>
56+
</dependency>
3857
3958
Build from Source Code
4059
----------------------
@@ -44,11 +63,33 @@ Build from Source Code
4463
4564
git clone https://github.com/snowflakedb/snowflake-jdbc.git
4665
47-
2. Build the driver by running:
66+
2. Build the fat-jar and install it in local maven repository by running:
4867

4968
.. code-block:: bash
5069
51-
mvn install
70+
./mvnw clean verify
71+
./mvnw org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile=target/snowflake-jdbc.jar -DpomFile=./public_pom.xml
72+
73+
3. Build the FIPS compliant fat-jar and install it in local maven repository by running:
74+
75+
.. code-block:: bash
76+
77+
cd FIPS
78+
../mvnw clean verify
79+
../mvnw org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile=target/snowflake-jdbc-fips.jar -DpomFile=./public_pom.xml
80+
cd -
81+
82+
4. Build the experimental thin-jar and install it in local maven repository by running:
83+
84+
.. code-block:: bash
85+
86+
./mvnw clean verify -Dnot-self-contained-jar -Dthin-jar
87+
./mvnw org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile=target/snowflake-jdbc-thin.jar -DpomFile=./thin_public_pom.xml -Dnot-self-contained-jar -Dthin-jar
88+
89+
- ``thin-jar`` enables thin jar profile
90+
- ``not-self-contained-jar`` turns off fat jar profile (enabled by default)
91+
92+
5. **Note that the built dependencies are installed with version 1.0-SNAPSHOT**
5293

5394
Usage
5495
=====
@@ -111,18 +152,6 @@ You may import the coding style from IntelliJ so that the coding style can be ap
111152
- Enable `google-java-format` for the JDBC project.
112153
- In the source code window, select **Code** -> **Reformat** to apply the coding style.
113154

114-
Thin Jar
115-
========
116-
117-
To build a thin jar run command:
118-
119-
.. code-block:: bash
120-
121-
mvn clean verify -Dthin-jar -Dnot-self-contained-jar
122-
123-
- `thin-jar` enables thin jar profile
124-
- `not-self-contained-jar` turns off fat jar profile (enabled by default)
125-
126155
Tests
127156
=====
128157

0 commit comments

Comments
 (0)