Introspection APIs sample input - IntrospectResourcesTask and IntrospectResourcesResult
Article ID: KB0082811
Updated On:
| Products | Versions |
|---|---|
| TIBCO Data Virtualization | All Versions |
Description
IntrospectResourcesTask:
Introspection is the process of analyzing native resources in a data source and creating resources within the TDV that represent them. The introspection plan provides details on what exactly should be introspected. This includes resources to be added, updated, or removed; whether to update all previously introspected resources; introspection attributes for individual resources; and other options.
The introspection task is run within an independent background transaction on the server. It is not necessary to call
introspectResourcesTask, within an explicit transaction in order to call introspectResourceResult or cancelServerTask. This background transaction survives across server restarts until it is completed.
Sample Input XML for IntrospectResourcesTask API -
<resource:introspectResourcesTask xmlns:resource="http://www.compositesw.com/services/system/admin/resource" xmlns:common="http://www.compositesw.com/services/system/util/common">
<resource:path>/shared/examples/ds_orders/</resource:path>
<resource:plan>
<resource:updateAllIntrospectedResources>true</resource:updateAllIntrospectedResources>
<resource:failFast>false</resource:failFast>
<resource:commitOnFailure>false</resource:commitOnFailure>
<resource:autoRollback>false</resource:autoRollback>
<resource:scanForNewResourcesToAutoAdd>false</resource:scanForNewResourcesToAutoAdd>
<resource:entries>
<resource:entry>
<resource:resourceId>
<resource:path>tutorial</resource:path>
<resource:type>CONTAINER</resource:type>
<resource:subtype>SCHEMA_CONTAINER</resource:subtype>
</resource:resourceId>
<resource:action>ADD_OR_UPDATE</resource:action>
</resource:entry>
<resource:entry>
<resource:resourceId>
<resource:path>/customers</resource:path>
<resource:type>TABLE</resource:type>
<resource:subtype>DATABASE_TABLE</resource:subtype>
</resource:resourceId>
<resource:action>ADD_OR_UPDATE</resource:action>
</resource:entry>
</resource:entries>
</resource:plan>
<resource:runInBackgroundTransaction>false</resource:runInBackgroundTransaction>
</resource:introspectResourcesTask>
IntrospectResourcesResult:
This API is used to get the result for resources those are introspected by API introspectResourcesTask. Results are in the form of introspection change entries, which contain the path, type, and subtype of the resource that
was introspected, the introspection action that occurred, and a message, if available, regarding introspection of that
resource. Subsequent calls to this operation incrementally return the full set of results. If the block element is set and true, this operation blocks until the task is complete. Otherwise, this operation does not block. The page size controls the maximum number of change entries that are returned from this call.
<resource:introspectResourcesResult xmlns:resource="http://www.compositesw.com/services/system/admin/resource" xmlns:common="http://www.compositesw.com/services/system/util/common">
<common:taskId>11001</common:taskId>
<common:block>false</common:block>
<common:page>
<common:size>5</common:size>
<common:start>0</common:start>
</common:page>
<resource:detail>FULL</resource:detail>
</resource:introspectResourcesResult>
Introspection is the process of analyzing native resources in a data source and creating resources within the TDV that represent them. The introspection plan provides details on what exactly should be introspected. This includes resources to be added, updated, or removed; whether to update all previously introspected resources; introspection attributes for individual resources; and other options.
The introspection task is run within an independent background transaction on the server. It is not necessary to call
introspectResourcesTask, within an explicit transaction in order to call introspectResourceResult or cancelServerTask. This background transaction survives across server restarts until it is completed.
Sample Input XML for IntrospectResourcesTask API -
<resource:introspectResourcesTask xmlns:resource="http://www.compositesw.com/services/system/admin/resource" xmlns:common="http://www.compositesw.com/services/system/util/common">
<resource:path>/shared/examples/ds_orders/</resource:path>
<resource:plan>
<resource:updateAllIntrospectedResources>true</resource:updateAllIntrospectedResources>
<resource:failFast>false</resource:failFast>
<resource:commitOnFailure>false</resource:commitOnFailure>
<resource:autoRollback>false</resource:autoRollback>
<resource:scanForNewResourcesToAutoAdd>false</resource:scanForNewResourcesToAutoAdd>
<resource:entries>
<resource:entry>
<resource:resourceId>
<resource:path>tutorial</resource:path>
<resource:type>CONTAINER</resource:type>
<resource:subtype>SCHEMA_CONTAINER</resource:subtype>
</resource:resourceId>
<resource:action>ADD_OR_UPDATE</resource:action>
</resource:entry>
<resource:entry>
<resource:resourceId>
<resource:path>/customers</resource:path>
<resource:type>TABLE</resource:type>
<resource:subtype>DATABASE_TABLE</resource:subtype>
</resource:resourceId>
<resource:action>ADD_OR_UPDATE</resource:action>
</resource:entry>
</resource:entries>
</resource:plan>
<resource:runInBackgroundTransaction>false</resource:runInBackgroundTransaction>
</resource:introspectResourcesTask>
IntrospectResourcesResult:
This API is used to get the result for resources those are introspected by API introspectResourcesTask. Results are in the form of introspection change entries, which contain the path, type, and subtype of the resource that
was introspected, the introspection action that occurred, and a message, if available, regarding introspection of that
resource. Subsequent calls to this operation incrementally return the full set of results. If the block element is set and true, this operation blocks until the task is complete. Otherwise, this operation does not block. The page size controls the maximum number of change entries that are returned from this call.
- After successful execution of introspectResourcesTask, you will recieve the task id for introspection task as an output. Copy the taskId ( for example : 11001) and replace the taskId in input_introspectResourcesResult xml.
- Execute the API in studio and using the input_introspectResourcesResult xml
- You should see the results for re-instrospection associated with given task id.
<resource:introspectResourcesResult xmlns:resource="http://www.compositesw.com/services/system/admin/resource" xmlns:common="http://www.compositesw.com/services/system/util/common">
<common:taskId>11001</common:taskId>
<common:block>false</common:block>
<common:page>
<common:size>5</common:size>
<common:start>0</common:start>
</common:page>
<resource:detail>FULL</resource:detail>
</resource:introspectResourcesResult>
Issue/Introduction
Introspection APIs sample input - IntrospectResourcesTask and IntrospectResourcesResult
Feedback
Yes
No
Powered by
