Node.js
Avant d'essayer cet exemple, suivez les instructions de configuration de Node.js dans le guide de démarrage rapide de Data Catalog à l'aide des bibliothèques clientes.
Pour en savoir plus, consultez la documentation de référence de l'API Data Catalog Node.js.
Pour vous authentifier auprès de Data Catalog, configurez les Identifiants par défaut de l'application.
Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
// Import the Google Cloud client library.
const {DataCatalogClient} = require('@google-cloud/datacatalog').v1;
const datacatalog = new DataCatalogClient();
async function createCustomEntry() {
// Create a custom entry within an entry group.
/**
* TODO(developer): Uncomment the following lines before running the sample.
*/
// const projectId = 'my_project';
// const entryGroupId = 'my_entry_group';
// const entryId = 'my_entry';
// const tagTemplateId = 'my_tag_template';
// Currently, Data Catalog stores metadata in the us-central1 region.
const location = 'us-central1';
// Delete any pre-existing Entry with the same name
// that will be used to create the new Entry.
try {
const entryName = datacatalog.entryPath(
projectId,
location,
entryGroupId,
entryId
);
await datacatalog.deleteEntry({name: entryName});
console.log(`Deleted Entry: ${entryName}`);
} catch (err) {
console.log('Entry does not exist.');
}
// Delete any pre-existing Entry Group with the same name
// that will be used to construct the new EntryGroup.
try {
const entryGroupName = datacatalog.entryGroupPath(
projectId,
location,
entryGroupId
);
await datacatalog.deleteEntryGroup({name: entryGroupName});
console.log(`Deleted Entry Group: ${entryGroupName}`);
} catch (err) {
console.log('Entry Group does not exist.');
}
// Delete any pre-existing Template with the same name
// that will be used to create a new Template.
const tagTemplateName = datacatalog.tagTemplatePath(
projectId,
location,
tagTemplateId
);
let tagTemplateRequest = {
name: tagTemplateName,
force: true,
};
try {
await datacatalog.deleteTagTemplate(tagTemplateRequest);
console.log(`Deleted template: ${tagTemplateName}`);
} catch (error) {
console.log(`Cannot delete template: ${tagTemplateName}`);
}
// Construct the EntryGroup for the EntryGroup request.
const entryGroup = {
displayName: 'My awesome Entry Group',
description: 'This Entry Group represents an external system',
};
// Construct the EntryGroup request to be sent by the client.
const entryGroupRequest = {
parent: datacatalog.locationPath(projectId, location),
entryGroupId: entryGroupId,
entryGroup: entryGroup,
};
// Use the client to send the API request.
const [createdEntryGroup] =
await datacatalog.createEntryGroup(entryGroupRequest);
console.log(`Created entry group: ${createdEntryGroup.name}`);
// Construct the Entry for the Entry request.
const entry = {
userSpecifiedSystem: 'onprem_data_system',
userSpecifiedType: 'onprem_data_asset',
displayName: 'My awesome data asset',
description: 'This data asset is managed by an external system.',
linkedResource: '//my-onprem-server.com/dataAssets/my-awesome-data-asset',
schema: {
columns: [
{
column: 'first_column',
description: 'This columns consists of ....',
mode: 'NULLABLE',
type: 'STRING',
},
{
column: 'second_column',
description: 'This columns consists of ....',
mode: 'NULLABLE',
type: 'DOUBLE',
},
],
},
};
// Construct the Entry request to be sent by the client.
const entryRequest = {
parent: datacatalog.entryGroupPath(projectId, location, entryGroupId),
entryId: entryId,
entry: entry,
};
// Use the client to send the API request.
const [createdEntry] = await datacatalog.createEntry(entryRequest);
console.log(`Created entry: ${createdEntry.name}`);
// Create a Tag Template.
// For more field types, including ENUM, please refer to
// https://cloud.google.com/data-catalog/docs/quickstarts/quickstart-search-tag#data-catalog-quickstart-nodejs.
const fieldSource = {
displayName: 'Source of data asset',
type: {
primitiveType: 'STRING',
},
};
const tagTemplate = {
displayName: 'Demo Tag Template',
fields: {
source: fieldSource,
},
};
tagTemplateRequest = {
parent: datacatalog.locationPath(projectId, location),
tagTemplateId: tagTemplateId,
tagTemplate: tagTemplate,
};
// Use the client to send the API request.
const [createdTagTemplate] =
await datacatalog.createTagTemplate(tagTemplateRequest);
console.log(`Created template: ${createdTagTemplate.name}`);
// Attach a Tag to the custom Entry.
const tag = {
template: createdTagTemplate.name,
fields: {
source: {
stringValue: 'On-premises system name',
},
},
};
const tagRequest = {
parent: createdEntry.name,
tag: tag,
};
// Use the client to send the API request.
const [createdTag] = await datacatalog.createTag(tagRequest);
console.log(`Created tag: ${createdTag.name}`);
}
createCustomEntry();
