ExRiak v0.3.1 ExRiak.Metadata View Source

Module to work with Metadata from ExRiak.Object.

Link to this section Summary

Types

Content type of an ExRiak.Object’s value

t()

Functions

Clears all metadata entries

Deletes a specific metadata entry

Returns the content type from metadata

Get all metadata entries

Link to this section Types

Link to this section Functions

Link to this function clear_user_entries(metadata) View Source
clear_user_entries(t()) :: t()

Clears all metadata entries.

See :riakc_obj.clear_user_metadata_entries/1.

Link to this function delete_user_entry(metadata, metadata_key) View Source
delete_user_entry(t(), key()) :: t()

Deletes a specific metadata entry.

See :riakc_obj.delete_user_metadata_entry/2.

Link to this function get_content_type(metadata) View Source
get_content_type(t()) :: content_type() | :undefined

Returns the content type from metadata

Link to this function get_user_entries(metadata) View Source
get_user_entries(t()) :: [entry()]

Get all metadata entries.

See :riakc_obj.get_user_metadata_entries/1.

Link to this function get_user_entry(metadata, metadata_key, default \\ nil) View Source
get_user_entry(t(), key(), default :: term()) :: value() | term()

Get specific metadata entry.

If metadata_key is present in the user metadata with then the associated value is returned. Otherwise default is returned (which is nil unless specified otherwise).

See :riakc_obj.get_user_metadata_entry/2.

Link to this function set_user_entry(metadata, metadata_entry) View Source
set_user_entry(t(), entry()) :: t()

Sets a metadata entry.

See :riakc_obj.set_user_metadata_entry/2.