postgres: what changed

Revision 0 to 1. Removed lines have a minus sign; added lines have a plus sign.

Title: postgres

New		Line
1	+	## Overview
2	+
3	+	You can use Free Pascal/Lazarus to access a PostgreSQL database server. If you are looking for information on the postgres package in FPC, please see [[postgres\|postgres#PostgreSQL_package:_the_low_level_units]] below.
4	+
5	+	Advantages of PostgreSQL:
6	+
7	+	- It is very widely used and available
8	+	- Very stable and has a complete feature set
9	+	- Liberal license (no costs) in comparison with MySQL
10	+
11	+	Disadvantage of PostgreSQL:
12	+
13	+	- Some hosters may not offer PostgreSQL)
14	+	- No embedded version
15	+
16	+	Win64: please see warning [[Windows Programming Tips\|here]] on not using certain FPC/Lazarus Win64 versions.
17	+
18	+	## Direct access to PostgreSQL
19	+
20	+	You can connect Lazarus with PostgreSQL by using PostgreSQL Data Access Components (PgDAC). It is a library of components that provides native connectivity to PostgreSQL from Lazarus (and Free Pascal) on Windows, Mac OS X, iOS, Android, Linux, and FreeBSD for both 32-bit and 64-bit platforms. PgDAC is designed to help programmers develop really lightweight, faster and cleaner PostgreSQL database applications without deploying any additional libraries.
21	+
22	+	You can download this [Lazarus component](https://www.devart.com/pgdac/download.html) for free.
23	+
24	+	## Zeos
25	+
26	+	Zeos supports PostgreSQL; please see [[ZeosDBO]]
27	+
28	+	## SQLDB
29	+
30	+	FPC/Lazarus supports PostgreSQL out of the box with a PostgreSQL connection component/class. If you are using FPC only or want to manually add PostgreSQL support, add pqconnection to your uses clause. Otherwise, Lazarus provides a component:
31	+
32	+	![](/wiki-images/c/c5/Sqldbcomponents.png%E2%80%8E)
33	+
34	+	Note: The libpq C client contains some memory leaks (at least up till version 9.3 of Postgres) when a library is repeatedly loaded/unloaded. SQLDB loads the library when the first connection is made, and unloads it when the last connection closes. This means that whenever the last connection is closed, a small memory leak is created. To prevent this from happening (and speed up the application), you can load the library once at the start of the process with the InitialisePostgres3 call.
35	+
36	+	The CharSet property is used for client encoding.
37	+
38	+	The TPQConnection component does not directly support a Port property, but one can pass the port into the component via the Params parameter:
39	+
40	+	``` pascal
41	+	PQConnection.Params.Add('port=' + VariableContainingPort);
42	+	```
43	+
44	+	Also other PostgreSQL specific connection parameters can be specified using the Params property:
45	+
46	+	``` pascal
47	+	PQConnection.Params.Add('application_name=''yourappname''')
48	+	```
49	+
50	+	For all supported connection parameters see: [Connection Parameter Key Words](https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS)
51	+
52	+	### Example
53	+
54	+	See [[SQLdb Tutorial1]] for a tutorial on creating a GUI database-enabled program that is written for PostgreSQL/SQLDB, as well as SQLite/SQLDB, Firebird/SQLDB, basically any RDBMS SQLDB supports).
55	+
56	+	### Event monitoring
57	+
58	+	If you have FPC2.6.2+ and a recent version of Lazarus, you can use the TPQTEventMonitor component to monitor events coming from PostgreSQL.
59	+
60	+	It is a thin wrapper around FPC PQEventMonitor; please see the FPC pqeventstest.pp example programs for details.
61	+
62	+	### Installation and errors
63	+
64	+	As with all sqldb units, you need to add your driver libraries (all required PostgreSQL .dll/.manifest files)
65	+
66	+	- to a directory in the (library search) path (e.g. c:\windows\system32 for Windows)
67	+	- or (Windows) to the program output directory (e.g. lib/something/ in your project directory, and the project directory
68	+
69	+	#### Windows 64 bit driver
70	+
71	+	If you are developing 64 bit applications, you must use a 64 bit DLL.
72	+
73	+	> Note: FPC 2.6.0 (therefore Lazarus 1.0.4 or lower) does not yet support PostgreSQL on Windows 64 bit (unless you patch and recompile it).
74	+
75	+	A Windows 64 driver is fairly hard to find but can be downloaded here: [1](http://www.enterprisedb.com/products-services-training/pgdownload#windows). The driver library can be installed in c:\windows\system32; 32 bit driver libraries can be installed in the confusingly named c:\windows\syswow64
76	+
77	+	#### Error: "Can not load PostgreSQL client library "libpq.dll""
78	+
79	+	The program cannot find your PostgreSQL driver files.
80	+
81	+	See above on instructions where to install the libraries.
82	+
83	+	A good example that demonstrates how to include drive DLL files when connecting Lazarus with PostgreSQL under Windows is [easyDB](http://paginas.fe.up.pt/~asousa/wiki/doku.php?id=proj:lazarus_projects#easy_db).
84	+
85	+	On Linux/Unix/OSX: make sure the PostgreSQL libraries are in your library search path, e.g.:
86	+
87	+	- On Linux add the path to the libpq.so file to the libraries section in your /etc/fpc.cfg file. For example : -Fl/usr/local/pgsql/lib
88	+	- It may be necessary to create a symbolic link from a specific library version to a general library name:
89	+	``` bash
90	+	ln -s /usr/lib/pqsql.so.5 /usr/lib/pqsql.so
91	+	```
92	+
93	+	. Alternatively, install the postgresql client -dev package using your distribution's package manager
94	+
95	+	#### Problems clearing parameters
96	+
97	+	> Note: Verify this: is .paramtype really necessary?
98	+
99	+	At least in FPC \<= 2.6.2: if you .Clear a parameter (i.e. set it to NULL), PostgreSQL may have difficulty recognizing the parameter type.
100	+
101	+	In that case, explicitly specify the type, e.g.:
102	+
103	+	``` pascal
104	+	FWriteQuery.Params.ParamByName('LONGITUDE').ParamType:=ptInput; //required for postgresql
105	+	FWriteQuery.Params.ParamByName('LONGITUDE').Clear
106	+	```
107	+
108	+	## How To
109	+
110	+	### Use keyword RETURNING for values
111	+
112	+	#### Get Last Inserted ID
113	+
114	+	With PostGres there is no need to run a second query to get the last inserted ID.
115	+
116	+	Use INSERT RETURNING and read the value:
117	+
118	+	``` pascal
119	+	var
120	+	ID: Integer
121	+	..
122	+	Query.SQL.Text:= 'INSERT INTO myschema.films(film_name)' +
123	+	'VALUES(:film_name) RETURNING film_id;';
124	+	Query.Open;
125	+	ID:= Query.FieldByName('film_id').AsInteger;
126	+	```
127	+
128	+	#### Get multiple fields and expressions
129	+
130	+	RETURNING in PostgreSQL is more flexible than most database engines. It works with INSERT, UPDATE, and DELETE statements and can be any list of fields, constants, or expressions that would be found in a SELECT list.
131	+
132	+	``` SQL
133	+	INSERT INTO films (film_name) VALUES ('val') RETURNING film_id; -- Returns id's for newly created rows.
134	+	INSERT INTO films (film_name) VALUES ('val') RETURNING film_id, kind; -- Returns id and kind fields in newly created rows.
135	+	INSERT INTO films (film_name) VALUES ('val') RETURNING *; -- Returns all fields in newly created rows.
136	+
137	+	UPDATE films SET kind = 'Dramatic' WHERE kind = 'Drama' RETURNING film_id; -- Returns id's of updated rows.
138	+	UPDATE films SET kind = 'Dramatic' WHERE kind = 'Drama' RETURNING film_id, film_name; -- Returns id and film names of updated rows.
139	+	UPDATE films SET kind = 'Dramatic' WHERE kind = 'Drama' RETURNING *; -- Returns all fields of updated rows.
140	+
141	+	DELETE FROM films RETURNING film_id; --Returns id's of deleted rows.
142	+	DELETE FROM films RETURNING film_id, film_name; --Returns id's and film names of deleted rows.
143	+	DELETE FROM films RETURNING *; -- Returns all fields of deleted rows.
144	+	```
145	+
146	+	RETURNING using fields, constants, and expressions:
147	+
148	+	``` SQL
149	+	INSERT INTO films (film_name) VALUES ('val') RETURNING id, 'a' AS a, id*2 AS doubled_id, CASE WHEN id > 100 THEN 'a' ELSE 'b' END AS foo;
150	+	```
151	+
152	+	## PostgreSQL package: the low level units
153	+
154	+	As with all databases, the SQLDB code depends on a lower level PostgreSQL specific unit that wraps around the PostgreSQL driver library (.so/.dll/.dylib). Normally, you would use the higher-level SQLDB code as it allows you to code more quickly, easily switch databases etc.
155	+
156	+	Using this is very easy, all you need to do is compile some units, and use these units in your program. You need to specify the place of the PostgreSQL client Library (libpq) when compiling, and that is it.
157	+
158	+	The main unit is called postgres, normally this is the only unit you must include in your uses clause.
159	+
160	+	### Requirements
161	+
162	+	You need at least version 0.99.5 of Free Pascal (basically any version of FPC except extremely old ones). The headers are translated from PostgreSQL version 6.3.1.
163	+
164	+	### Installation
165	+
166	+	The postgres unit comes with the Free Pascal packages, and is distributed together with the compiler. This contains a directory postgres with the units, a test program and a makefile. cd to the directory and edit the Makefile to set the variables for your system. You must provide only 1 thing:
167	+
168	+	1. The directory where the libpq library resides, usually /usr/local/pgsql/lib
169	+
170	+	Typing
171	+
172	+	`make`
173	+
174	+	Should compile the units and the program. If compilation was succesfull, you can install with
175	+
176	+	`make install`
177	+
178	+	(Remember to set the directory where the units should be installed.)
179	+
180	+	You can then test the program by running
181	+
182	+	`make test`
183	+
184	+	This will:
185	+
186	+	- Run the test program testpg. It is a straightforward pascal translation of the example program in the PostGreSQL programmers' guide.
187	+	- Run a script to create a table in a database, and fill it with some data. (the psql program should be in your PATH for this) . By default, the used database is testdb.
188	+	- Run the testprogram testemail
189	+	- Run a shell script again to remove the created table.
190	+
191	+	You will see a lot of messages on your screen, giving you feedback and results. If something went wrong, make will inform you of this.
192	+
193	+	Go back to [[Package List\|Packages List]]
194	+
195	+	## See also
196	+
197	+	- [[TPSQL]] - A different set of PostgreSQL dataset/database components
198	+	- [[Lazarus DB Faq]] - More about database programming
199	+	- [[Lazarus Database Tutorial]] - Getting Lazarus working with various databases
200	+
201	+	---
202	+	From the Free Pascal wiki, page "postgres", as it stood on 2020-02-23 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).

Back to history