Mercurial > hg > monetdb-java

annotate README.md @ 970:f90d811e97eb default tip

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