Airtable Ruby Client
Easily connect to airtable data using ruby with access to all of the airtable features.
Note on library status
We are currently transitioning this gem to be supported by Airtable. We will maintain it moving forward, but until we fully support it, it will stay in the status of "community libraries". At that time we will remove this notice and add a "ruby" section to the API docs.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install airtable
Creating a Client
# Pass in api key to client @client = Airtable::Client.new("keyPCx5W")
Your API key carries the same privileges as your user account, so be sure to keep it secret!
Accessing a Table
Now we can access any table in our Airsheet account by referencing the API docs:
# Pass in the app key and table name @table = @client.table("appPo84QuCy2BPgLk", "Table Name")
Once you have access to a table from above, we can query a set of records in the table with:
@records = @table.records
We can specify a
offset as part of our query:
@records = @table.records(:sort => ["Name", :asc], :limit => 50) @records # => [#<Airtable::Record :name=>"Bill Lowry", :email=>"firstname.lastname@example.org">, ...] @records.offset #=> "itrEN2TCbrcSN2BMs"
This will return the records based on the query as well as an
offset for the next round of records. We can then access the contents of any record:
@bill = @record.first # => #<Airtable::Record :name=>"Bill Lowry", :email=>"email@example.com", :id=>"rec02sKGVIzU65eV1"> @bill[:id] # => "rec02sKGVIzU65eV2" @bill[:name] # => "Bill Lowry" @bill[:email] # => "firstname.lastname@example.org"
Note that you can only request a maximimum of 100 records in a single query. To retrieve more records, use the "batch" feature below.
Batch Querying All Records
We can also query all records in the table through a series of batch requests with:
@records = @table.all(:sort => ["Name", :asc])
This executes a variable number of network requests (100 records per batch) to retrieve all records in a sheet.
We can also use
select method to query based on specific conditions using
@records = @table.select(sort: ["Order", "asc"], formula: "Active = 1")
This will return all the records that has
Active column value as
true from table.
Finding a Record
Records can be queried by
id using the
find method on a table:
@record = @table.find("rec02sKGVIzU65eV2") # => #<Airtable::Record :name=>"Bill Lowry", :email=>"email@example.com", :id=>"rec02sKGVIzU65eV1">
Records can be inserted using the
create method on a table:
@record = Airtable::Record.new(:name => "Sarah Jaine", :email => "firstname.lastname@example.org") @table.create(@record) # => #<Airtable::Record :name=>"Sarah Jaine", :email=>"email@example.com", :id=>"rec03sKOVIzU65eV4">
Records can be updated using the
update method on a table:
@record[:email] = "firstname.lastname@example.org" @table.update(record) # => #<Airtable::Record :name=>"Sarah Jaine", :email=>"email@example.com", :id=>"rec03sKOVIzU65eV4">
Records can be destroyed using the
destroy method on a table:
- Fork it ( https://github.com/nesquena/airtable-ruby/fork )
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request