Object naming considerations

Content Platform Tenant Management Help

File Size
4269 KB
Part Number

When naming objects, directories, and symbolic links, keep these considerations in mind:

  • The name of each item must conform to POSIX naming conventions. In particular:
    • Object names are case sensitive.
    • Object names can include nonprinting characters, such as spaces and line breaks.
    • All characters are valid except the NULL character (ASCII 0 (zero)) and the forward slash (ASCII 47 (/)), which is the separator character in directory paths.
    • Object names cannot consist of a single period (.) or a single forward slash (/).
    • The client operating system, in conjunction with HCP, ensures that object specifications are converted, as needed, to conform to POSIX requirements (for example, when using CIFS, backslashes (\) are converted to forward slashes (/)).
  • .directory-metadata is a reserved name.
  • The maximum length for the combined directory path and name of an object, symbolic link, or metafile, starting below rest, data, or metadata, including separators, is 4,095 bytes.
  • For CIFS and NFS, the maximum length of an individual item name is 255 bytes. This applies not only to naming new objects but also to retrieving existing objects. Therefore, an object stored through HTTP or WebDAV with a longer name may not be accessible through CIFS or NFS.
  • Some character-set encoding schemes, such as UTF-8, can require more than one byte to encode a single character. As a result, such encoding can invisibly increase the length of a full object specification (directory path and object name) causing it to exceed the HCP limit of 4,095 bytes.
    Note: In some cases, an extremely long object name may prevent a CIFS or NFS client from reading the entire directory that contains the object. When this happens, attempts to list the contents of the directory result in an error.
  • When searching namespaces, HCP rely on UTF-8 encoding conventions to find objects by name. If the name of an object is not UTF-8 encoded, searches for the object by name may return unexpected results.
  • When the metadata query engine or HCP search facility indexes an object with a name that includes certain characters that cannot be UTF-8 encoded, it percent-encodes those characters. Searches for such objects by name must explicitly include the percent-encoded characters in the name.
  • Names for email objects stored through SMTP are system-generated.