{"_id":"@benny1hk/pdo","name":"@benny1hk/pdo","dist-tags":{"latest":"1.2.0"},"versions":{"1.2.0":{"name":"@benny1hk/pdo","version":"1.2.0","main":"app.js","author":{"name":"benny1hk","email":"me@bennyng.uk"},"license":"ISC","description":"PHP's PDO for node.js","engines":{"node":">=4.9.1"},"repository":{"type":"git","url":"git+https://github.com/benny1hk/node-pdo.git"},"keywords":["pdo","php","cubrid","mssql","firebird","ibm","informix","mysql","oracle","odbc","db2","postgresql","sqlite","4d","freetds","sybase"],"bugs":{"url":"https://github.com/benny1hk/node-pdo/issues"},"homepage":"https://github.com/benny1hk/node-pdo#readme","directories":{"doc":"docs"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"gitHead":"84de383fb18678dd88c7690f4f3256b486f66f80","_id":"@benny1hk/pdo@1.2.0","_nodeVersion":"14.21.3","_npmVersion":"6.14.18","dist":{"integrity":"sha512-L81dmKIURamv8jd3uo44Lsvhg5IpR3EMbM4QZVzOoFnJnBJiYokXIRfR0CH4SVBf6WRjKRf3t7lHinbYapiY/Q==","shasum":"caed4cf1f28ebd7eca7194c6752ebcd905dad0a8","tarball":"https://registry.npmjs.org/@benny1hk/pdo/-/pdo-1.2.0.tgz","fileCount":5,"unpackedSize":25276,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDRbgVOcsJN2aAFOk7fsMGd7Sy5z7xXXHAxBxZe/Z538gIgQuwOBZHg8hBrre1b8NZhyMCzjYUA/dhkhPcQW1HdCXw="}]},"_npmUser":{"name":"benny530","email":"ben_1hk@msn.com"},"maintainers":[{"name":"benny530","email":"ben_1hk@msn.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/pdo_1.2.0_1685926517523_0.39604905381217836"},"_hasShrinkwrap":false}},"time":{"created":"2023-06-05T00:55:17.438Z","1.2.0":"2023-06-05T00:55:17.702Z","modified":"2023-06-05T00:55:17.904Z"},"maintainers":[{"name":"benny530","email":"ben_1hk@msn.com"}],"description":"PHP's PDO for node.js","homepage":"https://github.com/benny1hk/node-pdo#readme","keywords":["pdo","php","cubrid","mssql","firebird","ibm","informix","mysql","oracle","odbc","db2","postgresql","sqlite","4d","freetds","sybase"],"repository":{"type":"git","url":"git+https://github.com/benny1hk/node-pdo.git"},"author":{"name":"benny1hk","email":"me@bennyng.uk"},"bugs":{"url":"https://github.com/benny1hk/node-pdo/issues"},"license":"ISC","readme":"![PHP + PDO + NodeJS](docs/logo.png)\r\n\r\n# A bridge for using PHP's PDO within NodeJS\r\n\r\nPHP's PDO has a [wide range of database driver support](http://uk1.php.net/manual/en/pdo.drivers.php).  This module brings PDO's functionality to node.\r\n\r\nRequires NodeJS >= 4.9.1\r\n\r\nThis module uses PHP under the hood, so requires PHP (>= 5.0.0) to be installed on the local system.\r\n\r\nYour `php.ini` must be configured to enable the PDO drivers you require.\r\n\r\nNo other dependencies.\r\n\r\nFeature requests & bug reports are welcome.\r\n\r\n## Install\r\n\r\n```\r\nnpm i pdo\r\n```\r\n\r\n## Example Usage\r\n\r\n```js\r\nconst PDO = require('pdo');\r\n\r\nconst db = new PDO()\r\nawait db.open(dsn);\r\n\r\nawait db.query(`\r\n    INSERT INTO users\r\n    SET ?\r\n`, [\r\n    {\r\n        username: \"admin\",\r\n        password: \"hunter2\"\r\n    }\r\n]);\r\n\r\nawait db.query(`\r\n    SELECT *\r\n    FROM users\r\n    WHERE username = ?\r\n    OR id IN (?)\r\n`, [\r\n    \"admin\",\r\n    [1, 2, 3]\r\n]);\r\n\r\nawait db.close();\r\n```\r\n\r\n## A note on parameterised queries\r\n\r\nAs with all SQL interfaces, special care should be taken to ensure that all user inputs are correctly sanitised before being included in an SQL query.  PHP's PDO supports parameterised queries to facilitate this, using question marks or colon-prefixed labels as placeholders for query parameters.\r\n\r\nThis module only supports question mark placeholders at this time, but (unlike PHP's PDO) can also expand objects and arrays as per the example above.\r\n\r\n## API\r\n\r\n### Methods\r\n\r\n### new PDO( options : object )\r\n\r\nAvailable options:\r\n\r\n* `expandPlaceholders : bool` - Should queries expand array and object paramters into multiple placeholders? (default: `true`)\r\n* `phpPath : string` - Path to the PHP binary. (default: `'php'`)\r\n* `closeCursorAfterExec : bool` - Automatically call closeCursor() on each statement after execution. Note: Some drivers require this. (default: `false`)\r\n* `stringifyFetches : bool` - Automatically convert all returned values into strings. Note: Some drivers will perform this conversion regardless of this setting. (default: `false`)\r\n* `emulatePrepares : bool` - Should PDO prefer to emulate prepared statements? Note: PDO will *always* emulate prepared statements when not natively supported by your driver. (default: `false`)\r\n* `timeoutSeconds : int` - A query timeout in seconds. Use `0` to disable. (default: `0`)\r\n\r\n#### PDO::open( dsn : string ) : Promise\r\n\r\nOpen a PDO connection.\r\n\r\nSee http://uk1.php.net/manual/en/pdo.construct.php for information about DSNs.\r\n\r\nReturns a Promise resolved when the connection is opened.  \r\nPromise will reject on error.\r\n\r\n#### PDO::exec( sql : string [, params : Array] ) : Promise\r\n\r\nExecutes a query.  \r\nReturns a Promise which resolves when execution is complete.  \r\nPromise will reject on error.\r\n\r\n#### PDO::query( sql : string [, params : Array] ) : Promise\r\n#### PDO::queryAll( sql : string [, params : Array] ) : Promise\r\n#### PDO::queryOne( sql : string [, params : Array] ) : Promise\r\n#### PDO::queryColumn( sql : string [, params : Array [, columnIndex = 0 : integer ] ] ) : Promise\r\n\r\nExecute a query and return a result.  \r\nReturns a Promise which resolves to the rows returned.  \r\n\r\n`PDO::query()` and `PDO::queryAll()` return all rows.  \r\n`PDO::queryOne()` returns a single row.  \r\n`PDO::queryColumn()` returns a single field from a single row.  \r\n`PDO::beginTransaction()` initiates a transaction.\r\n`PDO::commit()` commits a transaction.\r\n`PDO::rollback()` rolls back a transaction. \r\n\r\nPromise will reject on error.\r\n\r\n#### PDO::close( ) : Promise\r\n\r\nYou should always close your PDO connection when no longer needed.  This will allow the underlying PHP process to close, freeing up resources.\r\n\r\n#### PDO::on( event : string, handler : function )\r\n\r\nPDO is an event emitter.  See below for list of events.\r\n\r\n### Events\r\n\r\n`error` - fired when an error occurs with the child PHP process.\r\n","readmeFilename":"README.md"}