ESS DataProfiling API to get CTID (the content ID). Contains the methods
- getEGContentTypes to retrieve the content-types of EntitySets in the Entity Grid
- getContentTypesOnDemand to perform on-demand content-type analysis of any catalog object (table, view, column view)
- getContentTypeCode to convert a DataProfilingType to a standardized code
- Version:
- 2.0.0
Classes
Members
(static) RuntimeObjectType :string
The Runtime Object Types of runtime objects that can have their attributes/columns content-types identified.
Type:
- string
Properties:
| Name | Type | Description |
|---|---|---|
SQL_TABLE |
string | Database Table |
SQL_VIEW |
string | SQL View. |
COLUMN_VIEW |
string | Column View. |
Methods
(static) getContentTypeCode(dataProfilingType) → {string}
Returns the content type code for the given data profiling content type. If the input content type is not recognized, this method returns null.
Parameters:
| Name | Type | Description |
|---|---|---|
dataProfilingType |
sap.hana.im.ess.services.xs.ctid.DataProfilingType | The name of the content type returned by data profiling. |
Returns:
the content type code (see sap.hana.im.ess.services.xs.ctid.DataProfilingType)
- Type
- string
(static) getContentTypesOnDemand(runtime_schema_name, runtime_object_name, attributesopt) → {Array.<sap.hana.im.ess.services.xs.ctid.AttributeContentType>}
Identifies content-types of attributes identified by their name, schema name and the name of runtime object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
runtime_schema_name |
string | The name of the catalog schema hosting the runtime object to profile. Should not be double quoted. |
|
runtime_object_name |
string | The name of the runtime object to profile. Should not be double quoted. |
|
attributes |
Array.<string> |
<optional> |
The names of the attributes to profile. Names should not be double quoted. If not specified, all attributes will be profiled. |
Returns:
The content types information or an empty array if no content-type could be identified.
(static) getEGContentTypes(runtimeSchemaName, runtimeObjectName) → {Array.<sap.hana.im.ess.services.xs.ctid.AttributeContentType>}
Returns the content types information for a runtime object identified by its schema name and object name. When no content types information is found, returns an empty array.
Parameters:
| Name | Type | Description |
|---|---|---|
runtimeSchemaName |
string | Name of the database schema, should not be double quoted |
runtimeObjectName |
string | Name of the runtime object, should not be double quoted |
Returns:
the content types information
Type Definitions
DataProfilingType
The DataProfilingType is a content type that describes the values of an attribute in an EntitySet, based on profiling of its values and of its metadata. The DataProfilingType can take one of the following values. Each of them has an associated Code that can be retrieved using the sap.hana.im.ess.services.xs.ctid.getContentTypeCode API.
| DataProfilingType | Code |
|---|---|
| NUMERIC | Numeric |
| ADDRESS | AddressLine |
| ADDRESS_SINGLE_LINE | FullAddress |
| ADDRESS_BUILDING_NAME | BuildingName |
| ADDRESS_PRIMARY_NUMBER | StreetName |
| ADDRESS_PRIMARY_NAME | StreetNumber |
| ADDRESS_SECONDARY_ADDRESS | SecondaryAddress |
| ADDRESS_LASTLINE | CityRegionPostCode |
| COUNTRY | Country |
| LOCALITY | City |
| POSTCODE | PostCode |
| REGION | Region |
| FIRM | Firm |
| NAME | Person |
| FAMILY_NAME1 | LastName |
| GIVEN_NAME1 | FirstName |
| POSTNAME_HONORARY | HonoraryPostname |
| POSTNAME_MATURITY | MaturityPostname |
| PRENAME | Prename |
| TITLE | Title |
| DATE | Date |
| PHONE | Phone |
| SSN | SSN |
| BOOLEAN_TYPE | BooleanType |
| STRONG_UNKNOWN | StrongUnknown |
| LOOKUP_ID | LookupId |
| TIME_ZONE | TimeZone |
| CURRENCY | CurrencyValue |
| CURRENCY_CODE | CurrencyCode |
| URL | URL |
| GEO_LOCATION | Coordinates |
| LONGITUDE | CoordinatesLong |
| LATITUDE | CoordinatesLat |
Type:
- string