# class Chef::DataBag

### Constants

VALID_NAME

### Public Class Methods

chef_server_rest() click to toggle source

    # File lib/chef/data_bag.rb, line 73
    def self.chef_server_rest
      Chef::REST.new(Chef::Config[:chef_server_url])
    end

json_create(o) click to toggle source

Create a Chef::Role from JSON

    # File lib/chef/data_bag.rb, line 78
    def self.json_create(o)
      bag = new
      bag.name(o["name"])
      bag
    end

list(inflate=false) click to toggle source

    # File lib/chef/data_bag.rb, line 84
    def self.list(inflate=false)
      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

        names = Dir.glob(File.join(Chef::Config[:data_bag_path], "*")).map{|f|File.basename(f)}.sort
        names.inject({}) {|h, n| h[n] = n; h}
      else
        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
    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 106
    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 = Chef::JSONCompat.from_json(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() click to toggle source

Create a new Chef::DataBag

    # File lib/chef/data_bag.rb, line 43
    def initialize
      @name = ''
    end

validate_name!(name) click to toggle source

    # File lib/chef/data_bag.rb, line 36
    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

chef_server_rest() click to toggle source

    # File lib/chef/data_bag.rb, line 69
    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 141
    def create
      chef_server_rest.post_rest("data", self)
      self
    end

destroy() click to toggle source

    # File lib/chef/data_bag.rb, line 122
    def destroy
      chef_server_rest.delete_rest("data/#{@name}")
    end

name(arg=nil) click to toggle source

    # File lib/chef/data_bag.rb, line 47
    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 127
    def save
      begin
        if Chef::Config[:why_run]
          Chef::Log.warn("In whyrun mode, so NOT performing data bag save.")
        else
          create
        end
      rescue Net::HTTPServerException => e
        raise e unless e.response.code == "409"
      end
      self
    end

to_hash() click to toggle source

    # File lib/chef/data_bag.rb, line 55
    def to_hash
      result = {
        "name" => @name,
        'json_class' => self.class.name,
        "chef_type" => "data_bag",
      }
      result
    end

to_json(*a) click to toggle source

Serialize this object as a hash

    # File lib/chef/data_bag.rb, line 65
    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 147
    def to_s
      "data_bag[#{@name}]"
    end