docs(common): apply review comments #124
Conversation
Codecov Report
@@ Coverage Diff @@
## master #124 +/- ##
==========================================
- Coverage 34.49% 34.33% -0.16%
==========================================
Files 118 106 -12
Lines 4592 3157 -1435
==========================================
- Hits 1584 1084 -500
+ Misses 3008 2073 -935 |
docs/docs/common/limits.md
Outdated
| |array|Can hold only Strings, Integer or Floats|Cannot contain Object type (JSON fields)| | ||
| |relation|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.| | ||
| |object|Any JSON object|Without limits, limited only by the max size of Data Object (32kB)| | ||
| |file|binary data, max 128MB|This is a web server limit and can be worked around by sending larger files in chunks.| |
There was a problem hiding this comment.
That's not exactly true. Max http post body limit is 128MB. So you can in theory send file1 of 128MB then in another request send second file2 of 128MB to same DO. But overall you cannot have larger files than 128MB in any way.
docs/docs/common/limits.md
Outdated
| 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` and `file` fields can't be indexed). |
There was a problem hiding this comment.
as noted in last PR, object cannot be indexed as well.
Also, not all fields can have order index (array, geopoint, relation) as it doesn't make sense there but not sure if this is even worth mentioning.
In relatively recent additions, there is also unique that implies filter_index=true and it cannot be applied to text, file, object (as all the other indexes) - and array, geopoint relation.
There was a problem hiding this comment.
Maybe I'll add this info to another section on filtering and ordering which we should port from the legacy docs?
docs/docs/common/limits.md
Outdated
| |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 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.| |
There was a problem hiding this comment.
But you can have multiple relations to circumvent that and it's not exactly a limitation, just a characteristic that relation and reference types are bound to specific class when declared.
There was a problem hiding this comment.
Should I remove this entry altogether?
There was a problem hiding this comment.
Maybe just leave it at Can hold ids of max 1000 Data Objects?
|
codecov doesn't seem to be correct ;) |
|
@maciejkorsan Can you review? |
|
LGTM |
5 participants
No description provided.