| Overview |  |
Copyright © Inaka <hello@inaka.net>
Main **internal** module for sumo. Use this one from your own applications.
Copyright 2012 Inaka <hello@inaka.net>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.abstract datatype: doc()
abstract datatype: field()
abstract datatype: schema()
| check_operator/1 | Checks the operator is known, throws otherwise. |
| doc_fields/1 | |
| doc_name/1 | Returns the doc name. |
| field_attrs/1 | Returns all attributes of the given field. |
| field_is/2 | True if the field has a given attribute. |
| field_name/1 | Returns the name of the given field. |
| field_type/1 | Returns the type of the given field. |
| get_field/2 | Returns the value of a field from a sumo_doc. |
| get_schema/1 | Returns the schema for a given DocName. |
| id_field_name/1 | Returns name of field marked as ID for the given schema or doc name. |
| id_field_type/1 | Returns type of field marked as ID for the given schema or doc name. |
| new_doc/1 | Returns a new doc. |
| new_doc/2 | Returns a new doc. |
| new_field/3 | Returns a new field of the given type and attributes. |
| new_schema/2 | Returns a new schema. |
| report_overrun/1 | |
| schema_fields/1 | Returns the fields of the schema. |
| schema_name/1 | Returns the name of the schema. |
| set_field/3 | Sets a value in an sumo_doc. |
| wakeup/1 | Wakes up the document. |
check_operator(Op::sumo:operator()) -> ok
Checks the operator is known, throws otherwise.
doc_fields(Doc::doc()) -> sumo:model()
doc_name(Doc::doc()) -> atom()
Returns the doc name
field_attrs(Field::field()) -> sumo:field_attrs()
Returns all attributes of the given field.
field_is(What::atom(), X2::field()) -> boolean()
True if the field has a given attribute.
field_name(X1::field()) -> sumo:field_name()
Returns the name of the given field.
field_type(X1::field()) -> sumo:field_type()
Returns the type of the given field.
get_field(Name::sumo:field_name(), Doc::doc()) -> sumo:field_value()
Returns the value of a field from a sumo_doc.
get_schema(DocName::sumo:schema_name()) -> schema()
Returns the schema for a given DocName.
id_field_name(DocName::sumo:schema_name()) -> sumo:field_name()
Returns name of field marked as ID for the given schema or doc name.
id_field_type(DocName::sumo:schema_name()) -> sumo:field_type()
Returns type of field marked as ID for the given schema or doc name.
new_doc(Name::sumo:schema_name()) -> doc()
Returns a new doc.
new_doc(Name::sumo:schema_name(), Fields::sumo:model()) -> doc()
Returns a new doc.
new_field(Name::sumo:field_name(), Type::sumo:field_type(), Attributes::sumo:field_attrs()) -> field()
Returns a new field of the given type and attributes.
new_schema(Name::sumo:schema_name(), Fields::[field()]) -> schema()
Returns a new schema.
report_overrun(Report::term()) -> ok
Returns the fields of the schema
schema_name(Schema::schema()) -> sumo:schema_name()
Returns the name of the schema
set_field(FieldName::sumo:field_name(), Value::sumo:field_value(), Doc::doc()) -> doc()
Sets a value in an sumo_doc.
wakeup(Doc::doc()) -> sumo:user_doc()
Wakes up the document
Generated by EDoc, Sep 29 2016, 11:57:22.