summaryrefslogtreecommitdiff
path: root/connectivity
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-29 21:55:26 +0430
committerAdolfo Jayme Barrientos <fitojb@ubuntu.com>2021-04-07 17:47:16 +0200
commitea5641baeef73af60d025d185901a303844e2d85 (patch)
tree94b343b35e7b8805beb9a1745fe1de2f382574fb /connectivity
parent33da78c21f4243a3e469fb7df79ed1745df70078 (diff)
Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md and now, the contents of these files were changed to use Markdown format. Other than format inconsistency, some README.md files lacked information about modules, or were out of date. By using LibreOffice / OpenOffice wiki and other documentation websites, these files were updated. Now every README.md file has a title, and some description. The top-level README.md file is changed to add links to the modules. The result of processing the Markdown format README.md files can be seen at: https://docs.libreoffice.org/ Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424 Tested-by: Jenkins Reviewed-by: Michael Stahl <michael.stahl@allotropia.de> Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
Diffstat (limited to 'connectivity')
-rw-r--r--connectivity/README.md50
1 files changed, 28 insertions, 22 deletions
diff --git a/connectivity/README.md b/connectivity/README.md
index 40525a522227..af57e1566daf 100644
--- a/connectivity/README.md
+++ b/connectivity/README.md
@@ -1,44 +1,50 @@
+# Database Connectivity
+
Contains database pieces, drivers, etc.
-[[dbaccess]] builds UI on top of this.
+`dbaccess` builds UI on top of this.
-=== PostgreSQL ===
+## Testing
+### PostgreSQL
For testing, use:
-podman pull postgres:latest
-podman run --name=postgres -e POSTGRES_PASSWORD=foobarbaz -p 127.0.0.1:5432:5432 postgres:latest
+ podman pull postgres:latest
+ podman run --name=postgres -e POSTGRES_PASSWORD=foobarbaz -p 127.0.0.1:5432:5432 postgres:latest
In Base, Connect to an existing database, select PostgreSQL:
-URL: host=127.0.0.1 port=5432 dbname=postgres
-User: postgres
-Password: foobarbaz
-
-podman stop postgres
-podman rm postgres
+ URL: host=127.0.0.1 port=5432 dbname=postgres
+ User: postgres
+ Password: foobarbaz
+
+ podman stop postgres
+ podman rm postgres
In order to test SCRAM authentication, create the container like this:
-podman run --name=postgres -e POSTGRES_PASSWORD=foobarbaz -e POSTGRES_INITDB_ARGS=--auth-host=scram-sha-256 -e POSTGRES_HOST_AUTH_METHOD=scram-sha-256 -p 127.0.0.1:5432:5432 postgres:latest
+ podman run --name=postgres -e POSTGRES_PASSWORD=foobarbaz -e POSTGRES_INITDB_ARGS=--auth-host=scram-sha-256 -e POSTGRES_HOST_AUTH_METHOD=scram-sha-256 -p 127.0.0.1:5432:5432 postgres:latest
-=== mysql_test ===
+### MySQL
+
+For mysql_test:
- The CppunitTest_mysql_test unit test can be used to test the mysqlc
- library with any versions of mysql or mariadb server of your choice.
+library with any versions of mysql or mariadb server of your choice.
- This test does not run automatically. It can be triggered with setting
- the environment variable "CONNECTIVITY_TEST_MYSQL_DRIVER".
+the environment variable "CONNECTIVITY_TEST_MYSQL_DRIVER".
- The environment variable should contain a URL of the following format:
- [user]/[passwd]@sdbc:mysql:mysqlc:[host]:[port]/db_name
+`[user]/[passwd]@sdbc:mysql:mysqlc:[host]:[port]/db_name`
- tl;dr:
- podman pull mariadb/server
- podman run --name=mariadb -e MYSQL_ROOT_PASSWORD=foobarbaz -p 127.0.0.1:3306:3306 mariadb/server
- podman exec -it mariadb /bin/bash -c "echo -e CREATE DATABASE test | /usr/bin/mysql -u root"
- (cd connectivity && make -srj8 CppunitTest_connectivity_mysql_test CONNECTIVITY_TEST_MYSQL_DRIVER="root/foobarbaz@sdbc:mysql:mysqlc:127.0.0.1:3306/test")
- podman stop mariadb
- podman rm mariadb
-
+```
+ podman pull mariadb/server
+ podman run --name=mariadb -e MYSQL_ROOT_PASSWORD=foobarbaz -p 127.0.0.1:3306:3306 mariadb/server
+ podman exec -it mariadb /bin/bash -c "echo -e CREATE DATABASE test | /usr/bin/mysql -u root"
+ (cd connectivity && make -srj8 CppunitTest_connectivity_mysql_test CONNECTIVITY_TEST_MYSQL_DRIVER="root/foobarbaz@sdbc:mysql:mysqlc:127.0.0.1:3306/test")
+ podman stop mariadb
+ podman rm mariadb
+```