> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Method name: getDataCollection(dataCollectionId: string, options: GetDataCollectionOptions) # Method package: wixDataV2 # Method menu location: wixDataV2 --> collections --> getDataCollection # Method Link: https://dev.wix.com/docs/velo/apis/wix-data-v2/collections/get-data-collection.md # Method Description: Retrieves a data collection by ID. # Method Code Examples: *** Note: do not assume any prop names or enum values other than the ones in the example. ## Get a collection ```javascript import { collections } from "wix-data.v2"; /* Retrieving a collection with an _id of "myMusicCollection" * * Sample dataCollectionId value: * const dataCollectionId = "myMusicCollection" */ export async function myGetDataCollectionFunction(dataCollectionId) { try { const retrievedCollection = await collections.getDataCollection(dataCollectionId) return retrievedCollection; } catch (error) { console.error(error); // Handle the error } } /* Returns a promise that resolves to the retrieved collection: * { * "_id": "myMusicCollection", * "collectionType": "NATIVE", * "displayName": "My Music Collection", * "displayField": "myMusicCollection", * "capabilities": { * "dataOperations": [ * "IS_REFERENCED", * "INSERT", * "SAVE", * "BULK_INSERT", * "BULK_UPDATE", * "UPDATE", * "TRUNCATE", * "REMOVE", * "REMOVE_REFERENCE", * "COUNT", * "FIND", * "REPLACE_REFERENCES", * "BULK_REMOVE", * "INSERT_REFERENCE", * "GET", * "BULK_SAVE", * "QUERY_REFERENCED", * "DISTINCT", * "AGGREGATE" * ], * "collectionOperations": [ * "UPDATE", * "REMOVE" * ], * "indexLimits": { * "regular": 3, * "unique": 1, * "total": 4 * } * }, * "fields": * [ * { * "key": "artist", * "displayName": "Artist Name", * "type": "TEXT", * "systemField": false, * "capabilities": { * "sortable": true, * "queryOperators": [ * "EQ", * "LT", * "GT", * "NE", * "LTE", * "GTE", * "STARTS_WITH", * "ENDS_WITH", * "CONTAINS", * "HAS_SOME", * "HAS_ALL", * "EXISTS", * "URLIZED" * ] * }, * "encrypted": false, * "description": "The artist's name" * }, * { * "key": "_id", * "displayName": "ID", * "type": "TEXT", * "systemField": true, * "capabilities": { * "sortable": true, * "queryOperators": [ * "EQ", * "LT", * "GT", * "NE", * "LTE", * "GTE", * "STARTS_WITH", * "ENDS_WITH", * "CONTAINS", * "HAS_SOME", * "HAS_ALL", * "EXISTS", * "URLIZED" * ] * }, * "encrypted": false * }, * { * "key": "_createdDate", * "displayName": "Created Date", * "type": "DATETIME", * "systemField": true, * "capabilities": { * "sortable": true, * "queryOperators": [ * "EQ", * "LT", * "GT", * "NE", * "LTE", * "GTE", * "STARTS_WITH", * "ENDS_WITH", * "CONTAINS", * "HAS_SOME", * "HAS_ALL", * "EXISTS", * "URLIZED" * ] * }, * "encrypted": false * }, * { * "key": "_updatedDate", * "displayName": "Updated Date", * "type": "DATETIME", * "systemField": true, * "capabilities": { * "sortable": true, * "queryOperators": [ * "EQ", * "LT", * "GT", * "NE", * "LTE", * "GTE", * "STARTS_WITH", * "ENDS_WITH", * "CONTAINS", * "HAS_SOME", * "HAS_ALL", * "EXISTS", * "URLIZED" * ] * }, * "encrypted": false * }, * { * "key": "_owner", * "displayName": "Owner", * "type": "TEXT", * "systemField": true, * "capabilities": { * "sortable": true, * "queryOperators": [ * "EQ", * "LT", * "GT", * "NE", * "LTE", * "GTE", * "STARTS_WITH", * "ENDS_WITH", * "CONTAINS", * "HAS_SOME", * "HAS_ALL", * "EXISTS", * "URLIZED" * ] * }, * "encrypted": false * } * ], * "permissions": { * "insert": "SITE_MEMBER_AUTHOR", * "update": "SITE_MEMBER_AUTHOR", * "remove": "SITE_MEMBER_AUTHOR", * "read": "ANYONE" * }, * "revision": "1", * "plugins": [], * "pagingModes": [ * "OFFSET" * ], * "_createdDate": "2023-07-19T12:40:02.372Z", * "_updatedDate": "2023-07-19T12:40:02.372Z" * }; */ ``` ## Get a collection (export from backend code) ```javascript import { Permissions, webMethod } from "wix-web-module"; import { collections } from "wix-data.v2"; /* Retrieving a collection with an _id of "myMusicCollection" * * Sample dataCollectionId value: * const dataCollectionId = "myMusicCollection" */ export const myGetDataCollectionFunction = webMethod(Permissions.Anyone, async (dataCollectionId) => { try { const retrievedCollection = await collections.getDataCollection(dataCollectionId); return retrievedCollection; } catch (error) { console.error(error); // Handle the error } }); /* Returns a promise that resolves to the retrieved collection: * { * "_id": "myMusicCollection", * "collectionType": "NATIVE", * "displayName": "My Music Collection", * "displayField": "myMusicCollection", * "capabilities": { * "dataOperations": [ * "IS_REFERENCED", * "INSERT", * "SAVE", * "BULK_INSERT", * "BULK_UPDATE", * "UPDATE", * "TRUNCATE", * "REMOVE", * "REMOVE_REFERENCE", * "COUNT", * "FIND", * "REPLACE_REFERENCES", * "BULK_REMOVE", * "INSERT_REFERENCE", * "GET", * "BULK_SAVE", * "QUERY_REFERENCED", * "DISTINCT", * "AGGREGATE" * ], * "collectionOperations": [ * "UPDATE", * "REMOVE" * ], * "indexLimits": { * "regular": 3, * "unique": 1, * "total": 4 * } * }, * "fields": * [ * { * "key": "artist", * "displayName": "Artist Name", * "type": "TEXT", * "systemField": false, * "capabilities": { * "sortable": true, * "queryOperators": [ * "EQ", * "LT", * "GT", * "NE", * "LTE", * "GTE", * "STARTS_WITH", * "ENDS_WITH", * "CONTAINS", * "HAS_SOME", * "HAS_ALL", * "EXISTS", * "URLIZED" * ] * }, * "encrypted": false, * "description": "The artist's name" * }, * { * "key": "_id", * "displayName": "ID", * "type": "TEXT", * "systemField": true, * "capabilities": { * "sortable": true, * "queryOperators": [ * "EQ", * "LT", * "GT", * "NE", * "LTE", * "GTE", * "STARTS_WITH", * "ENDS_WITH", * "CONTAINS", * "HAS_SOME", * "HAS_ALL", * "EXISTS", * "URLIZED" * ] * }, * "encrypted": false * }, * { * "key": "_createdDate", * "displayName": "Created Date", * "type": "DATETIME", * "systemField": true, * "capabilities": { * "sortable": true, * "queryOperators": [ * "EQ", * "LT", * "GT", * "NE", * "LTE", * "GTE", * "STARTS_WITH", * "ENDS_WITH", * "CONTAINS", * "HAS_SOME", * "HAS_ALL", * "EXISTS", * "URLIZED" * ] * }, * "encrypted": false * }, * { * "key": "_updatedDate", * "displayName": "Updated Date", * "type": "DATETIME", * "systemField": true, * "capabilities": { * "sortable": true, * "queryOperators": [ * "EQ", * "LT", * "GT", * "NE", * "LTE", * "GTE", * "STARTS_WITH", * "ENDS_WITH", * "CONTAINS", * "HAS_SOME", * "HAS_ALL", * "EXISTS", * "URLIZED" * ] * }, * "encrypted": false * }, * { * "key": "_owner", * "displayName": "Owner", * "type": "TEXT", * "systemField": true, * "capabilities": { * "sortable": true, * "queryOperators": [ * "EQ", * "LT", * "GT", * "NE", * "LTE", * "GTE", * "STARTS_WITH", * "ENDS_WITH", * "CONTAINS", * "HAS_SOME", * "HAS_ALL", * "EXISTS", * "URLIZED" * ] * }, * "encrypted": false * } * ], * "permissions": { * "insert": "SITE_MEMBER_AUTHOR", * "update": "SITE_MEMBER_AUTHOR", * "remove": "SITE_MEMBER_AUTHOR", * "read": "ANYONE" * }, * "revision": "1", * "plugins": [], * "pagingModes": [ * "OFFSET" * ], * "_createdDate": "2023-07-19T12:40:02.372Z", * "_updatedDate": "2023-07-19T12:40:02.372Z" * }; */ ``` ---