Mercurial > hg > monetdb-java

comparison README.md @ 959:0c07ad5a00f1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Adding a README.md file
author Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
date Thu, 16 Jan 2025 19:57:12 +0100 (6 months ago)
parents
children 588fb75e6155
comparison
equal deleted inserted replaced
958:52a23aaa8580 959:0c07ad5a00f1
1 ## MonetDB-java
2
3 This repository contains the java source code of the official `MonetDB JDBC driver`,
4 the `MonetDB JdbcClient program`, and some Java test and example programs.
5
6 The master repository is: [hg monetdb-java](https://www.monetdb.org/hg/monetdb-java/file/tip).
7
8 A read-only copy is available on: [github monetdb-java](https://github.com/MonetDB/monetdb-java).
9
10
11 These Java programs are designed to work only with the [MonetDB Database System](https://www.monetdb.org/).
12 They support MonetDB servers from version Jul2015 (11.21) and higher.
13 However only the latest MonetDB server versions are tested actively.
14
15 The `MonetDB JDBC driver` allows Java programs to connect to a MonetDB
16 database server using standard, database independent Java code.
17 It is an open source JDBC driver implementing JDBC API 4.2, written in Pure Java (Type 4),
18 and communicates in the MonetDB native network protocol.
19
20 The sources are actively maintained by the MonetDB team at [MonetDB Solutions](https://www.monetdbsolutions.com/).
21
22 The latest released jar files can be downloaded from [MonetDB Java Download Area](https://www.monetdb.org/downloads/Java/).
23
24 ## Tools
25 To build the jar files yourself, you need `JDK 8` (or higher), `ant` and `make` tools installed.
26
27 ## Build Process
28 To build, simply run `make` command from a shell.
29 See contents of `Makefile` for other `make` targets, such as `make test` or `make doc`.
30
31 The `.class` files will be stored in the `build/` and `tests/build/` subdirectories.
32 The `.jar` files will be stored in the `jars/` subdirectory.
33
34 By default debug symbols are **not** included in the compiled class and jar files.
35 To include debug symbols, edit file `build.properties` change line `enable_debug=true` and rebuild.
36
37 ## Tests
38 **Note** For the tests to succeed you first have to startup a MonetDB server (on localhost, port 50000).
39
40 To test, simply run `make test` command from a shell.
41
42 The `JdbcClient CLI program` (jdbcclient.jre8.jar) includes and uses the MonetDB JDBC driver,
43 so it can also be used to test connectivity and sending SQL statements to a MonetDB server.
44
45 The `JdbcClient CLI program` can be started via shell commands:
46 ```
47 cd jars
48
49 java -jar jdbcclient.jre8.jar
50 ```
51
52 To get a list of JdbcClient startup options simply run:
53 ```
54 java -jar jdbcclient.jre8.jar --help
55 ```
56
57 See [JdbcClient doc](https://www.monetdb.org/documentation/user-guide/client-interfaces/jdbcclient/) for more info.
58
59 ## JDBC Driver
60 The JDBC driver consists of one single jar file: `monetdb-jdbc-##.#.jre8.jar`.
61
62 We recommend to always use the latest released jar file.
63 The latest released JDBC driver can be downloaded from [MonetDB Java Download Area](https://www.monetdb.org/downloads/Java/).
64
65 See [JDBC driver info](https://www.monetdb.org/documentation/user-guide/client-interfaces/libraries-drivers/jdbc-driver/) for more info.
66
67 ## Reporting issues
68 Before reporting an issue, please check if you have used the latest released jar files.
69 Some issues may already have been fixed in the latest released jar files.
70
71 If you find a bug in the latest released jar files or have a request, please log it as an issue at:
72 [github monetdb-java issues](https://github.com/MonetDB/monetdb-java/issues).
73
74 Include which versions of the released JDBC driver and MonetDB server you are using and on which platforms.
75 For bugs also include a small standalone java reproduction program.
76
77 **Note** we do not accept Pull requests on Github.
78
79 ## Copyright Notice
80 SPDX-License-Identifier: MPL-2.0
81
82 This Source Code Form is subject to the terms of the Mozilla Public
83 License, v. 2.0. If a copy of the MPL was not distributed with this
84 file, You can obtain one at http://mozilla.org/MPL/2.0/.
85
86 Copyright 2024 MonetDB Foundation;
87 Copyright August 2008 - 2023 MonetDB B.V.;
88 Copyright 1997 - July 2008 CWI.
89