Parent

Class/Module Index [+]

Quicksearch

Chef::DataBag

Attributes

couchdb[RW]
couchdb_id[RW]
couchdb_rev[RW]

Public Class Methods

cdb_list(inflate=false, couchdb=nil) click to toggle source

List all the Chef::DataBag objects in the CouchDB. If inflate is set to true, you will get the full list of all Roles, fully inflated.

# File lib/chef/data_bag.rb, line 132
def self.cdb_list(inflate=false, couchdb=nil)
  rs = (couchdb || Chef::CouchDB.new).list("data_bags", inflate)
  lookup = (inflate ? "value" : "key")
  rs["rows"].collect { |r| r[lookup] }
end
cdb_load(name, couchdb=nil) click to toggle source

Load a Data Bag by name from CouchDB

# File lib/chef/data_bag.rb, line 151
def self.cdb_load(name, couchdb=nil)
  (couchdb || Chef::CouchDB.new).load("data_bag", name)
end
chef_server_rest() click to toggle source
# File lib/chef/data_bag.rb, line 116
def self.chef_server_rest
  Chef::REST.new(Chef::Config[:chef_server_url])
end
create_design_document(couchdb=nil) click to toggle source

Set up our CouchDB design document

# File lib/chef/data_bag.rb, line 228
def self.create_design_document(couchdb=nil)
  (couchdb || Chef::CouchDB.new).create_design_document("data_bags", DESIGN_DOCUMENT)
end
json_create(o) click to toggle source

Create a Chef::Role from JSON

# File lib/chef/data_bag.rb, line 121
def self.json_create(o)
  bag = new
  bag.name(o["name"])
  bag.couchdb_rev = o["_rev"] if o.has_key?("_rev")
  bag.couchdb_id = o["_id"] if o.has_key?("_id")
  bag.index_id = bag.couchdb_id
  bag
end
list(inflate=false) click to toggle source
# File lib/chef/data_bag.rb, line 138
def self.list(inflate=false)
  if inflate
    # Can't search for all data bags like other objects, fall back to N+1 :(
    list(false).inject({}) do |response, bag_and_uri|
      response[bag_and_uri.first] = load(bag_and_uri.first)
      response
    end
  else
    Chef::REST.new(Chef::Config[:chef_server_url]).get_rest("data")
  end
end
load(name) click to toggle source

Load a Data Bag by name via either the RESTful API or local data_bag_path if run in solo mode

# File lib/chef/data_bag.rb, line 156
def self.load(name)
  if Chef::Config[:solo]
    unless File.directory?(Chef::Config[:data_bag_path])
      raise Chef::Exceptions::InvalidDataBagPath, "Data bag path '#{Chef::Config[:data_bag_path]}' is invalid"
    end

    Dir.glob(File.join(Chef::Config[:data_bag_path], "#{name}", "*.json")).inject({}) do |bag, f|
      item = JSON.parse(IO.read(f))
      bag[item['id']] = item
      bag
    end
  else
    Chef::REST.new(Chef::Config[:chef_server_url]).get_rest("data/#{name}")
  end
end
new(couchdb=nil) click to toggle source

Create a new Chef::DataBag

# File lib/chef/data_bag.rb, line 82
def initialize(couchdb=nil)
  @name = ''
  @couchdb_rev = nil
  @couchdb_id = nil
  @couchdb = (couchdb || Chef::CouchDB.new)
end
validate_name!(name) click to toggle source
# File lib/chef/data_bag.rb, line 73
def self.validate_name!(name)
  unless name =~ VALID_NAME
    raise Exceptions::InvalidDataBagName, "DataBags must have a name matching #{VALID_NAME.inspect}, you gave #{name.inspect}"
  end
end

Public Instance Methods

cdb_destroy() click to toggle source

Remove this Data Bag from CouchDB

# File lib/chef/data_bag.rb, line 173
def cdb_destroy
  removed = @couchdb.delete("data_bag", @name, @couchdb_rev)
  rs = @couchdb.get_view("data_bags", "entries", :include_docs => true, :startkey => @name, :endkey => @name)
  rs["rows"].each do |row|
    row["doc"].couchdb = couchdb
    row["doc"].cdb_destroy
  end
  removed
end
cdb_save() click to toggle source

Save this Data Bag to the CouchDB

# File lib/chef/data_bag.rb, line 188
def cdb_save
  results = @couchdb.store("data_bag", @name, self)
  @couchdb_rev = results["rev"]
end
chef_server_rest() click to toggle source
# File lib/chef/data_bag.rb, line 112
def chef_server_rest
  Chef::REST.new(Chef::Config[:chef_server_url])
end
create() click to toggle source

create a data bag via RESTful API

# File lib/chef/data_bag.rb, line 209
def create
  chef_server_rest.post_rest("data", self)
  self
end
destroy() click to toggle source
# File lib/chef/data_bag.rb, line 183
def destroy
  chef_server_rest.delete_rest("data/#{@name}")
end
list(inflate=false) click to toggle source

List all the items in this Bag from CouchDB The self.load method does this through the REST API

# File lib/chef/data_bag.rb, line 216
def list(inflate=false)
  rs = nil
  if inflate
    rs = @couchdb.get_view("data_bags", "entries", :include_docs => true, :startkey => @name, :endkey => @name)
    rs["rows"].collect { |r| r["doc"] }
  else
    rs = @couchdb.get_view("data_bags", "entries", :startkey => @name, :endkey => @name)
    rs["rows"].collect { |r| r["value"] }
  end
end
name(arg=nil) click to toggle source
# File lib/chef/data_bag.rb, line 89
def name(arg=nil)
  set_or_return(
    :name,
    arg,
    :regex => VALID_NAME
  )
end
save() click to toggle source

Save the Data Bag via RESTful API

# File lib/chef/data_bag.rb, line 194
def save
  begin
    if Chef::Config[:why_run]
      Chef::Log.warn("In whyrun mode, so NOT performing data bag save.")
    else
      chef_server_rest.put_rest("data/#{@name}", self)
    end
  rescue Net::HTTPServerException => e
    raise e unless e.response.code == "404"
    chef_server_rest.post_rest("data", self)
  end
  self
end
to_hash() click to toggle source
# File lib/chef/data_bag.rb, line 97
def to_hash
  result = {
    "name" => @name,
    'json_class' => self.class.name,
    "chef_type" => "data_bag",
  }
  result["_rev"] = @couchdb_rev if @couchdb_rev
  result
end
to_json(*a) click to toggle source

Serialize this object as a hash

# File lib/chef/data_bag.rb, line 108
def to_json(*a)
  to_hash.to_json(*a)
end
to_s() click to toggle source

As a string

# File lib/chef/data_bag.rb, line 233
def to_s
  "data_bag[#{@name}]"
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.