Skip to content

docs(common): add limit info to the documentation #122

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 2 commits into from
Feb 2, 2018
Merged

docs(common): add limit info to the documentation #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35b88ad
docs(common): add limit info to the documentation
Feb 1, 2018
9f6fb0c
docs(common): add limits page to the documentation sidebar
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
1 change: 1 addition & 0 deletions docs/docs/_sidebar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
- [Installation](/server-lib-reference/installation)
- [Usage](/server-lib-reference/usage)
- [Support](/common/support)
- [Limits](/common/limits)
- [Contributing](/common/contributing)
- [License](/common/license)
- [Changelog](/common/changelog)
70 changes: 70 additions & 0 deletions docs/docs/common/limits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Limits

The limits we apply are based on our research on data operations and are set to provide best performance and user experience. If they block you for any reason, please contact us so that we can work on a custom solution.

## Data Objects

Limits for the the Data Object fields

| 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)|
Copy link
Member

@23doors 23doors Feb 2, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adamwardecki @mkucharz There is also ObjectField that cannot be indexed. Plus, in my opinion these names (TextField, IntegerField etc) are a little too python-like having Django feel all over. Guess that it may not be obvious that IntegerField is a field with type: integer. And this notion is not used in other places: https://github.com/Syncano/syncano-node/blob/master/docs/docs/building-sockets/data-classes.md#types-of-data-class-schema-fields so this is pretty inconsistent.

|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

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.

## Requests

Limits for the number of requests that can be made within one account.

| Request number / second | Request target/source |
|--- |--- |
|60|Administrator with Production Plan account (paid)|
|60|Administrator with Builder Plan account (free)|
|60|Instance (either by admin or API Key usage on a Production plan)|
|10|Anonymous usage|

## Socket Scripts

```
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.
Copy link
Member

@23doors 23doors Feb 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adamwardecki Max is 5 minutes. So 300s, not 500s.


socket.yml example for endpoint with a custom timeout:
```
endpoints:
i-will-timeout:
timeout: 41.9
```

**Script Traces Retention time**

```
Traces are the Script execution logs. It's what you see in the command line when running `s hot` and calling any endpoint
```

Syncano will store the last 100 of Snippet Scripts Traces, for max period of 24 hours. Older traces will be automatically removed. Traces created more than 24 hours ago will be removed (even if they would inside the "last 100" limit).

## Instances

Maximum number of Instances that an administrator can be an owner of is `16`. There's no limit on the number of Instances that an administrator can be invited to.

## Classes

Maximum number of Classes that can be created on paid accounts within a single Instance is `100`

## Groups

There is no limit on a maximum number of groups within an Instance. Maximum number of Groups User can belong to is `32`.