datajoint-python icon indicating copy to clipboard operation
datajoint-python copied to clipboard

Published 20 hours ago • verified publisher icon datajoint

Hidden Attributes

Open dimitri-yatsenko opened this issue 2 years ago • 3 comments

Feature Request

Problem

Implement support for hidden attributes. These attributes will be prefixed with an underscore and not displayed. DataJoint may store metadata like creation timestamps, usernames, etc in the hidden attributes. U

Requirements

  • DataJoint will support hidden attributes in tables. Any attribute whose name begins with a _ will not be displayed and will not appear as part of the reverse-engineered table definition.
  • DataJoint declaration will allow declaring such attributes for internal purposes but the user API will be prohibited (by default) from using them.
  • Hidden attributes will not participate in joins.
  • Hidden attributes will not be included in results of user queries

Justification

  • The singleton tables in #113 will be supported by a hidden attribute
  • Automated metadata such timestamps, data versions, checksums, and usernames will use hidden attributes

dimitri-yatsenko avatar Oct 07 '22 20:10 dimitri-yatsenko

Hi @dimitri-yatsenko - What protections did you have in mind when you envisioned that the user API would prohibit using hidden attributes? How would a super user circumvent this protection?

CBroz1 avatar Feb 07 '23 19:02 CBroz1

@A-Baji - Do you have a sense of your timeline for #1091? I think it could be really useful for something I'm working on

CBroz1 avatar Oct 27 '23 16:10 CBroz1

@A-Baji - Do you have a sense of your timeline for #1091? I think it could be really useful for something I'm working on

Hey Chris! I think that PR has just been waiting for a review from @dimitri-yatsenko. If any changes are requested feel free to PR to me with the fixes as I'm not currently working on any of the open source projects.

A-Baji avatar Oct 27 '23 16:10 A-Baji