Skip to content

Latest commit

 

History

History
185 lines (129 loc) · 4.05 KB

README.md

File metadata and controls

185 lines (129 loc) · 4.05 KB
Raw

worlddb

world.db Command Line Tool in Ruby

Usage Command Line

The worlddb gem lets you load plain text fixtures into your database (and also includes schema n models for easy reuse).

SYNOPSIS
    worlddb [global options] command [command options] [arguments...]

VERSION
    2.0

GLOBAL OPTIONS
    -d, --dbpath=PATH - Database path (default: .)
    -n, --dbname=NAME - Database name (default: world.db)
    --verbose         - (Debug) Show debug messages
    --version         - Show version

COMMANDS
    create        - Create DB schema
    setup, s      - Create DB schema 'n' load all world data
    update, up, u - Update all world data
    load, l       - Load world fixtures
    logs          - Show logs
    props         - Show props
    stats         - Show stats
    test          - (Debug) Test command suite
    help          - Shows a list of commands or help for one command

setup Command

NAME
    setup - Create DB schema 'n' load all world data

SYNOPSIS
    worlddb [global options] setup [command options] NAME

COMMAND OPTIONS
    -i, --include=PATH  - World data path (default: .)

EXAMPLES
    worlddb setup --include ./world.db
    worlddb setup us --include ./world.db

update Command

NAME
    update - Update all world data

SYNOPSIS
    worlddb [global options] update [command options] NAME

COMMAND OPTIONS
    --delete           - Delete all world data records
    -i, --include=PATH - World data path (default: .)

EXAMPLES
    worlddb update --include ./world.db
    worlddb update --include ./world.db --delete

load Command

NAME
    load - Load world fixtures

SYNOPSIS
    worlddb [global options] load [command options] NAME

COMMAND OPTIONS
    --delete           - Delete all world data records
    -i, --include=PATH - World data path (default: .)

EXAMPLES
    worlddb load --include ./world.db europe/countries

Usage Models

Country Model - Example:

at = Country.find_by! key: 'at'
at.name
# => 'Austria'
at.pop
# => 8_414_638
at.area
# => 83_871

at.regions.count
# => 9
at.regions
# => [ 'Wien', 'Niederösterreich', 'Oberösterreich', ... ]

at.cities.by_pop
# => [ 'Wien', 'Graz', 'Linz', 'Salzburg', 'Innsbruck' ... ]

City Model - Example:

c = City.find_by! key: 'wien'
c.name
# => 'Wien'
c.country.name
# => 'Austria'
c.country.continent.name
# => 'Europe'

la = City.find_by! key: 'losangeles'
la.name
# => 'Los Angeles'
la.region.name
# => 'California'
la.region.key
# => 'ca'
la.country.name
# => 'United States'
la.country.key
# => 'us'
la.country.continent.name
# => 'North America'

Tag Model - Example:

euro = Tag.find_by! key: 'euro'
euro.countries.count
# => 17
euro.countries
# => ['Austria, 'Belgium', 'Cyprus', ... ]

flanders = Tag.find_by! key: 'flanders'
flanders.regions.count
# => 5
flanders.regions
# => ['Antwerpen', 'Brabant Wallon', 'Limburg', 'Oost-Vlaanderen', 'West-Vlaanderen']
flanders.regions.first.country.name
# => 'Belgium'

and so on.

Install

Just install the gem:

$ gem install worlddb

Free Open Public Domain Datasets

  • world.db - free open public domain countries, regions, cities n more data for use in any (programming) language

License

The worlddb scripts are dedicated to the public domain. Use it as you please with no restrictions whatsoever.

Questions? Comments?

Send them along to the Open Mundi (world.db) Database Forum/Mailing List. Thanks!