Class: Gcloud::Search::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/gcloud/search/document.rb,
lib/gcloud/search/document/list.rb

Overview

Document

A document is an object that stores data that can be searched. Each document has a #doc_id that is unique within its index, a #rank, and a list of #fields that contain typed data. Its field values can be accessed through hash-like methods such as #[] and #each.

require "gcloud"

gcloud = Gcloud.new
search = gcloud.search
index = search.index "products"

document = index.document "product-sku-000001"
document.add "price", 24.95
index.save document
document.rank #=> 1443648166
document["price"] #=> 24.95

For more information, see Documents and Indexes.

Defined Under Namespace

Classes: List

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Document

Creates a new Document instance.



50
51
52
53
 
# File 'lib/gcloud/search/document.rb', line 50

def initialize #:nodoc:
  @fields = Fields.new
  @raw = {}
end

Class Method Details

.from_hash(hash) ⇒ Object

New Document from a raw data object.



285
286
287
288
289
290
 
# File 'lib/gcloud/search/document.rb', line 285

def self.from_hash hash #:nodoc:
  doc = new
  doc.instance_variable_set "@raw", hash
  doc.instance_variable_set "@fields", Fields.from_raw(hash["fields"])
  doc
end

Instance Method Details

#[](name) ⇒ Object

Retrieve the field values associated to a field name.

Parameters

name

The name of the field. New values will be configured with this name. (String)

Returns

FieldValues

Example

require "gcloud"

gcloud = Gcloud.new
search = gcloud.search
index = search.index "products"

document = index.document "product-sku-000001"
puts "The document description is:"
document["description"].each do |value|
  puts "* #{value} (#{value.type}) [#{value.lang}]"
end



123
124
125
 
# File 'lib/gcloud/search/document.rb', line 123

def [] name
  @fields[name]
end

#add(name, value, type: nil, lang: nil) ⇒ Object

Add a new value. If the field name does not exist it will be added. If the field value is a DateTime or Numeric, or the type is set to :datetime or :number, then the added value will replace any existing values of the same type (since there can be only one). (See Fields#add)

Parameters

name

The name of the field. (String)

value

The value to add to the field. (String or Datetime or Float)

type

The type of the field value. An attempt is made to set the correct type when this option is missing, although it must be provided for :geo values. A field can have multiple values with same or different types; however, it cannot have multiple :datetime or :number values. (Symbol)

The following values are supported:

  • :default - The value is a string. The format will be automatically detected. This is the default value for strings.

  • :text - The value is a string with maximum length 1024**2 characters.

  • :html - The value is an HTML-formatted string with maximum length 1024**2 characters.

  • :atom - The value is a string with maximum length 500 characters.

  • :geo - The value is a point on earth described by latitude and longitude coordinates, represented in string with any of the listed ways of writing coordinates.

  • :datetime - The value is a DateTime.

  • :number - The value is a Numeric between -2,147,483,647 and 2,147,483,647. The value will be stored as a double precision floating point value in Cloud Search.

lang

The language of a string value. Must be a valid ISO 639-1 code. (String)

Example

require "gcloud"

gcloud = Gcloud.new
search = gcloud.search
index = search.index "products"

document = index.document "product-sku-000001"
document.add "sku", "product-sku-000001", type: :atom
document.add "description", "The best T-shirt ever.",
             type: :text, lang: "en"
document.add "description", "<p>The best T-shirt ever.</p>",
             type: :html, lang: "en"
document.add "price", 24.95



199
200
201
 
# File 'lib/gcloud/search/document.rb', line 199

def add name, value, type: nil, lang: nil
  @fields[name].add value, type: type, lang: lang
end

#delete(name, &block) ⇒ Object

Deletes a field and all values. (See Fields#delete)

Parameters

name

The name of the field. (String)

Example

require "gcloud"

gcloud = Gcloud.new
search = gcloud.search
index = search.index "products"

document = index.document "product-sku-000001"
document.delete "description"



224
225
226
 
# File 'lib/gcloud/search/document.rb', line 224

def delete name, &block
  @fields.delete name, &block
end

#doc_id ⇒ Object

The unique identifier for the document. Can be set explicitly when the document is saved. (See Index#document and #doc_id= .) If missing, it is automatically assigned to the document when saved.



59
60
61
 
# File 'lib/gcloud/search/document.rb', line 59

def doc_id
  @raw["docId"]
end

#doc_id=(new_doc_id) ⇒ Object

Sets the unique identifier for the document.

Must contain only visible, printable ASCII characters (ASCII codes 33 through 126 inclusive) and be no longer than 500 characters. It cannot begin with an exclamation point (!), and it cannot begin and end with double underscores (__).



70
71
72
 
# File 'lib/gcloud/search/document.rb', line 70

def doc_id= new_doc_id
  @raw["docId"] = new_doc_id
end

#each(&block) ⇒ Object

Calls block once for each field, passing the field name and values pair as parameters. If no block is given an enumerator is returned instead. (See Fields#each)

Example

require "gcloud"

gcloud = Gcloud.new
search = gcloud.search
index = search.index "products"

document = index.document "product-sku-000001"
puts "The document #{document.doc_id} has the following fields:"
document.each do |name, values|
  puts "* #{name}:"
  values.each do |value|
    puts "  * #{value} (#{value.type})"
  end
end



250
251
252
 
# File 'lib/gcloud/search/document.rb', line 250

def each &block
  @fields.each(&block)
end

#fields ⇒ Object

The fields in the document. Each field has a name (String) and a list of values (FieldValues). (See Fields)



134
135
136
 
# File 'lib/gcloud/search/document.rb', line 134

def fields
  @fields
end

#inspect ⇒ Object

Override to keep working in interactive shells manageable.



276
277
278
279
280
281
 
# File 'lib/gcloud/search/document.rb', line 276

def inspect #:nodoc:
  insp_rank = ""
  insp_rank = ", rank: #{rank}" if rank
  insp_fields = ", fields: (#{fields.names.map(&:inspect).join ', '})"
  "#{self.class}(doc_id: #{doc_id.inspect}#{insp_rank}#{insp_fields})"
end

#names ⇒ Object

Returns a new array populated with all the field names. (See Fields#names)

require "gcloud"

gcloud = Gcloud.new
search = gcloud.search
index = search.index "products"

document = index.document "product-sku-000001"
puts "The document #{document.doc_id} has the following fields:"
document.names.each do |name|
  puts "* #{name}:"
end



270
271
272
 
# File 'lib/gcloud/search/document.rb', line 270

def names
  @fields.names
end

#rank ⇒ Object

A positive integer which determines the default ordering of documents returned from a search. The rank can be set explicitly when the document is saved. (See Index#document and #rank= .) If missing, it is automatically assigned to the document when saved.



79
80
81
 
# File 'lib/gcloud/search/document.rb', line 79

def rank
  @raw["rank"]
end

#rank=(new_rank) ⇒ Object

Sets the rank of the document.

The same rank should not be assigned to many documents, and should never be assigned to more than 10,000 documents. By default (when it is not specified or set to 0), it is set at the time the document is created to the number of seconds since January 1, 2011. The rank can be used in Index#search options expressions, order, and fields, where it is referenced as rank.



92
93
94
 
# File 'lib/gcloud/search/document.rb', line 92

def rank= new_rank
  @raw["rank"] = new_rank
end

#to_hash ⇒ Object

Returns the Document data as a hash



294
295
296
297
298
 
# File 'lib/gcloud/search/document.rb', line 294

def to_hash #:nodoc:
  hash = @raw.dup
  hash["fields"] = @fields.to_raw
  hash
end