package/lib/binaryParsers.js000644 0000006150 3560116604 013212 0ustar00000000 000000 var parseInt64 = require('pg-int8') var parseNumeric = require('pg-numeric') var parseInt16 = function (value) { return value.readInt16BE(0) } var parseInt32 = function (value) { return value.readInt32BE(0) } var parseFloat32 = function (value) { return value.readFloatBE(0) } var parseFloat64 = function (value) { return value.readDoubleBE(0) } var parseDate = function (isUTC, value) { var rawValue = 0x100000000 * value.readInt32BE(0) + value.readUInt32BE(4) // discard usecs and shift from 2000 to 1970 var result = new Date((rawValue / 1000) + 946684800000) if (!isUTC) { result.setTime(result.getTime() + result.getTimezoneOffset() * 60000) } // add microseconds to the date result.usec = rawValue % 1000 result.getMicroSeconds = function () { return this.usec } result.setMicroSeconds = function (value) { this.usec = value } result.getUTCMicroSeconds = function () { return this.usec } return result } var parseArray = function (value) { var dim = value.readInt32BE(0) var elementType = value.readUInt32BE(8) var offset = 12 var dims = [] for (var i = 0; i < dim; i++) { // parse dimension dims[i] = value.readInt32BE(offset) offset += 4 // ignore lower bounds offset += 4 } var parseElement = function (elementType) { // parse content length var length = value.readInt32BE(offset) offset += 4 // parse null values if (length === -1) { return null } var result if (elementType === 0x17) { // int result = value.readInt32BE(offset) offset += length return result } else if (elementType === 0x14) { // bigint result = parseInt64(value.slice(offset, offset += length)) return result } else if (elementType === 0x19) { // string result = value.toString('utf8', offset, offset += length) return result } else { throw new Error('ElementType not implemented: ' + elementType) } } var parse = function (dimension, elementType) { var array = [] var i if (dimension.length > 1) { var count = dimension.shift() for (i = 0; i < count; i++) { array[i] = parse(dimension, elementType) } dimension.unshift(count) } else { for (i = 0; i < dimension[0]; i++) { array[i] = parseElement(elementType) } } return array } return parse(dims, elementType) } var parseText = function (value) { return value.toString('utf8') } var parseBool = function (value) { if (value === null) return null return value[0] !== 0 } var init = function (register) { register(20, parseInt64) register(21, parseInt16) register(23, parseInt32) register(26, parseInt32) register(1700, parseNumeric) register(700, parseFloat32) register(701, parseFloat64) register(16, parseBool) register(1114, parseDate.bind(null, false)) register(1184, parseDate.bind(null, true)) register(1000, parseArray) register(1007, parseArray) register(1016, parseArray) register(1008, parseArray) register(1009, parseArray) register(25, parseText) } module.exports = { init: init } package/lib/builtins.js000644 0000002643 3560116604 012222 0ustar00000000 000000 /** * Following query was used to generate this file: SELECT json_object_agg(UPPER(PT.typname), PT.oid::int4 ORDER BY pt.oid) FROM pg_type PT WHERE typnamespace = (SELECT pgn.oid FROM pg_namespace pgn WHERE nspname = 'pg_catalog') -- Take only builting Postgres types with stable OID (extension types are not guaranted to be stable) AND typtype = 'b' -- Only basic types AND typelem = 0 -- Ignore aliases AND typisdefined -- Ignore undefined types */ module.exports = { BOOL: 16, BYTEA: 17, CHAR: 18, INT8: 20, INT2: 21, INT4: 23, REGPROC: 24, TEXT: 25, OID: 26, TID: 27, XID: 28, CID: 29, JSON: 114, XML: 142, PG_NODE_TREE: 194, SMGR: 210, PATH: 602, POLYGON: 604, CIDR: 650, FLOAT4: 700, FLOAT8: 701, ABSTIME: 702, RELTIME: 703, TINTERVAL: 704, CIRCLE: 718, MACADDR8: 774, MONEY: 790, MACADDR: 829, INET: 869, ACLITEM: 1033, BPCHAR: 1042, VARCHAR: 1043, DATE: 1082, TIME: 1083, TIMESTAMP: 1114, TIMESTAMPTZ: 1184, INTERVAL: 1186, TIMETZ: 1266, BIT: 1560, VARBIT: 1562, NUMERIC: 1700, REFCURSOR: 1790, REGPROCEDURE: 2202, REGOPER: 2203, REGOPERATOR: 2204, REGCLASS: 2205, REGTYPE: 2206, UUID: 2950, TXID_SNAPSHOT: 2970, PG_LSN: 3220, PG_NDISTINCT: 3361, PG_DEPENDENCIES: 3402, TSVECTOR: 3614, TSQUERY: 3615, GTSVECTOR: 3642, REGCONFIG: 3734, REGDICTIONARY: 3769, JSONB: 3802, REGNAMESPACE: 4089, REGROLE: 4096 } package/index.js000644 0000002153 3560116604 010726 0ustar00000000 000000 var textParsers = require('./lib/textParsers'); var binaryParsers = require('./lib/binaryParsers'); var builtinTypes = require('./lib/builtins'); exports.getTypeParser = getTypeParser; exports.setTypeParser = setTypeParser; exports.builtins = builtinTypes; var typeParsers = { text: {}, binary: {} }; //the empty parse function function noParse (val) { return String(val); }; //returns a function used to convert a specific type (specified by //oid) into a result javascript type //note: the oid can be obtained via the following sql query: //SELECT oid FROM pg_type WHERE typname = 'TYPE_NAME_HERE'; function getTypeParser (oid, format) { format = format || 'text'; if (!typeParsers[format]) { return noParse; } return typeParsers[format][oid] || noParse; }; function setTypeParser (oid, format, parseFn) { if(typeof format == 'function') { parseFn = format; format = 'text'; } typeParsers[format][oid] = parseFn; }; textParsers.init(function(oid, converter) { typeParsers.text[oid] = converter; }); binaryParsers.init(function(oid, converter) { typeParsers.binary[oid] = converter; }); package/lib/textParsers.js000644 0000010575 3560116604 012720 0ustar00000000 000000 var array = require('postgres-array') var parseDate = require('postgres-date') var parseInterval = require('postgres-interval') var parseByteA = require('postgres-bytea') function parseBool (value) { if (value === null) return value return value === 'TRUE' || value === 't' || value === 'true' || value === 'y' || value === 'yes' || value === 'on' || value === '1' } function parseBoolArray (value) { if (!value) return null return array.parse(value, parseBool) } function parseBaseTenInt (string) { return parseInt(string, 10) } function parseIntegerArray (value) { if (!value) return null return array.parse(value, parseBaseTenInt) } function parseBigIntegerArray (value) { if (!value) return null return array.parse(value, function (entry) { return parseBigInteger(entry).trim() }) } var parsePointArray = function (value) { if (!value) { return null } return array.parse(value, parsePoint) } var parseFloatArray = function (value) { if (!value) { return null } return array.parse(value, parseFloat) } var parseStringArray = function (value) { if (!value) { return null } return array.parse(value, undefined) } var parseDateArray = function (value) { if (!value) { return null } return array.parse(value, parseDate) } var parseIntervalArray = function (value) { if (!value) { return null } return array.parse(value, parseInterval) } var parseByteAArray = function (value) { if (!value) { return null } return array.parse(value, parseByteA) } var parseBigInteger = function (value) { var valStr = String(value) if (/^\d+$/.test(valStr)) { return valStr } return value } var parseJsonArray = function (value) { if (!value) { return null } return array.parse(value, JSON.parse) } var parsePoint = function (value) { if (value[0] !== '(') { return null } value = value.substring(1, value.length - 1).split(',') return { x: parseFloat(value[0]), y: parseFloat(value[1]) } } var parseCircle = function (value) { if (value[0] !== '<' && value[1] !== '(') { return null } var point = '(' var radius = '' var pointParsed = false for (var i = 2; i < value.length - 1; i++) { if (!pointParsed) { point += value[i] } if (value[i] === ')') { pointParsed = true continue } else if (!pointParsed) { continue } if (value[i] === ',') { continue } radius += value[i] } var result = parsePoint(point) result.radius = parseFloat(radius) return result } var init = function (register) { register(20, parseBigInteger) // int8 register(21, parseBaseTenInt) // int2 register(23, parseBaseTenInt) // int4 register(26, parseBaseTenInt) // oid register(700, parseFloat) // float4/real register(701, parseFloat) // float8/double register(16, parseBool) register(1082, parseDate) // date register(1114, parseDate) // timestamp without timezone register(1184, parseDate) // timestamp register(600, parsePoint) // point register(651, parseStringArray) // cidr[] register(718, parseCircle) // circle register(1000, parseBoolArray) register(1001, parseByteAArray) register(1005, parseIntegerArray) // _int2 register(1007, parseIntegerArray) // _int4 register(1028, parseIntegerArray) // oid[] register(1016, parseBigIntegerArray) // _int8 register(1017, parsePointArray) // point[] register(1021, parseFloatArray) // _float4 register(1022, parseFloatArray) // _float8 register(1231, parseStringArray) // _numeric register(1014, parseStringArray) // char register(1015, parseStringArray) // varchar register(1008, parseStringArray) register(1009, parseStringArray) register(1040, parseStringArray) // macaddr[] register(1041, parseStringArray) // inet[] register(1115, parseDateArray) // timestamp without time zone[] register(1182, parseDateArray) // _date register(1185, parseDateArray) // timestamp with time zone[] register(1186, parseInterval) register(1187, parseIntervalArray) register(17, parseByteA) register(114, JSON.parse) // json register(3802, JSON.parse) // jsonb register(199, parseJsonArray) // json[] register(3807, parseJsonArray) // jsonb[] register(3907, parseStringArray) // numrange[] register(2951, parseStringArray) // uuid[] register(791, parseStringArray) // money[] register(1183, parseStringArray) // time[] register(1270, parseStringArray) // timetz[] } module.exports = { init: init } package/package.json000644 0000002513 3560116604 011547 0ustar00000000 000000 { "name": "pg-types", "version": "3.0.0", "description": "Query result type converters for node-postgres", "main": "index.js", "scripts": { "coverage": "nyc --reporter=html npm test && open-cli coverage/index.html", "coverage-ci": "nyc --reporter=lcov npm test && codecov", "lint": "if-node-version '>= 8' standard 'lib/**'", "test": "tape test/*.js | tap-spec && npm run test-ts && npm run lint", "test-ts": "if-node-version '>= 8' tsd" }, "repository": { "type": "git", "url": "git://github.com/brianc/node-pg-types.git" }, "keywords": [ "postgres", "PostgreSQL", "pg" ], "author": "Brian M. Carlson", "license": "MIT", "bugs": { "url": "https://github.com/brianc/node-pg-types/issues" }, "homepage": "https://github.com/brianc/node-pg-types", "devDependencies": { "codecov": "^3.5.0", "if-node-version": "^1.1.1", "nyc": "^14.1.1", "open-cli": "^5.0.0", "standard": "^14.3.1", "tap-spec": "^5.0.0", "tape": "^4.0.0", "tsd": "^0.9.0" }, "dependencies": { "pg-int8": "1.0.1", "pg-numeric": "1.0.2", "postgres-array": "~2.0.0", "postgres-bytea": "~2.0.0", "postgres-date": "~1.0.4", "postgres-interval": "^1.1.0" }, "files": [ "index.js", "index.d.ts", "lib" ], "engines": { "node": ">=8" } } package/README.md000644 0000007367 3560116604 010554 0ustar00000000 000000 # pg-types This is the code that turns all the raw text from postgres into JavaScript types for [node-postgres](https://github.com/brianc/node-postgres.git) ## use This module is consumed and exported from the root `pg` object of node-postgres. To access it, do the following: ```js var types = require('pg').types ``` Generally what you'll want to do is override how a specific data-type is parsed and turned into a JavaScript type. By default the PostgreSQL backend server returns everything as strings. Every data type corresponds to a unique `OID` within the server, and these `OIDs` are sent back with the query response. So, you need to match a particluar `OID` to a function you'd like to use to take the raw text input and produce a valid JavaScript object as a result. `null` values are never parsed. Let's do something I commonly like to do on projects: return 64-bit integers `(int8)` as JavaScript integers. Because JavaScript doesn't have support for 64-bit integers node-postgres cannot confidently parse `int8` data type results as numbers because if you have a _huge_ number it will overflow and the result you'd get back from node-postgres would not be the result in the datbase. That would be a __very bad thing__ so node-postgres just returns `int8` results as strings and leaves the parsing up to you. Let's say that you know you don't and wont ever have numbers greater than `int4` in your database, but you're tired of recieving results from the `COUNT(*)` function as strings (because that function returns `int8`). You would do this: ```js var types = require('pg').types types.setTypeParser(20, function(val) { return parseInt(val) }) ``` __boom__: now you get numbers instead of strings. Just as another example -- not saying this is a good idea -- let's say you want to return all dates from your database as [moment](http://momentjs.com/docs/) objects. Okay, do this: ```js var types = require('pg').types var moment = require('moment') var parseFn = function(val) { return val === null ? null : moment(val) } types.setTypeParser(types.builtins.TIMESTAMPTZ, parseFn) types.setTypeParser(types.builtins.TIMESTAMP, parseFn) ``` _note: I've never done that with my dates, and I'm not 100% sure moment can parse all the date strings returned from postgres. It's just an example!_ If you're thinking "gee, this seems pretty handy, but how can I get a list of all the OIDs in the database and what they correspond to?!?!?!" worry not: ```bash $ psql -c "select typname, oid, typarray from pg_type order by oid" ``` If you want to find out the OID of a specific type: ```bash $ psql -c "select typname, oid, typarray from pg_type where typname = 'daterange' order by oid" ``` :smile: ## license The MIT License (MIT) Copyright (c) 2014 Brian M. Carlson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. package/index.d.ts000644 0000004061 3560116604 011162 0ustar00000000 000000 export enum TypeId { BOOL = 16, BYTEA = 17, CHAR = 18, INT8 = 20, INT2 = 21, INT4 = 23, REGPROC = 24, TEXT = 25, OID = 26, TID = 27, XID = 28, CID = 29, JSON = 114, XML = 142, PG_NODE_TREE = 194, SMGR = 210, PATH = 602, POLYGON = 604, CIDR = 650, FLOAT4 = 700, FLOAT8 = 701, ABSTIME = 702, RELTIME = 703, TINTERVAL = 704, CIRCLE = 718, MACADDR8 = 774, MONEY = 790, MACADDR = 829, INET = 869, ACLITEM = 1033, BPCHAR = 1042, VARCHAR = 1043, DATE = 1082, TIME = 1083, TIMESTAMP = 1114, TIMESTAMPTZ = 1184, INTERVAL = 1186, TIMETZ = 1266, BIT = 1560, VARBIT = 1562, NUMERIC = 1700, REFCURSOR = 1790, REGPROCEDURE = 2202, REGOPER = 2203, REGOPERATOR = 2204, REGCLASS = 2205, REGTYPE = 2206, UUID = 2950, TXID_SNAPSHOT = 2970, PG_LSN = 3220, PG_NDISTINCT = 3361, PG_DEPENDENCIES = 3402, TSVECTOR = 3614, TSQUERY = 3615, GTSVECTOR = 3642, REGCONFIG = 3734, REGDICTIONARY = 3769, JSONB = 3802, REGNAMESPACE = 4089, REGROLE = 4096 } export type TypesBuiltins = { readonly [key in keyof typeof TypeId]: TypeId; }; export type TypeParser = (value: I) => T; export const builtins: TypesBuiltins; export function setTypeParser(oid: number | TypeId, parseFn: TypeParser): void; export function setTypeParser(oid: number | TypeId, format: 'text', parseFn: TypeParser): void; export function setTypeParser(oid: number | TypeId, format: 'binary', parseFn: TypeParser): void; export function getTypeParser(oid: number | TypeId): TypeParser; export function getTypeParser(oid: number | TypeId, format: 'text'): TypeParser; export function getTypeParser(oid: number | TypeId, format: 'binary'): TypeParser; interface ArrayParser { parse(): ReadonlyArray; } export namespace arrayParser { function create(source: string): ArrayParser; function create(source: string, transform: TypeParser): ArrayParser; }