diff --git a/docs/api-status.json b/docs/api-status.json index b4c2df700..24d1558d6 100644 --- a/docs/api-status.json +++ b/docs/api-status.json @@ -2264,5 +2264,111 @@ "became_stable_version": "v0.18.0" } ] + }, + "rados/striper": { + "preview_api": [ + { + "name": "Striper.Read", + "comment": "Read bytes into data from the striped object at the specified offset.\n\nImplements:\n\n\tint rados_striper_read(rados_striper_t striper,\n\t const char *soid,\n\t const char *buf,\n\t size_t len,\n\t uint64_t off);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.Stat", + "comment": "Stat returns metadata describing the striped object.\n\nImplements:\n\n\tint rados_striper_stat2(rados_striper_t striper,\n\t const char* soid,\n\t uint64_t *psize,\n\t struct timespec *pmtime);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "New", + "comment": "New returns a rados Striper object created from a rados IOContext.\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "NewWithLayout", + "comment": "NewWithLayout returns a rados Striper object created from a rados IOContext\nand striper layout parameters. These parameters will be used when new\nobjects are created.\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.Destroy", + "comment": "Destroy the radosstriper object at the Ceph API level.\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.SetObjectLayoutStripeUnit", + "comment": "SetObjectLayoutStripeUnit sets the stripe unit value used to layout\nnew objects.\n\nImplements:\n\n\tint rados_striper_set_object_layout_stripe_unit(rados_striper_t striper,\n\t unsigned int stripe_unit);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.SetObjectLayoutStripeCount", + "comment": "SetObjectLayoutStripeCount sets the stripe count value used to layout\nnew objects.\n\nImplements:\n\n\tint rados_striper_set_object_layout_stripe_count(rados_striper_t striper,\n\t unsigned int stripe_count);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.SetObjectLayoutObjectSize", + "comment": "SetObjectLayoutObjectSize sets the object size value used to layout\nnew objects.\n\nImplements:\n\n\tint rados_striper_set_object_layout_object_size(rados_striper_t striper,\n\t unsigned int object_size);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.Write", + "comment": "Write bytes from data into the striped object at the specified offset.\n\nImplements:\n\n\tint rados_striper_write(rados_striper_t striper,\n\t const char *soid,\n\t const char *buf,\n\t size_t len,\n\t uint64_t off);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.WriteFull", + "comment": "WriteFull writes all of the bytes in data to the striped object, truncating\nthe object to the length of data.\n\nImplements:\n\n\tint rados_striper_write_full(rados_striper_t striper,\n\t const char *soid,\n\t const char *buf,\n\t size_t len);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.Append", + "comment": "Append the bytes in data to the end of the striped object.\n\nImplements:\n\n\tint rados_striper_append(rados_striper_t striper,\n\t const char *soid,\n\t const char *buf,\n\t size_t len);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.Remove", + "comment": "Remove a striped RADOS object.\n\nImplements:\n\n\tint rados_striper_remove(rados_striper_t striper,\n\t const char *soid);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.Truncate", + "comment": "Truncate a striped object, setting it to the specified size.\n\nImplements:\n\n\tint rados_striper_trunc(rados_striper_t striper, const char *soid, uint64_t size);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.GetXattr", + "comment": "GetXattr retrieves an extended attribute (xattr) of the given name from the\nspecified striped object.\n\nImplements:\n\n\tint rados_striper_getxattr(rados_striper_t striper,\n\t const char *oid,\n\t const char *name,\n\t char *buf,\n\t size_t len);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.SetXattr", + "comment": "SetXattr sets an extended attribute (xattr) of the given name on the\nspecified striped object.\n\nImplements:\n\n\tint rados_striper_setxattr(rados_striper_t striper,\n\t const char *oid,\n\t const char *name,\n\t const char *buf,\n\t size_t len);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.RmXattr", + "comment": "RmXattr removes the extended attribute (xattr) of the given name from the\nstriped object.\n\nImplements:\n\n\tint rados_striper_rmxattr(rados_striper_t striper,\n\t const char *oid,\n\t const char *name);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + }, + { + "name": "Striper.ListXattrs", + "comment": "ListXattrs returns a map containing all of the extended attributes (xattrs)\nfor a striped object. The xattr names provide the key strings and the map's\nvalues are byte slices.\n\nImplements:\n\n\tint rados_striper_getxattrs(rados_striper_t striper,\n\t const char *oid,\n\t rados_xattrs_iter_t *iter);\n", + "added_in_version": "$NEXT_RELEASE", + "expected_stable_version": "$NEXT_RELEASE_STABLE" + } + ] } -} +} \ No newline at end of file diff --git a/docs/api-status.md b/docs/api-status.md index 0726f288b..82db1ea60 100644 --- a/docs/api-status.md +++ b/docs/api-status.md @@ -61,3 +61,27 @@ No Preview/Deprecated APIs found. All APIs are considered stable. No Preview/Deprecated APIs found. All APIs are considered stable. +## Package: rados/striper + +### Preview APIs + +Name | Added in Version | Expected Stable Version | +---- | ---------------- | ----------------------- | +Striper.Read | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.Stat | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +New | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +NewWithLayout | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.Destroy | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.SetObjectLayoutStripeUnit | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.SetObjectLayoutStripeCount | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.SetObjectLayoutObjectSize | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.Write | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.WriteFull | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.Append | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.Remove | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.Truncate | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.GetXattr | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.SetXattr | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.RmXattr | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +Striper.ListXattrs | $NEXT_RELEASE | $NEXT_RELEASE_STABLE | +