Hebcal ES6 interface to GeoNames and USA ZIP code SQLite databases

This package is designed for the hebcal.com and may not be generally reusable. It requires two separate databases, one made from GeoNames.org data (available via a Creative Commons license) and a USA ZIP code database (commercial license).

$ npm install @hebcal/geo-sqlite
$ ./node_modules/.bin/download-and-make-dbs

import {Location} from '@hebcal/core';
import {GeoDb} from '@hebcal/geo-sqlite';
import pino from 'pino';
const logger = pino();

const db = new GeoDb(logger, 'zips.sqlite3', 'geonames.sqlite3');
const loc1 = db.lookupZip('90210'); // Beverly Hills, California
const loc2 = db.lookupGeoname(293397); // Tel Aviv
const loc3 = db.lookupLegacyCity('IL-Netanya');
db.close();

Some location data is incorporated directly into this package, including the bundled fixtures used by make-test-dbs to build test databases (the ~60 "classic" Hebcal cities, cities-patch.txt, and related country/admin1 data). This data is derived from GeoNames.org and is used under the Creative Commons Attribution 4.0 License.

GeoDb

Wrapper around sqlite databases

buildGeonamesSqlite(opts)

Builds geonames.sqlite3 from files downloaded from geonames.org

doSql(logger, db, ...sqls)

doFile(logger, db, infile, tableName, expectedFields, callback)

makeZipsSqlite(dbFilename, sqlFile)

Builds zips.sqlite3 from the bundled zips-dummy.sql schema file

Wrapper around sqlite databases

Kind: global class

• GeoDb
  • new GeoDb(logger, zipsFilename, geonamesFilename, options)
  • instance
    • .zipCache : Map.<string, Location>
    • .geonamesCache : Map.<number, Location>
    • .legacyCities : Map.<string, number>
    • .countryNames : Map.<string, string>
    • .close()
    • .lookupZip(zip) ⇒ Location
    • .lookupGeoname(geonameid) ⇒ Location
    • .lookupLegacyCity(cityName) ⇒ Location
    • .autoComplete(qraw, latlong) ⇒ Array.<Object>
    • .cacheZips()
    • .cacheGeonames()
  • static
    • .transliterate(source, [options]) ⇒ string
    • .geonameCityDescr(cityName, admin1, countryName) ⇒ string
    • .version()
    • .is5DigitZip(str) ⇒ boolean

Kind: instance property of GeoDb

Kind: instance property of GeoDb

Kind: instance property of GeoDb

Kind: instance property of GeoDb

Closes database handles

Kind: instance method of GeoDb

Kind: instance method of GeoDb

Kind: instance method of GeoDb

Kind: instance method of GeoDb

Generates autocomplete results based on a query string

Kind: instance method of GeoDb

Reads entire ZIP database and caches in-memory

Kind: instance method of GeoDb

Reads entire geonames database and caches in-memory

Kind: instance method of GeoDb

Convenience wrapper of the transliterate function from transliteration npm package. Transliterate the string source and return the result.

Kind: static method of GeoDb

Builds a city description from geonameid string components

Kind: static method of GeoDb

Returns the version of the GeoDb package

Kind: static method of GeoDb

Kind: static method of GeoDb

Builds geonames.sqlite3 from files downloaded from geonames.org

Kind: global function

Kind: global function

Kind: global function

Builds zips.sqlite3 from the bundled zips-dummy.sql schema file

Kind: global function