Fields¶
Guillotina uses schemas to define content types and behaviors. These schemas consist of field definitions.
Available fields¶
- guillotina.schema.Bool
- guillotina.schema.Bytes
- guillotina.schema.Choice: validates against vocabulary of values
- guillotina.schema.Date
- guillotina.schema.Datetime
- guillotina.schema.Decimal
- guillotina.schema.Dict
- guillotina.schema.Float
- guillotina.schema.Int
- guillotina.schema.JSONField
- guillotina.schema.List
- guillotina.schema.Set
- guillotina.schema.Text
- guillotina.schema.TextLine
- guillotina.schema.Time
- guillotina.fields.PatchField: allow updating value without patching entire value
- guillotina.fields.BucketListField: optimized storage for very large lists of data
- guillotina.fields.BucketDictField: optimized storage for very large dictionaries of data
- guillotina.files.CloudFileField: file field for storing in db or cloud storage
Patch field¶
Guillotina provides a PatchField
which allows you to patch values of
List
, Dict
and Int
fields without having the original value.
Patch field list¶
from zope.interface import Interface
from guillotina.fields import PatchField
from guillotina import schema
class IMySchema(Interface):
values = PatchField(schema.List(
value_type=schema.Text()
))
Then, payload for patching to append to this list would look like:
{
"values": {
"op": "append",
"value": "foobar"
}
}
Append if unique value only:
{
"values": {
"op": "appendunique",
"value": "foobar"
}
}
Extend:
{
"values": {
"op": "extend",
"value": ["foo", "bar"]
}
}
Extend if unique values:
{
"values": {
"op": "extendunique",
"value": ["foo", "bar"]
}
}
Delete:
{
"values": {
"op": "del",
"value": 0
}
}
Remove:
{
"values": {
"op": "remove",
"value": "foobar"
}
}
Update:
{
"values": {
"op": "update",
"value": {
"index": 0,
"value": "Something new"
}
}
}
Patch dict field¶
from zope.interface import Interface
from guillotina.fields import PatchField
from guillotina import schema
class IMySchema(Interface):
values = PatchField(schema.Dict(
key_type=schema.Text(),
value_type=schema.Text()
))
Then, payload for patching to add to this dict would look like:
{
"values": {
"op": "assign",
"value": {
"key": "foo",
"value": "bar"
}
}
}
Delete:
{
"values": {
"op": "del",
"value": "foo"
}
}
Update:
{
"values": {
"op": "update",
"value": [{
"key": "foo",
"value": "bar"
}, {
"key": "foo2",
"value": "bar2"
}]
}
}
Patch int field¶
PatchField
can also be used on Int
fields to increment, decrement
or reset their original value.
from zope.interface import Interface
from guillotina.fields import PatchField
from guillotina import schema
class IMySchema(Interface):
counter = PatchField(schema.Int(
title='My Counter',
default=1,
))
The payload to increment counter
by 3 units would look like:
{
"counter": {
"op": "inc",
"value": 3
}
}
Notice that, at this point, counter
will be set to 4 because its
default value is 1. If the default would not be set, the increment
operation assumes a 0, and thus counter
would be 3.
Likewise, to decrement the field, the following payload would work:
{
"counter": {
"op": "dec",
"value": 4
}
}
To reset counter
to its default value, you can send the following
payload without value
:
{
"counter": {
"op": "reset"
}
}
and counter
will be set to its default value 1. Otherwise, you can
also send the target reset value:
{
"counter": {
"op": "reset",
"value": 0
}
}
Notice that a reset operation on a integer without a default value is equivalent to sending a value of 0.
Bucket list field¶
from zope.interface import Interface
from guillotina.fields import BucketListField
from guillotina import schema
class IMySchema(Interface):
values = BucketListField(
value_type=schema.Text(),
bucket_len=5000
)
Then, payload for patching to append to this list would look like:
{
"values": {
"op": "append",
"value": "foobar"
}
}
Extend:
{
"values": {
"op": "extend",
"value": ["foo", "bar"]
}
}
Delete:
{
"values": {
"op": "del",
"value": {
"bucket_index": 0,
"item_index": 0
}
}
}
Bucket dict field¶
from zope.interface import Interface
from guillotina.fields import BucketDictField
from guillotina import schema
class IMySchema(Interface):
values = BucketDictField(
key_type=schema.Text(),
value_type=schema.Text(),
bucket_len=5000
)
Then, payload for patching would be…:
{
"values": {
"op": "assign",
"value": {
"key": "foo",
"value": "bar"
}
}
}
Update:
{
"values": {
"op": "update",
"value": [{
"key": "foo",
"value": "barupdated"
}, {
"key": "other",
"value": "othervalue"
}]
}
}
Delete:
{
"values": {
"op": "del",
"value": "foo"
}
}