class Chef::DataBag
Constants
- RESERVED_NAMES
- VALID_NAME
Public Class Methods
Source
# File lib/chef/data_bag.rb, line 80 def self.chef_server_rest Chef::ServerAPI.new(Chef::Config[:chef_server_url]) end
Source
# File lib/chef/data_bag.rb, line 84 def self.from_hash(o) bag = new bag.name(o["name"]) bag end
Source
# File lib/chef/data_bag.rb, line 90 def self.list(inflate = false) if Chef::Config[:solo_legacy_mode] paths = Array(Chef::Config[:data_bag_path]) names = [] paths.each do |path| unless File.directory?(path) raise Chef::Exceptions::InvalidDataBagPath, "Data bag path '#{path}' not found. Please create this directory." end names += Dir.glob(File.join( Chef::Util::PathHelper.escape_glob_dir(path), "*" )).map { |f| File.basename(f) }.sort end 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::ServerAPI.new(Chef::Config[:chef_server_url]).get("data") end end end
Source
# File lib/chef/data_bag.rb, line 118 def self.load(name) if Chef::Config[:solo_legacy_mode] paths = Array(Chef::Config[:data_bag_path]) data_bag = {} paths.each do |path| unless File.directory?(path) raise Chef::Exceptions::InvalidDataBagPath, "Data bag path '#{path}' not found. Please create this directory." end Dir.glob(File.join(Chef::Util::PathHelper.escape_glob_dir(path, name.to_s), "*.json")).inject({}) do |bag, f| item = Chef::JSONCompat.parse(IO.read(f)) # Check if we have multiple items with similar names (ids) and raise if their content differs if data_bag.key?(item["id"]) && data_bag[item["id"]] != item raise Chef::Exceptions::DuplicateDataBagItem, "Data bag '#{name}' has items with the same name '#{item["id"]}' but different content." else data_bag[item["id"]] = item end end end data_bag else Chef::ServerAPI.new(Chef::Config[:chef_server_url]).get("data/#{name}") end end
Load a Data Bag by name via either the RESTful API or local data_bag_path if run in solo mode
Source
# File lib/chef/data_bag.rb, line 48 def initialize(chef_server_rest: nil) @name = "" @chef_server_rest = chef_server_rest end
Create a new Chef::DataBag
Source
# File lib/chef/data_bag.rb, line 38 def self.validate_name!(name) unless VALID_NAME.match?(name) raise Exceptions::InvalidDataBagName, "DataBags must have a name matching #{VALID_NAME.inspect}, you gave #{name.inspect}" end if RESERVED_NAMES.match?(name) raise Exceptions::InvalidDataBagName, "DataBags may not have a name matching #{RESERVED_NAMES.inspect}, you gave #{name.inspect}" end end
Public Instance Methods
Source
# File lib/chef/data_bag.rb, line 76 def chef_server_rest @chef_server_rest ||= Chef::ServerAPI.new(Chef::Config[:chef_server_url]) end
Source
# File lib/chef/data_bag.rb, line 163 def create chef_server_rest.post("data", self) self end
create a data bag via RESTful API
Source
# File lib/chef/data_bag.rb, line 144 def destroy chef_server_rest.delete("data/#{@name}") end
Source
# File lib/chef/data_bag.rb, line 53 def name(arg = nil) set_or_return( :name, arg, regex: VALID_NAME ) end
Source
# File lib/chef/data_bag.rb, line 149 def save begin if Chef::Config[:why_run] Chef::Log.warn("In why-run mode, so NOT performing data bag save.") else create end rescue Net::HTTPClientException => e raise e unless e.response.code == "409" end self end
Save the Data Bag via RESTful API
Source
# File lib/chef/data_bag.rb, line 61 def to_h { "name" => @name, "json_class" => self.class.name, "chef_type" => "data_bag", } end
Also aliased as: to_hash
Source
# File lib/chef/data_bag.rb, line 72 def to_json(*a) Chef::JSONCompat.to_json(to_h, *a) end
Serialize this object as a hash