Project

text_ferry

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
A DSL for loading CSV text files into a database.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 0.1.3
~> 0.9.2
~> 3.11
~> 1.3.4

Runtime

~> 3.28.0
 Project Readme

Text Ferry¶ ↑

<img src=“https://badge.fury.io/rb/text_ferry.svg” alt=“Gem Version” /> <img src=“https://gemnasium.com/bnadlerjr/text_ferry.svg” alt=“Dependency Status” /> <img src=“https://codeclimate.com/github/bnadlerjr/text_ferry/badges/gpa.svg” />

Text Ferry is a super simple DSL for quickly loading CSV text files into a database.

Installation¶ ↑

gem install text_ferry

or in your Gemfile:

gem "text_ferry"

Notes / Use¶ ↑

Text Ferry relies on Sequel to do the heavy lifting. You will need to be familiar with how to define a table schema using Sequel. For example, to load a CSV file named “data.csv” that is located in a folder named “/my_data”:

loader = TextFerry::Loader.new("sqlite://sample.db", "/my_data")
loader.load_table(:data) do
  primary_key :id
  String :name
  String :phone
end

This will load data from the CSV file into a database named “sample.db” using the given column names and types. Note that if the table already exists in the database, it will be dropped and re-created using the given schema.

Patches / Pull Requests¶ ↑

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Commit, do not mess with rakefile, version, or history (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull).

  • Send me a pull request. Bonus points for topic branches.

License¶ ↑

The MIT License

Copyright © 2011-2020 Bob Nadler, Jr.

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.