Skip to content

Commit dfdac13

Browse files
Revise README for PostgreSQL Integration Plugin
Updated README to enhance clarity and detail on plugin features, installation, and usage.
1 parent 3d92e0a commit dfdac13

1 file changed

Lines changed: 94 additions & 2 deletions

File tree

README.md

Lines changed: 94 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,94 @@
1-
# PostgreSQLPlugin_UE5
2-
PostgreSQL Integration for Unreal Engine 5
1+
# **PostgreSQL Integration Plugin for Unreal Engine 5**
2+
3+
A lightweight plugin that enables **direct PostgreSQL database access** inside Unreal Engine, supporting both **C++** and **Blueprints**.
4+
For support, join the Discord server:
5+
**[https://discord.gg/BxHRHDdkNy](https://discord.gg/BxHRHDdkNy)**
6+
7+
---
8+
9+
## **Features**
10+
11+
* **Direct PostgreSQL Connectivity**
12+
Connect Unreal Engine directly to any PostgreSQL server (local or remote).
13+
14+
* **SSL Support**
15+
Optional SSL connection with selectable SSL modes and optional root certificate use.
16+
17+
* **OS Support**
18+
Currently supports **Windows only**.
19+
(Tested on Windows 10 with UE5.2)
20+
21+
* **Query Execution**
22+
Run SQL commands, retrieve results, and map rows/columns easily.
23+
24+
* **Blueprint-Friendly**
25+
All major operations exposed as simple Blueprint nodes.
26+
27+
* **CSV + Structured Results**
28+
Query results can be returned both as CSV rows and structured maps.
29+
30+
---
31+
32+
## **Available Functions**
33+
34+
### **PG_Connect(...)**
35+
36+
Opens a connection to a PostgreSQL database with optional SSL settings.
37+
38+
### **PG_Disconnect(Connection)**
39+
40+
Closes an active PostgreSQL connection.
41+
42+
### **PG_IsConnected(Connection)**
43+
44+
Returns whether the connection is valid and open.
45+
46+
### **PG_ExecuteNonQuery(Connection, Sql, OutError)**
47+
48+
Executes SQL statements that do **not** return rows
49+
(e.g., INSERT, UPDATE, DELETE, CREATE, DROP).
50+
51+
### **PG_ExecuteQuery(Connection, Sql, PrimaryKeyColumn, OutRowsByPK, OutRowsCSV, OutError)**
52+
53+
Runs a SELECT query and returns data in two formats:
54+
55+
* A map of rows keyed by a primary column
56+
* An array of CSV-formatted rows
57+
58+
---
59+
60+
## **Compatibility**
61+
62+
### **Precompiled Binaries**
63+
64+
* Unreal Engine **5.2**
65+
66+
### **Source Code**
67+
68+
Should compile normally for other Unreal Engine versions.
69+
70+
Need precompiled binaries for another version?
71+
Open an issue or ask on Discord.
72+
73+
---
74+
75+
## **Installation**
76+
77+
Download the correct version from Releases:
78+
**[https://github.com/GPUbrainStorm/PostgreSQLPlugin_UE5/releases](https://github.com/GPUbrainStorm/PostgreSQLPlugin_UE5/releases)**
79+
80+
### **Precompiled (UE 5.2)**
81+
82+
Place the plugin into your project's **Plugins/** folder and launch normally.
83+
84+
### **From Source Code (Any Version)**
85+
86+
Copy the plugin to your project's **Plugins/** directory and build normally.
87+
88+
---
89+
90+
## **Usage Example**
91+
92+
<img width="1119" height="407" alt="image" src="https://github.com/user-attachments/assets/189f1bc8-3896-4b0c-a122-bc75f996a0d9" />
93+
<img width="1078" height="393" alt="image" src="https://github.com/user-attachments/assets/5170e131-1944-446c-9b08-fbcdfd1c086c" />
94+
<img width="1836" height="671" alt="image" src="https://github.com/user-attachments/assets/0c0e9957-d9d8-44a6-acf4-3abc5afc1cdc" />

0 commit comments

Comments
 (0)