From: Michael Wallner Date: Wed, 8 Sep 2021 06:55:58 +0000 (+0200) Subject: fix links with spaces X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=500d5c0c03e1fbbb0ccd7137d73586e3d8209c91;p=mdref%2Fmdref-pq fix links with spaces --- diff --git a/pq.md b/pq.md index 25ad223..a99cdf4 100644 --- a/pq.md +++ b/pq.md @@ -6,8 +6,8 @@ This is a modern binding to the mature [libpq](http://www.postgresql.org/docs/cu ### Highlights: -* Nearly 100% support for [asynchronous usage](pq/Connection/: Asynchronous Usage). -* Extended [type support by pg_type](pq/Types/: Overview). +* Nearly 100% support for [asynchronous usage](pq/Connection/:%20Asynchronous%20Usage). +* Extended [type support by pg_type](pq/Types/:%20Overview). * Fetching simple [multi-dimensional array maps](pq/Result/map). * Working [Gateway implementation](https://bitbucket.org/m6w6/pq-gateway). diff --git a/pq/Cancel/__construct.md b/pq/Cancel/__construct.md index 24fc524..aca9d32 100644 --- a/pq/Cancel/__construct.md +++ b/pq/Cancel/__construct.md @@ -1,6 +1,6 @@ # void pq\Cancel::__construct(pq\Connection $conn) -Create a new cancellation request for an [asynchronous](pq/Connection/: Asynchronous Usage) query. +Create a new cancellation request for an [asynchronous](pq/Connection/:%20Asynchronous%20Usage) query. ## Params: diff --git a/pq/Connection.md b/pq/Connection.md index 262fea3..a9aa125 100644 --- a/pq/Connection.md +++ b/pq/Connection.md @@ -2,14 +2,14 @@ The connection to the PostgreSQL server. -See the [General Usage](pq/Connection/: General Usage) page for an introduction on how to use this class. +See the [General Usage](pq/Connection/:%20General%20Usage) page for an introduction on how to use this class. ## Constants: ### Connection Flags: * PERSISTENT (Re-)open a persistent connection. * ASYNC -If the connection is not already open, perform the connection attempt [asynchronously](pq/Connection/: Asynchronous Usage). +If the connection is not already open, perform the connection attempt [asynchronously](pq/Connection/:%20Asynchronous%20Usage). ### Connection Status: * OK @@ -68,7 +68,7 @@ If the connection is not already open, perform the connection attempt [asynchron * public (readonly) resource $socket The server socket resource. * public (readonly) bool $busy - Whether the connection is busy with [asynchronous operations](pq/Connection/: Asynchronous Usage). + Whether the connection is busy with [asynchronous operations](pq/Connection/:%20Asynchronous%20Usage). * public (readonly) string $errorMessage Any error message on failure. * public (readonly) array $eventHandlers @@ -76,7 +76,7 @@ If the connection is not already open, perform the connection attempt [asynchron * public string $encoding = NULL Connection character set. * public bool $unbuffered = FALSE - Whether to fetch [asynchronous](pq/Connection/: Asynchronous Usage) results in unbuffered mode, i.e. each row generates a distinct pq\Result. + Whether to fetch [asynchronous](pq/Connection/:%20Asynchronous%20Usage) results in unbuffered mode, i.e. each row generates a distinct pq\Result. * public bool $nonblocking = FALSE Whether to set the underlying socket nonblocking, useful for asynchronous handling of writes. See also pq\Connection::flush(). diff --git a/pq/Connection/: Executing Queries.md b/pq/Connection/: Executing Queries.md index 81a16e9..3e6ed6e 100644 --- a/pq/Connection/: Executing Queries.md +++ b/pq/Connection/: Executing Queries.md @@ -18,7 +18,7 @@ pq\Connection::exec() accepts a single argument, a ***query string***, containin $result = $c->exec("SELECT 1*s,2*s,3*s FROM generate_series(1,3) s"); ?> -An object of class pq\Result is returned on success. See [Fetching results](pq/Result/: Fetching Results) for details. +An object of class pq\Result is returned on success. See [Fetching results](pq/Result/:%20Fetching%20Results) for details. > ***NOTE:*** > Only the last result will be returned, if the query string contains more than one SQL query. @@ -30,13 +30,13 @@ pq\Connection::execParams() accepts a ***query string*** with a single SQL query The second argument is an ***array of parameters*** to execute the prepared statement with. -If the third argument is present, an ***array with pg_type OIDs***, those types will be used for the parameters. See [Using types](pq/Types/: Overview) for details. +If the third argument is present, an ***array with pg_type OIDs***, those types will be used for the parameters. See [Using types](pq/Types/:%20Overview) for details. execParams("SELECT int($1) * s, int($2) * s, int($3) * s FROM generate_series(1,3) s", array(1,2,3)); ?> -An object of class pq\Result is returned on success. See [Fetching results](pq/Result/: Fetching Results) for details. +An object of class pq\Result is returned on success. See [Fetching results](pq/Result/:%20Fetching%20Results) for details. ## Explicit prepare & execute of a named statement @@ -45,7 +45,7 @@ pq\Connection::prepare() requires the ***statement name*** as string as first ar The second argument is a ***query string*** containing a single SQL query, which will be prepared on the server. -If the third argument is present, an ***array with pg_type OIDs***, those types will be used for the parameters. See [Using types](pq/Types/: Overview) for details. +If the third argument is present, an ***array with pg_type OIDs***, those types will be used for the parameters. See [Using types](pq/Types/:%20Overview) for details. ***NOTE***: If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. diff --git a/pq/Connection/exec.md b/pq/Connection/exec.md index 54f6dd9..0a2e26b 100644 --- a/pq/Connection/exec.md +++ b/pq/Connection/exec.md @@ -1,6 +1,6 @@ # pq\Result pq\Connection::exec(string $query) -[Execute one or multiple SQL queries](pq/Connection/: Executing Queries) on the connection. +[Execute one or multiple SQL queries](pq/Connection/:%20Executing%20Queries) on the connection. > ***NOTE:*** > Only the last result will be returned, if the query string contains more than one SQL query. diff --git a/pq/Connection/execAsync.md b/pq/Connection/execAsync.md index a002319..459e6ca 100644 --- a/pq/Connection/execAsync.md +++ b/pq/Connection/execAsync.md @@ -1,6 +1,6 @@ # void pq\Connection::exec(string $query[, callable $callback]) -[Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) on the connection. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) [execute an SQL query](pq/Connection:%20Executing%20Queries) on the connection. > ***NOTE***: If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. diff --git a/pq/Connection/execParams.md b/pq/Connection/execParams.md index 9d45720..1282b5a 100644 --- a/pq/Connection/execParams.md +++ b/pq/Connection/execParams.md @@ -1,6 +1,6 @@ # pq\Result pq\Connection::execParams(string $query, array $params[, array $types = NULL]) -[Execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted. +[Execute an SQL query](pq/Connection:%20Executing%20Queries) with properly escaped parameters substituted. ## Params: diff --git a/pq/Connection/execParamsAsync.md b/pq/Connection/execParamsAsync.md index b633f23..c732b09 100644 --- a/pq/Connection/execParamsAsync.md +++ b/pq/Connection/execParamsAsync.md @@ -1,6 +1,6 @@ # pq\Result pq\Connection::execParamsAsync(string $query, array $params[, array $types = NULL, [callable $cb = NULL]]) -[Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) [execute an SQL query](pq/Connection:%20Executing%20Queries) with properly escaped parameters substituted. > ***NOTE***: If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. diff --git a/pq/Connection/getResult.md b/pq/Connection/getResult.md index afbf93e..f2139a6 100644 --- a/pq/Connection/getResult.md +++ b/pq/Connection/getResult.md @@ -1,6 +1,6 @@ # pq\Result pq\Connection::getResult() -Fetch the result of an [asynchronous](pq/Connection/: Asynchronous Usage) query. +Fetch the result of an [asynchronous](pq/Connection/:%20Asynchronous%20Usage) query. If the query hasn't finished yet, the call will block until the result is available. diff --git a/pq/Connection/listenAsync.md b/pq/Connection/listenAsync.md index 3e63d23..75dbd03 100644 --- a/pq/Connection/listenAsync.md +++ b/pq/Connection/listenAsync.md @@ -1,6 +1,6 @@ # void pq\Connection::listenAsync(string $channel, callable $listener) -[Asynchronously](pq/Connection/: Asynchronous Usage) start listening on $channel for notifcations. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) start listening on $channel for notifcations. See pq\Connection::listen(). ## Params: diff --git a/pq/Connection/notifyAsync.md b/pq/Connection/notifyAsync.md index 7ce1b78..28f8e0e 100644 --- a/pq/Connection/notifyAsync.md +++ b/pq/Connection/notifyAsync.md @@ -1,6 +1,6 @@ # void pq\Connection::notifyAsync(string $channel, string $message) -[Asynchronously](pq/Connection/: Asynchronous Usage) start notifying all listeners on $channel with $message. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) start notifying all listeners on $channel with $message. ## Params: diff --git a/pq/Connection/poll.md b/pq/Connection/poll.md index 92e1ae1..cf3c596 100644 --- a/pq/Connection/poll.md +++ b/pq/Connection/poll.md @@ -1,6 +1,6 @@ # int pq\Connection::poll() -Poll an [asynchronously](pq/Connection/: Asynchronous Usage) operating connection. +Poll an [asynchronously](pq/Connection/:%20Asynchronous%20Usage) operating connection. See pq\Connection::resetAsync() for an usage example. ## Params: diff --git a/pq/Connection/prepareAsync.md b/pq/Connection/prepareAsync.md index f74d024..4d51d11 100644 --- a/pq/Connection/prepareAsync.md +++ b/pq/Connection/prepareAsync.md @@ -1,6 +1,6 @@ # pq\Statement pq\Connection::prepareAsync(string $name, string $query[, array $types = NULL]) -[Asynchronously](pq/Connection/: Asynchronous Usage) prepare a named statement for later execution with pq\Statement::exec(). +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) prepare a named statement for later execution with pq\Statement::exec(). > ***NOTE***: If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. diff --git a/pq/Connection/resetAsync.md b/pq/Connection/resetAsync.md index 8b1ff99..2550edb 100644 --- a/pq/Connection/resetAsync.md +++ b/pq/Connection/resetAsync.md @@ -1,6 +1,6 @@ # void pq\Connection::resetAsync() -[Asynchronously](pq/Connection/: Asynchronous Usage) reset a possibly broken connection to a working state. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) reset a possibly broken connection to a working state. ## Params: diff --git a/pq/Connection/startTransactionAsync.md b/pq/Connection/startTransactionAsync.md index 62f8132..5fd9c54 100644 --- a/pq/Connection/startTransactionAsync.md +++ b/pq/Connection/startTransactionAsync.md @@ -1,6 +1,6 @@ # pq\Transaction pq\Connection::startTransactionAsync([int $isolation = pq\Transaction::READ_COMMITTED[, bool $readonly = FALSE[, bool $deferrable = FALSE]]]) -[Asynchronously](pq/Connection/: Asynchronous Usage) begin a transaction. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) begin a transaction. ## Params: diff --git a/pq/Connection/unlistenAsync.md b/pq/Connection/unlistenAsync.md index f8ebfb1..c9e6449 100644 --- a/pq/Connection/unlistenAsync.md +++ b/pq/Connection/unlistenAsync.md @@ -1,6 +1,6 @@ # void pq\Connection::unlistenAsync(string $channel) -[Asynchronously](pq/Connection/: Asynchronous Usage) stop listening for notifications on channel $channel. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) stop listening for notifications on channel $channel. See pq\Connection::unlisten() and pq\Connection::listenAsync(). ## Params: diff --git a/pq/Cursor/__construct.md b/pq/Cursor/__construct.md index a191dcc..8bc7d84 100644 --- a/pq/Cursor/__construct.md +++ b/pq/Cursor/__construct.md @@ -14,7 +14,7 @@ See pq\Connection::declare(). * string $query The query for which the cursor should be opened. * bool $async - Whether to declare the cursor [asynchronously](pq/Connection/: Asynchronous Usage). + Whether to declare the cursor [asynchronously](pq/Connection/:%20Asynchronous%20Usage). ## Throws: diff --git a/pq/Cursor/closeAsync.md b/pq/Cursor/closeAsync.md index 4788521..4332566 100644 --- a/pq/Cursor/closeAsync.md +++ b/pq/Cursor/closeAsync.md @@ -1,6 +1,6 @@ # void pq\Cursor::closeAsync() -[Asynchronously](pq/Connection/: Asynchronous Usage) close an open cursor. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) close an open cursor. See pq\Cursor::close(). ## Params: diff --git a/pq/Cursor/fetchAsync.md b/pq/Cursor/fetchAsync.md index 25c069c..3baa356 100644 --- a/pq/Cursor/fetchAsync.md +++ b/pq/Cursor/fetchAsync.md @@ -1,6 +1,6 @@ # void pq\Cursor::fetchAsync([string $spec = "1"[, callable $callback = NULL]]) -[Asynchronously](pq/Connection/: Asynchronous Usage) fetch rows from the cursor. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) fetch rows from the cursor. See pq\Cursor::fetch(). ## Params: diff --git a/pq/Cursor/moveAsync.md b/pq/Cursor/moveAsync.md index b651cc3..06c9426 100644 --- a/pq/Cursor/moveAsync.md +++ b/pq/Cursor/moveAsync.md @@ -1,6 +1,6 @@ # void pq\Cursor::moveAsync([string $spec = "1"]) -[Asynchronously](pq/Connection/: Asynchronous Usage) move the cursor. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) move the cursor. See pq\Cursor::move(). ## Params: diff --git a/pq/Cursor/openAsync.md b/pq/Cursor/openAsync.md index 9083f22..19d1b23 100644 --- a/pq/Cursor/openAsync.md +++ b/pq/Cursor/openAsync.md @@ -1,6 +1,6 @@ # void pq\Cursor::openAsync() -[Asynchronously](pq/Connection/: Asynchronous Usage) reopen a cursor. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) reopen a cursor. See pq\Cursor::open(). ## Params: diff --git a/pq/Result.md b/pq/Result.md index 50e3138..8d34059 100644 --- a/pq/Result.md +++ b/pq/Result.md @@ -2,7 +2,7 @@ A query result. -See [Fetching Results](pq/Result/: Fetching Results) for a general overview. +See [Fetching Results](pq/Result/:%20Fetching%20Results) for a general overview. ## Constants: diff --git a/pq/Result/: Fetching Results.md b/pq/Result/: Fetching Results.md index 15941e4..28a2c8f 100644 --- a/pq/Result/: Fetching Results.md +++ b/pq/Result/: Fetching Results.md @@ -1,6 +1,6 @@ # pq\Result: Overview -An synchronous pq\Connection::exec*() call, or calls to pq\Connection::getResult() after using [asynchronous queries](pq/Connection/: Asynchronous Usage) returns an instance of pq\Result on success. See [Query execution](pq/Connection/: Executing Queries), optionally with [types](pq/Types/: Overview) and [Prepared Statements](pq/Statement) for details about how to execute queries. +An synchronous pq\Connection::exec*() call, or calls to pq\Connection::getResult() after using [asynchronous queries](pq/Connection/:%20Asynchronous%20Usage) returns an instance of pq\Result on success. See [Query execution](pq/Connection/:%20Executing%20Queries), optionally with [types](pq/Types/:%20Overview) and [Prepared Statements](pq/Statement) for details about how to execute queries. ## Fetch types: diff --git a/pq/Statement/__construct.md b/pq/Statement/__construct.md index 1d26caf..2e7116d 100644 --- a/pq/Statement/__construct.md +++ b/pq/Statement/__construct.md @@ -14,7 +14,7 @@ See pq\Connection::prepare(). * Optional array $types = NULL A list of corresponding query parameter type OIDs. * Optional bool $async = FALSE - Whether to prepare the statement [asynchronously](pq/Connection/: Asynchronous Usage). + Whether to prepare the statement [asynchronously](pq/Connection/:%20Asynchronous%20Usage). ## Throws: diff --git a/pq/Statement/deallocateAsync.md b/pq/Statement/deallocateAsync.md index 44297a8..336b3e2 100644 --- a/pq/Statement/deallocateAsync.md +++ b/pq/Statement/deallocateAsync.md @@ -1,6 +1,6 @@ # void pq\Statement::deallocateAsync() -[Asynchronously](pq/Connection/: Asynchronous Usage) free the server resources used by the +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) free the server resources used by the prepared statement, so it can no longer be executed. ## Params: diff --git a/pq/Statement/descAsync.md b/pq/Statement/descAsync.md index cbcf605..71d940c 100644 --- a/pq/Statement/descAsync.md +++ b/pq/Statement/descAsync.md @@ -1,6 +1,6 @@ # void pq\Statement::descAsync(callable $callback) -[Asynchronously](pq/Connection/: Asynchronous Usage) describe the parameters of the prepared statement. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) describe the parameters of the prepared statement. ## Params: diff --git a/pq/Statement/execAsync.md b/pq/Statement/execAsync.md index 33ead0c..b40337a 100644 --- a/pq/Statement/execAsync.md +++ b/pq/Statement/execAsync.md @@ -1,6 +1,6 @@ # void pq\Statement::execAsync([array $params = NULL, [callable $cb = NULL]]) -[Asynchronously](pq/Connection/: Asynchronous Usage) execute the prepared statement. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) execute the prepared statement. ## Params: diff --git a/pq/Statement/prepareAsync.md b/pq/Statement/prepareAsync.md index 59df126..a4323ee 100644 --- a/pq/Statement/prepareAsync.md +++ b/pq/Statement/prepareAsync.md @@ -1,6 +1,6 @@ # void pq\Statement::prepareAsync() -[Asynchronously](pq/Connection/: Asynchronous Usage) re-prepare a statement that has been +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) re-prepare a statement that has been deallocated. This is a no-op on already open statements. ## Params: diff --git a/pq/Transaction/__construct.md b/pq/Transaction/__construct.md index 8a2dfcd..83e35fb 100644 --- a/pq/Transaction/__construct.md +++ b/pq/Transaction/__construct.md @@ -8,7 +8,7 @@ See pq\Connection::startTransaction(). * pq\Connection $conn The connection to start the transaction on. * Optional bool $async = FALSE - Whether to start the transaction [asynchronously](pq/Connection/: Asynchronous Usage). + Whether to start the transaction [asynchronously](pq/Connection/:%20Asynchronous%20Usage). * Optional int $isolation = pq\Transaction::READ_COMMITTED The transaction isolation level (defaults to pq\Connection::$defaultTransactionIsolation). * Optional bool $readonly = FALSE diff --git a/pq/Transaction/commitAsync.md b/pq/Transaction/commitAsync.md index 75d8f69..c026632 100644 --- a/pq/Transaction/commitAsync.md +++ b/pq/Transaction/commitAsync.md @@ -1,6 +1,6 @@ # void pq\Transaction::commitAsync() -[Asynchronously](pq/Connection/: Asynchronous Usage) commit the transaction or release the previous savepoint. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) commit the transaction or release the previous savepoint. See pq\Transaction::commit() and pq\Transaction::savepoint(). ## Params: diff --git a/pq/Transaction/exportSnapshotAsync.md b/pq/Transaction/exportSnapshotAsync.md index 3152d2c..e91f6d2 100644 --- a/pq/Transaction/exportSnapshotAsync.md +++ b/pq/Transaction/exportSnapshotAsync.md @@ -1,6 +1,6 @@ # void pq\Transaction::exportSnapshotAsync() -[Asynchronously](pq/Connection/: Asynchronous Usage) export a snapshot for transaction synchronization. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) export a snapshot for transaction synchronization. See pq\Transaction::exportSnapshot(). ## Params: diff --git a/pq/Transaction/importSnapshotAsync.md b/pq/Transaction/importSnapshotAsync.md index c62e1b3..6deffbd 100644 --- a/pq/Transaction/importSnapshotAsync.md +++ b/pq/Transaction/importSnapshotAsync.md @@ -1,6 +1,6 @@ # void pq\Transaction::importSnapshotAsync(string $snapshot_id) -[Asynchronously](pq/Connection/: Asynchronous Usage) import a snapshot from another transaction to synchronize with. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) import a snapshot from another transaction to synchronize with. See pq\Transaction::importSnapshot(). > ***NOTE:*** diff --git a/pq/Transaction/rollbackAsync.md b/pq/Transaction/rollbackAsync.md index cba1d4b..feb3b98 100644 --- a/pq/Transaction/rollbackAsync.md +++ b/pq/Transaction/rollbackAsync.md @@ -1,6 +1,6 @@ # void pq\Transaction::rollbackAsync() -[Asynchronously](pq/Connection/: Asynchronous Usage) rollback the transaction or to the previous savepoint within this transaction. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) rollback the transaction or to the previous savepoint within this transaction. See pq\Transaction::rollback() and pq\Transaction::savepoint(). ## Params: diff --git a/pq/Transaction/savepointAsync.md b/pq/Transaction/savepointAsync.md index 8c45122..aba13c4 100644 --- a/pq/Transaction/savepointAsync.md +++ b/pq/Transaction/savepointAsync.md @@ -1,6 +1,6 @@ # void pq\Transaction::savepointAsync() -[Asynchronously](pq/Connection/: Asynchronous Usage) create a `SAVEPOINT` within this transaction. +[Asynchronously](pq/Connection/:%20Asynchronous%20Usage) create a `SAVEPOINT` within this transaction. See pq\Transaction::savepoint(). ## Params: diff --git a/pq/Types.md b/pq/Types.md index 5564225..90d777e 100644 --- a/pq/Types.md +++ b/pq/Types.md @@ -1,7 +1,7 @@ # class pq\Types implements ArrayAccess Accessor to the PostgreSQL `pg_type` relation. -See [here for an overview](pq/Types/: Overview). +See [here for an overview](pq/Types/:%20Overview). ## Example: diff --git a/pq/Types/: Overview.md b/pq/Types/: Overview.md index 023704d..bb41e4d 100644 --- a/pq/Types/: Overview.md +++ b/pq/Types/: Overview.md @@ -26,7 +26,7 @@ The types are standard objects indexed by OID and by name and accessible by arra > ***NOTE:*** The pg_type relation fields have a ``typ`` prefix. -## Usage when [executing queries](pq/Connection/: Executing Queries) +## Usage when [executing queries](pq/Connection/:%20Executing%20Queries)