Class: OData::QueryBuilder

The query builder is used to call query operations against the service. This shouldn‘t be called directly, but rather it is returned from the dynamic methods created for the specific service that you are calling.

For example, given the following code snippet:

              svc = OData::Service.new "http://127.0.0.1:8888/SampleService/Entities.svc"
              svc.Categories

The Categories method would return a QueryBuilder

Methods

expand filter new query

Public Class methods

new(root)

Creates a new instance of the QueryBuilder class

Required Attributes

root: The root entity collection to query against

[Source]

# File lib/odata_ruby/query_builder.rb, line 13
        def initialize(root)
                @root = root.to_s
                @expands = []
                @filters = []
        end

Public Instance methods

expand(path)

Used to eagerly-load data for nested objects, for example, obtaining a Category for a Product within one call to the server

Required Attributes

path: The path of the entity to expand relative to the root

Example

     # Without expanding the query (no Category will be filled in for the Product)
     svc.Products(1)
     prod1 = svc.execute

     # With expanding the query (the Category will be filled in)
     svc.Products(1).expand('Category')
     prod1 = svc.execute

[Source]

# File lib/odata_ruby/query_builder.rb, line 31
        def expand(path)
                @expands << path
                self
        end

filter(filter)

Used to filter data being returned

Required Attributes

filter: The path of the entity to expand relative to the root

Example

     svc.Products.filter("Name eq 'Product 2'")
     prod = svc.execute

[Source]

# File lib/odata_ruby/query_builder.rb, line 43
        def filter(filter)
                @filters << CGI.escape(filter)
                self
        end

query()

Builds the query URI (path, not including root) incorporating expands, filters, etc. This is used internally when the execute method is called on the service

[Source]

# File lib/odata_ruby/query_builder.rb, line 50
        def query
                q = @root.clone
                query_options = []
                query_options << "$expand=#{@expands.join(',')}" unless @expands.empty?
                query_options << "$filter=#{@filters.join('+and+')}" unless @filters.empty?
                if !query_options.empty?
                        q << "?"
                        q << query_options.join('&') 
                end
                return q      
        end