Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Airrecord find_each #102

Open
JacksonRiso opened this issue Apr 28, 2023 · 1 comment
Open

Airrecord find_each #102

JacksonRiso opened this issue Apr 28, 2023 · 1 comment

Comments

@JacksonRiso
Copy link

JacksonRiso commented Apr 28, 2023

Hi team!

I am not experienced enough to write the proper tests for this and open a pull request, but I wanted to share the community my Rails inspired find_each for Airrecord. Instead of looping through the pagination and returning potentially thousands of records in one big array, this allows you to grab one page, process each record in that page, grab the next page, etc.

Example usage

Table.find_each(view: 'blah') do |record|
      puts record.id
end

For big queries and low memory servers it can really help!

Here's my config/airrecord.rb if anyone wants to add this to their application, and of course I would love to see this moved into a pull request.

Airrecord::Table.class_eval do
  def self.find_each(filter: nil, sort: nil, view: nil, offset: nil, paginate: true, fields: nil, max_records: nil, page_size: nil, &block)
    options = {}
    options[:filterByFormula] = filter if filter

    if sort
      options[:sort] = sort.map do |field, direction|
        { field: field.to_s, direction: direction }
      end
    end

    options[:view] = view if view
    options[:offset] = offset if offset
    options[:fields] = fields if fields
    options[:maxRecords] = max_records if max_records
    options[:pageSize] = page_size if page_size

    path = "/v0/#{base_key}/#{client.escape(table_name)}/listRecords"
    response = client.connection.post(path, options.to_json, { 'Content-Type' => 'application/json' })
    parsed_response = client.parse(response.body)

    if response.success?
      records = parsed_response['records']
      records = records.map do |record|
        new(record['fields'], id: record['id'], created_at: record['createdTime'])
      end
      records.each(&block) if block_given?
      if paginate && parsed_response['offset']
        find_each(
          filter: filter,
          sort: sort,
          view: view,
          paginate: paginate,
          fields: fields,
          offset: parsed_response['offset'],
          max_records: max_records,
          page_size: page_size,
          &block
        )
      end

    else
      client.handle_error(response.status, parsed_response)
    end
  end
end

Cheers!

@cloudsbird
Copy link
Contributor

cloudsbird commented May 15, 2023

Interesting.. Let me test if there's a time I will create PR for this one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants