etr.plugins.resources.Storage Class Reference

Provides the storage abstraction for Resources. More...

Public Member Functions
def	__init__ (self, db_path)
def	zeroize (self)
	Wipe database of all data. More...
def	add_resource (self, source, resid, name, attributes)
	Add or update a resource uniquely identified by resid More...
def	remove_resource (self, source, resid)
	Remove resource. More...
def	get_resource (self, str name)
	Get one resource using user provided name for resource. More...
def	has_resource_by_name (self, str name)
	Check if storage has resource in storage. More...
def	has_resource_by_id (self, source, resid)
	Check if storage has resource in storage. More...
List[str]	get_resource_names (self)
	Get all resource names. More...
List[Resource]	get_resources (self)
	Get all resources. More...

Detailed Description

Provides the storage abstraction for Resources.

Note

: A resource id is unique together with source.

Constructor & Destructor Documentation

__init__()

def etr.plugins.resources.Storage.__init__	(		self,
			db_path
	)

Parameters

db_path

Sqlite3 database file (can also be :memory: for in-memory storage).

Member Function Documentation

add_resource()

def etr.plugins.resources.Storage.add_resource	(		self,
			source,
			resid,
			name,
			attributes
	)

Add or update a resource uniquely identified by resid

Parameters

source	resource source (e.g. hostname)
resid	resource id
name	user provided resource name
attributes	attributes to store

get_resource()

def etr.plugins.resources.Storage.get_resource	(		self,
		str	name
	)

Get one resource using user provided name for resource.

Parameters

name	resource name Returns `Resource`

get_resource_names()

List[str] etr.plugins.resources.Storage.get_resource_names

(

self

)

Get all resource names.

Returns List of resource names

get_resources()

List[Resource] etr.plugins.resources.Storage.get_resources

(

self

)

Get all resources.

   Returns list of `Resource`s: [Resource(source, resid, name, attributes),...]

has_resource_by_id()

def etr.plugins.resources.Storage.has_resource_by_id	(		self,
			source,
			resid
	)

Check if storage has resource in storage.

Parameters

source	resource source
resid	resource id

Returns

True if storage has resource False otherwise

has_resource_by_name()

def etr.plugins.resources.Storage.has_resource_by_name	(		self,
		str	name
	)

Check if storage has resource in storage.

Parameters

name	resource name

Returns

True if storage has resource False otherwise

remove_resource()

def etr.plugins.resources.Storage.remove_resource	(		self,
			source,
			resid
	)

Remove resource.

Parameters

source	resource source
resid	resource id

zeroize()

def etr.plugins.resources.Storage.zeroize

(

self

)

Wipe database of all data.

---

The documentation for this class was generated from the following file:

• etr/src/etr/plugins/resources.py