new Schema({...}) سے بیان کیے گئے JavaScript Mongoose schema سے مثالی document JSON بنائیں۔ چونکہ schema definition آبجیکٹ خود parse ہوتا ہے، { type: String, enum: [...] } یا { type: Map, of: Number } جیسے options اور دوسرے schema variables کے حوالوں کو بھی فالو کیا جاتا ہے۔
یہ Express + Mongoose API کے پیچھے collections کی documentation بناتے وقت، یا فرنٹ اینڈ کو یہ سمجھاتے وقت مدد دیتا ہے کہ document کیسا دکھتا ہے۔ Mongoose کے مخصوص قواعد بھی لاگو رہتے ہیں، جیسے array subdocuments کو _id ملتا ہے جبکہ nested paths کو نہیں۔
Mongoose (JS) باکس میں پیسٹ کریں۔ اگر sub-schemas الگ variables میں ہوں تو ان کی definitions بھی اسی ان پٹ میں شامل کریں۔const variantSchema = new Schema({
sku: String,
price: Schema.Types.Decimal128,
stock: { type: Number, default: 0 },
});
const productSchema = new Schema(
{
title: { type: String, required: true },
variants: [variantSchema],
dimensions: { width: Number, height: Number },
labels: { type: Map, of: String },
},
{ timestamps: { createdAt: "created_at", updatedAt: false } }
);{
"_id": "507f1f77bcf86cd799439011",
"title": "",
"variants": [
{
"_id": "507f1f77bcf86cd799439011",
"sku": "",
"price": {
"$numberDecimal": "0"
},
"stock": 0
}
],
"dimensions": {
"width": 0,
"height": 0
},
"labels": {
"key": ""
},
"created_at": "1970-01-01T00:00:00.000Z",
"__v": 0
}variants: [variantSchema] subdocuments کی array ہے، اس لیے ہر item کو _id ملتا ہے، جبکہ __v صرف سب سے اوپر کی سطح پر ہوتا ہے۔ dimensions میں type نہیں، اس لیے یہ _id کے بغیر nested path ہے، اور Decimal128 اپنی toJSON() شکل $numberDecimal میں دکھائی دیتا ہے۔ timestamps option فیلڈ کا نام created_at کر دیتا ہے اور updatedAt بند کر دیتا ہے، یوں صرف ایک تاریخ والا فیلڈ رہ جاتا ہے۔
_id اور __v ملتے ہیں، اور versionKey: "rev" والا نام یا false لاگو ہوتا ہے۔[subSchema] یا [{ name: String }] جیسے array subdocuments کو _id ملتا ہے، سوائے اس کے کہ schema { _id: false } سیٹ کرے۔type کے بغیر nested objects (address: { city: String }) بغیر _id کے سادہ objects رہتے ہیں۔enum arrays اپنی پہلی value دیتی ہیں، { type: Map, of: String } سے {"key": ""} ملتا ہے، اور Schema.Types.Mixed سے null۔Schema.Types.ObjectId نمونے کی ObjectId string بنتا ہے اور Decimal128 بنتا ہے {"$numberDecimal": "0"}۔timestamps: true کے علاوہ { createdAt: "created_at", updatedAt: false } جیسی تفصیلی settings بھی پڑھی جاتی ہیں۔null سے کاٹ دیے جاتے ہیں۔جب README یا wiki ہر collection کے لیے مثالی document دکھائے، تو اسے schema فائل سے بنانے سے docs کوڈ سے دور نہیں ہٹتیں۔
فرنٹ اینڈ اکثر array items کا موازنہ کرتے ہیں یہ جانے بغیر کہ ہر ایک کا اپنا _id ہے۔ آؤٹ پٹ صاف دکھاتا ہے کہ _id کس سطح پر ظاہر ہوتا ہے۔
ref والے فیلڈز populate ہونے تک سادہ ObjectId strings ہوتے ہیں۔ populate() کے بعد response کیسے بدلتا ہے، یہ بیان کرتے وقت آؤٹ پٹ کو بنیاد کے طور پر استعمال کریں۔
default ("active"، 0، true) نمونہ value کے طور پر استعمال ہوتا ہے۔ Date.now جیسے function defaults نہیں چلائے جاتے، اس لیے ان فیلڈز کو type کا placeholder ملتا ہے۔ref والے فیلڈز populate شدہ objects کے بجائے ObjectId strings رہتے ہیں۔new Schema({...}, { _id: false }) اپنی جگہ پر تبدیل ہوتا ہے اور اپنے options پر عمل کرتا ہے؛ یہ الگ root entry کے طور پر نہیں آتا۔toJSON transforms، getters اور select: false لاگو نہیں ہوتے۔Mongoose کا Decimal128، toJSON() کے ذریعے {"$numberDecimal": "12.50"} کی صورت میں serialize ہوتا ہے۔ اگر آپ اسے نمبر یا string کی صورت میں بھیجتے ہیں تو schema میں getter یا transform شامل کریں اور آؤٹ پٹ کو اس کے مطابق ایڈٹ کریں۔
@Schema() کلاسز اور interfaces کو Mongoose (TS) to JSON صفحے پر تبدیل کریں۔ یہ صفحہ new Schema() کو دیا گیا JavaScript آبجیکٹ parse کرتا ہے۔
mongoose.model() ہو اور schema کہیں اور ہو تو؟schema definition ان پٹ میں ہونی چاہیے۔ اس کے ساتھ new Schema(...) والا حصہ بھی پیسٹ کریں۔