Parimad praktikad

Disainipõhimõtted ja konventsioonid puhta, hooldatava andmemudeli loomiseks Entus.

Parameetrite nimetamine

Kasuta kirjeldavaid, väiketähelisi nimesid allkriipsudega:

• ✅ product_name, created_date, customer_email
• ❌ pn, cd, e, startDate, start-date

Ole järjepidev eri objektitüüpide vahel: kasuta name peamiste identifikaatorite jaoks, description pikema teksti jaoks, photo piltide jaoks.

Grupeeri seotud parameetrid ühise eesliitega: address_street, address_city, address_country.

Andmete modelleerimine

Disaini objektitüübid oma päringumustrite järgi. Kui kasutajad leiavad objekte sageli, sisestades täistekstiotsingusse väärtuse nagu status või kood, luba sellel parameetri definitsioonil search. Päringus parameetri väärtuse järgi filtreerimine töötab ka ilma selleta.

Kasuta viiteid seotud andmete jaoks, mis muutuvad sageli — ära dubleeri väärtusi objektide vahel, kui viide sobib.

Kasuta valemeid tuletatud andmete jaoks — kogusummad, keskmised, loendused — et tõe allikas püsiks ühes kohas. Vaata Valemid.

Kasuta objektihierarhiat organisatsioonistruktuuri modelleerimiseks. Ülem-alam seosed võimaldavad ka õiguste pärimist.

Mitme väärtusega parameetrid

Eelistatud lähenemine — kasuta mitut väärtust ühe parameetri all, ära loo nummerdatud variante:

// Hea — mitu väärtust ühe parameetri all
[
  { "type": "tag", "string": "urgent" },
  { "type": "tag", "string": "customer" }
]

// Väldi — nummerdatud eraldi parameetrid
[
  { "type": "tag1", "string": "urgent" },
  { "type": "tag2", "string": "customer" }
]

Luba parameetri definitsioonil list, et võimaldada mitu sisendit kasutajaliideses.

Juurdepääsukontroll

Anna minimaalselt vajalikke õigusi:

• _viewer ainult lugemise jaoks
• _expander kasutajatele, kes peavad lisama alam-objekte
• _editor kasutajatele, kes peavad parameetreid muutma
• Reserveeri _owner objekti administraatoritele — ainult omanikud saavad muuta õigusi ja objekti kustutada

Kasuta _inheritrights hierarhiapõhiste õiguste jaoks. Alam-objekt, millel on _inheritrights: true, saab oma ülemobjektidele seatud õigused, nii et juurdepääsu annad ühe korra ülemkonteineril. Uus alam-objekt saab _inheritrights automaatselt, kui see on ülemobjektil olemas.

Kasuta _sharing laialdase juurdepääsu jaoks — domain kõigile andmebaasi kasutajatele, public sisse logimata külastajatele. Kuvatakse ainult parameetrid, mida objektitüüp sellel tasemel jagab (vaata Objektitüübid → Nähtavus). Kasuta public ettevaatlikult.

DANGER

_sharing: public seadmine muudab objekti — ja selle avalikult jagatud parameetrid — nähtavaks kõigile internetis ilma autentimiseta. Kasuta seda ainult tahtlikult avaliku sisu jaoks.

Vaata Objektid → Juurdepääsuõigused ja Kasutajad.