Skip to content

Commit 90cd77e

Browse files
committed
Minor readme update
1 parent daabe63 commit 90cd77e

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

README.rst

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ An external SQLAlchemy dialect for Firebird
1010

1111
----
1212

13-
| Those who want to use the open source `Firebird <https://firebirdsql.org/en/start/>`_ database server with `Python <https://www.python.org>`_ using `SQLAlchemy <https://www.sqlalchemy.org>`_ need to provide a dialect that SQLAlchemy can use to communicate to the database, because Firebird is not among the included dialects.
13+
Those who want to use the open source `Firebird <https://firebirdsql.org/en/start/>`_ database server with `Python <https://www.python.org>`_ using `SQLAlchemy <https://www.sqlalchemy.org>`_ need to provide a dialect that SQLAlchemy can use to communicate to the database, because Firebird is not among the included dialects.
14+
1415
This package provides a Firebird dialect for SQLAlchemy using the Python Database API 2.0 compliant support provided from either `firebird-driver <https://firebird-driver.readthedocs.io/en/latest>`_ or `fdb <https://fdb.readthedocs.io/en/latest>`_.
1516

1617
----
@@ -42,7 +43,7 @@ The following information is needed to make the connection string:
4243
- <port> - Firebird default is '3050'
4344
- <database_path> - location of the database file
4445
- <charset> - character set used by the database file, Firebird default is UTF8
45-
- <client_library_path> - path to the firebird client library file. Linux needs 'fbclient.so', Windows uses fblient.dll. This is only needed when using the embedded server or a remotely installed server.
46+
- <client_library_path> - path to the firebird client library file. Linux needs 'libfbclient.so', Windows uses fblient.dll. This is only needed when using the embedded server or a remotely installed server.
4647

4748
Connection Strings
4849

@@ -53,9 +54,10 @@ The template for a Firebird connection string looks like this (using the informa
5354

5455
firebird+<driver_name>://<username>:<password>@<host>:<port>/<database_path>[?charset=UTF8&key=value&key=value...]
5556

56-
Example connection strings from a configuration file:
57+
Note the only differences between the Linux and Windows versions of the following example configuration strings is that the Linux paths begin with '//home/testuser' while the Windows paths begin with 'c:/':
58+
5759

58-
- Firebird server installed locally using the default port
60+
- The simplest configuration string is for the Firebird server installed locally using the default port.
5961

6062
::
6163

@@ -71,27 +73,15 @@ Example connection strings from a configuration file:
7173
# Use the firebird-driver driver (Python 3.8+, Firebird server 3.0 or greater)
7274
firebird+firebird://sysdba:masterkey@localhost/c:/projects/databases/my_project.fdb
7375

74-
- Firebird server installed locally using port 3040
75-
76-
::
77-
78-
[Linux]
79-
# Use the firebird-driver driver (Python 3.8+)
80-
firebird+firebird://sysdba:masterkey@localhost:3040///home/testuser/projects/databases/my_project.fdb
81-
82-
[Windows]
83-
# Use the firebird-driver driver (Python 3.8+)
84-
firebird+firebird://sysdba:masterkey@localhost:3040/c:/projects/databases/my_project.fdb
85-
8676
- Firebird server installed remotely using port 3040 and specifying the character set to use
8777

8878
::
8979

9080
[Linux]
9181
# Use the fdb driver (Python 3.6/3.7, or Firebird server 2.5.9)
92-
firebird+fdb://sysdba:masterkey@localhost:3040///home/testuser/databases/my_project.fdb?charset=UTF8&fb_library_name=//home/testuser/dbclient/fbclient.so
82+
firebird+fdb://sysdba:masterkey@localhost:3040///home/testuser/databases/my_project.fdb?charset=UTF8&fb_library_name=//home/testuser/dbclient/lib/libfbclient.so
9383
# Use the firebird-driver driver (Python 3.8+)
94-
firebird+firebird://sysdba:masterkey@localhost:3040///home/testuser/databases/my_project.fdb?charset=UTF8&fb_client_library=//home/testuser/dbclient/fbclient.so
84+
firebird+firebird://sysdba:masterkey@localhost:3040///home/testuser/databases/my_project.fdb?charset=UTF8&fb_client_library=//home/testuser/dbclient/lib/libfbclient.so
9585

9686
[Windows]
9787
# Use the fdb driver (Python 3.6/3.7, or Firebird server 2.5.9)
@@ -105,9 +95,9 @@ Example connection strings from a configuration file:
10595

10696
[Linux]
10797
# Use the fdb driver (Python 3.6/3.7, or Firebird server 2.5.9)
108-
firebird+fdb://sysdba@///home/testuser/databases/my_project.fdb?charset=UTF8&fb_library_name=//home/testuser/dbserver/fbclient.so
98+
firebird+fdb://sysdba@///home/testuser/databases/my_project.fdb?charset=UTF8&fb_library_name=//home/testuser/dbserver/lib/libfbclient.so
10999
# Use the firebird-driver driver (Python 3.8+)
110-
firebird+firebird://sysdba@///home/testuser/databases/my_project.fdb?charset=UTF8&fb_client_library=//home/testuser/dbserver/fbclient.so
100+
firebird+firebird://sysdba@///home/testuser/databases/my_project.fdb?charset=UTF8&fb_client_library=//home/testuser/dbserver/lib/libfbclient.so
111101

112102
[Windows]
113103
# Use the fdb driver (Python 3.6/3.7, or Firebird server 2.5.9)
@@ -120,7 +110,7 @@ Example connection strings from a configuration file:
120110

121111
**How to use**
122112

123-
For example, to connect to an embedded Firebird server using firebird-driver:
113+
For example, to connect to an embedded Firebird server using firebird-driver on Windows:
124114

125115
::
126116

0 commit comments

Comments
 (0)