Skip to content

docs(common): apply review comments #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamwardecki merged 3 commits into from
Feb 6, 2018
Merged

docs(common): apply review comments #124

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e2c1596
docs(common): apply review comments
Feb 2, 2018
03e4e83
docs(common): apply review comments
Feb 2, 2018
0fab514
docs(common): remove unecessary info on class relation field
Feb 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/docs/common/limits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,24 @@ The limits we apply are based on our research on data operations and are set to

## Data Objects

Limits for the the Data Object fields
- Maximal size of a Data Object is `32kB`.
- Data Objects can have a max of `32` fields.
- `16` of the fields can be indexed, `8` if both `order_index` and `filter_index` is used for each field
- `text`, `file` and `object` fields can't be indexed.
- Data Object field names can have a maximum length of `64` characters.

| Description | Limit | Notes |
|--- |--- |--- |
|Data Object size | 32kB (serialized)||
|Data Object fields number|32 fields|16 of the Data Object fields can be indexed (you can use any type as index except TextField and FileField)|
|Object field name|64 max character length||
|TextField|32000 max character length||
|StringField|128 max character length||
|IntegerField|32-bit (signed)||
|FloatField|64-bit|Double precision field with up to 15 decimal digit precision|
|ArrayField|Can hold only Strings, Integer or Floats|Cannot contain Object type (JSON fields)|
|RelationField|Can hold relations to max 1000 Data Objects from one selected Data Class|Relation can be linked to only one selected data class. You cannot have Relation field storing references to Data Objects from multiple different data classes.|
|ObjectField|Any JSON object|Without limits, limited only by the max size of Data Object (32kB)|

## Files
Limits for the specific Data Object fields:

A limit for a file size is 128MB. This is a web server limit and can be worked around by sending larger files in chunks.
| Field type | Limit | Notes |
|--- |--- |--- |
|text|32000 max character length||
|string|128 max character length||
|integer|32-bit (signed)||
|float|64-bit|Double precision field with up to 15 decimal digit precision|
|array|Can hold only Strings, Integer or Floats|Cannot contain Object type (JSON fields)|
|relation|Can hold relations to max 1000 Data Objects||
|object|Any JSON object|Without limits, limited only by the max size of Data Object (32kB)|
|file|binary data, max 128MB|||

## Requests

Expand All @@ -39,7 +39,7 @@ Limits for the number of requests that can be made within one account.
```
Applies for both Socket Endpoint Scripts and Event Handlers
```
The default execution time for Scripts is `30` seconds. It can be adjusted by adding a `timeout` property in the socket.yml. A valid range is `0 >` and `< 500` seconds. Integer and float values are allowed.
The default execution time for Scripts is `30` seconds. It can be adjusted by adding a `timeout` property in the socket.yml. A valid range is `0 >` and `< 300` seconds. Integer and float values are allowed.

socket.yml example for endpoint with a custom timeout:
```
Expand Down