Lists statistics for partitioned indexes.
Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Function idxlist( _ ByVal tblnames As String() _ ) As NetricsIdxStats() _ Implements INetricsServerInterface.idxlist |
| C# |
|---|
| public NetricsIdxStats[] idxlist( string[] tblnames ) |
| C++ |
|---|
| public: array<NetricsIdxStats>^ idxlist( array<String>^ tblnames ) sealed |
| J# |
|---|
| public NetricsIdxStats[] idxlist( string[] tblnames ) |
| JScript |
|---|
| public
function idxlist( tblnames : String[] ) : NetricsIdxStats[] |
Parameters
- tblnames
- The names of the tables for which to retrieve statistics. Pass null to recieve information for indexes of all tables.
Return Value
An array of NetricsIdxStats objects.
Implements
INetricsServerInterface.idxlistExceptions
| Exception Type | Condition |
|---|---|
| NetricsException | If the server indicates that an error has occured (Possible errors - TBLNOTFOUND, EXPECTTBLDESC, EXPECTLIST, FEATURESET, NOTBLDESC, NOSYSINIT) |
Remarks
This command can be used to retrieve information on all of the partition indexes associated with one or more tables loaded into the TIBCO Patterns Engine server. Information can be retrieved for all tables or a list of specific tables. Information for all indexes associated with the indicated tables is returned as a list of NetricsIdxStats objects. It is an error if a named table doesn't exist. If a table has no indexes an empty stats object is returned for that table.