Skip to content

Add Query Class: full request/reply support #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mwiltzius wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add Query Class: full request/reply support #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2c81a29
Add new Query class
Oct 17, 2025
f4dba1b
Add run, fetchMore, and close methods to Query class
Oct 25, 2025
1dc90eb
Add QueryOptions class
Nov 7, 2025
78b8a1f
Implement queryAndRun method in SQLJob class
Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
228 changes: 226 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ There are four ways to instance 'SQLJob' and then connect:
3. Passining in the path to a `.ini` file listing the authenication information
4. Create an empty instance and call `SQLJob::connect()` with one of the above passed in

### Connecting with an associate array
### Connecting with an associative array
The simplest and quickest way to connect to a server is to instance an `SQLJob` with a associative array as input:
_Note: it is not recommended to set 'ignoreUnauthorized' to true in a live environment. See section on authentication information._

Expand Down Expand Up @@ -147,7 +147,231 @@ You may further more use any other `\WebSocket\Message\Text` instance method on

## Querying the Server

This will be coming.
A Query object can be used to build a query and send it to a server. This is done through SQLJob's `query()` method:
```
require_once('vendor/autoload.php');

use Mapepire\SQLJob;
use Mapepire\Query;

$sqlJob = new SQLJob("/path/to/file/Mapepire.ini");

$query = $sqljob->query("select * from sample.employee");
$result = $query->run(rows: 1);

print_r($result);
```

Alternatively, SQLJob's `queryAndRun()` method can be used:
```
require_once('vendor/autoload.php');

use Mapepire\SQLJob;

$sqlJob = new SQLJob("/path/to/file/Mapepire.ini");

$result = $sqljob->queryAndRun("select * from sample.employee", rows: 1);

print_r($result);
```

Both implementations above code will result in the following output:
```
Array
(
[id] => query3
[has_results] => 1
[update_count] => -1
[metadata] => Array
(
[column_count] => 14
[job] => 325440/QUSER/QZDASOINIT
[columns] => Array
(
[0] => Array
(
[name] => EMPNO
[type] => CHAR
[display_size] => 6
[label] => EMPNO
[precision] => 6
[scale] => 0
)

[1] => Array
(
[name] => FIRSTNME
[type] => VARCHAR
[display_size] => 12
[label] => FIRSTNME
[precision] => 12
[scale] => 0
)

[2] => Array
(
[name] => MIDINIT
[type] => CHAR
[display_size] => 1
[label] => MIDINIT
[precision] => 1
[scale] => 0
)

[3] => Array
(
[name] => LASTNAME
[type] => VARCHAR
[display_size] => 15
[label] => LASTNAME
[precision] => 15
[scale] => 0
)

[4] => Array
(
[name] => WORKDEPT
[type] => CHAR
[display_size] => 3
[label] => WORKDEPT
[precision] => 3
[scale] => 0
)

[5] => Array
(
[name] => PHONENO
[type] => CHAR
[display_size] => 4
[label] => PHONENO
[precision] => 4
[scale] => 0
)

[6] => Array
(
[name] => HIREDATE
[type] => DATE
[display_size] => 10
[label] => HIREDATE
[precision] => 10
[scale] => 0
)

[7] => Array
(
[name] => JOB
[type] => CHAR
[display_size] => 8
[label] => JOB
[precision] => 8
[scale] => 0
)

[8] => Array
(
[name] => EDLEVEL
[type] => SMALLINT
[display_size] => 6
[label] => EDLEVEL
[precision] => 5
[scale] => 0
)

[9] => Array
(
[name] => SEX
[type] => CHAR
[display_size] => 1
[label] => SEX
[precision] => 1
[scale] => 0
)

[10] => Array
(
[name] => BIRTHDATE
[type] => DATE
[display_size] => 10
[label] => BIRTHDATE
[precision] => 10
[scale] => 0
)

[11] => Array
(
[name] => SALARY
[type] => DECIMAL
[display_size] => 11
[label] => SALARY
[precision] => 9
[scale] => 2
)

[12] => Array
(
[name] => BONUS
[type] => DECIMAL
[display_size] => 11
[label] => BONUS
[precision] => 9
[scale] => 2
)

[13] => Array
(
[name] => COMM
[type] => DECIMAL
[display_size] => 11
[label] => COMM
[precision] => 9
[scale] => 2
)

)

)

[data] => Array
(
[0] => Array
(
[EMPNO] => 000010
[FIRSTNME] => CHRISTINE
[MIDINIT] => I
[LASTNAME] => HAAS
[WORKDEPT] => A00
[PHONENO] => 3978
[HIREDATE] => 01/01/65
[JOB] => PRES
[EDLEVEL] => 18
[SEX] => F
[BIRTHDATE] =>
[SALARY] => 52750
[BONUS] => 1000
[COMM] => 4220
)

)

[is_done] =>
[success] => 1
[execution_time] => 185
)
```

The result is an associate array containing the metadata and data from the query. Here are the different fields returned:

* id field contains the query ID
* has_results field indicates whether the query returned any results
* update_count field indicates the number of rows updated by the query (-1 if the query did not update any rows)
* metadata field contains information about the columns returned by the query
* data field contains the results of the query
* is_done field indicates whether the query has finished executing
* success field indicates whether the query was successful.
* execution_time field indicates the time it took to execute the query

In the ouput above, the query was successful and returned one row of data.

## Documentation

Expand Down
Loading