analytics/schemas/moser/5.0/physical.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!-- edited with XMLSpy v2017 sp2 (x64) (http://www.altova.com) by 5004805085/DONNA HENNIGAR (IBM SWG CANADA) -->
<!--
 Licensed Materials - Property of IBM

 IBM Cognos Products: moser

 (C) Copyright IBM Corp. 2015, 2017

 US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified" version="4.0">
	<xsd:include schemaLocation="metadata.xsd"/>
	<xsd:element name="dataSource">
		<xsd:annotation>
			<xsd:documentation>A container of table objects.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="physicalObjectType">
					<xsd:sequence>
						<xsd:element name="cmDataSource" type="xsd:string" minOccurs="1">
							<xsd:annotation>
								<xsd:documentation>Specifies the Content Manager data source name.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="connectionString" type="xsd:string" minOccurs="0">
							<xsd:annotation>
								<xsd:documentation>Specifies the connection string to the physical data source.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="user" type="xsd:string" minOccurs="0"/>
						<xsd:element name="password" type="xsd:string" minOccurs="0"/>
						<xsd:element name="databaseType" type="xsd:string" minOccurs="1">
							<xsd:annotation>
								<xsd:documentation>Specifies the type of the database, e.g OR, OL, D2, etc..</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="catalog" type="xsd:string" minOccurs="0"/>
						<xsd:element name="schema" type="xsd:string" minOccurs="0"/>
						<xsd:element ref="table" minOccurs="0" maxOccurs="unbounded"/>
						<xsd:element ref="storedProcedure" minOccurs="0" maxOccurs="unbounded"/>
						<xsd:element ref="function" minOccurs="0" maxOccurs="unbounded"/>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:element name="table">
		<xsd:annotation>
			<xsd:documentation>Represents a view or table.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="physicalObjectType">
					<xsd:sequence>
						<xsd:element name="tableType" type="tableType" minOccurs="0">
							<xsd:annotation>
								<xsd:documentation>the table type. see JDBC getTableTypes().</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="numberOfRows" type="xsd:long" minOccurs="0"/>
						<xsd:element ref="column" minOccurs="0" maxOccurs="unbounded">
							<xsd:annotation>
								<xsd:documentation>Deprecated as of version 3.1, all columns should be under tableItems.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element ref="index" minOccurs="0" maxOccurs="unbounded"/>
						<xsd:element ref="primaryKey" minOccurs="0" maxOccurs="unbounded"/>
						<xsd:element ref="foreignKey" minOccurs="0" maxOccurs="unbounded"/>
						<xsd:element name="tableItem" type="tableItemType" minOccurs="0" maxOccurs="unbounded">
							<xsd:annotation>
								<xsd:documentation>A tableItem can be a child of another tableItem. This allows support for structs and multisets.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:element name="storedProcedure">
		<xsd:annotation>
			<xsd:documentation>Represents a stored procedure.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="physicalObjectType">
					<xsd:sequence>
						<xsd:element name="numberOfRows" type="xsd:long" minOccurs="0"/>
						<xsd:element name="procParameter" type="procParameterType" minOccurs="0" maxOccurs="unbounded">
							<xsd:annotation>
								<xsd:documentation>Stored procedure parameter definition.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element ref="column" minOccurs="0" maxOccurs="unbounded"/>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:element name="function">
		<xsd:annotation>
			<xsd:documentation>A function that is stored in a database instance. For MoserJS it is renamed to the javascript class DbFunction, because function is a reserved javascript keyword.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="physicalObjectType">
					<xsd:sequence>
						<xsd:element name="resultDatatype" type="xsd:string" minOccurs="0">
							<xsd:annotation>
								<xsd:documentation>Contains the result datatype from the execution of a function.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="procParameter" type="procParameterType" minOccurs="0" maxOccurs="unbounded">
							<xsd:annotation>
								<xsd:documentation>function parameter definition.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:complexType name="procParameterType">
		<xsd:annotation>
			<xsd:documentation>The properties of a function or procedure call parameter.</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="parameterName" type="xsd:string">
				<xsd:annotation>
					<xsd:documentation>Specifies a name for a parameter passed to, or resulting from, execution of a procedure.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="mode" type="proParameterMode">
				<xsd:annotation>
					<xsd:documentation>Specifies whether the parameter passed to a procedure is an input parameter, an output parameter, or an input parameter that is changed during execution.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="datatype" type="xsd:string" minOccurs="1"/>
		</xsd:sequence>
	</xsd:complexType>
	<xsd:element name="column">
		<xsd:annotation>
			<xsd:documentation>The column.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="physicalObjectType">
					<xsd:sequence>
						<xsd:element name="datatype" type="xsd:string" minOccurs="0">
							<xsd:annotation>
								<xsd:documentation>
									<para>Full data type. e,g, VARCHAR(20). The name is defined in com.ibm.cognos.jdbc.adaptor.AdaptorJDBCTypes</para>
									<para>ARRAY</para>
									<para>BIGINT</para>
									<para>BINARY</para>
									<para>BIT</para>
									<para>BLOB</para>
									<para>BOOLEAN</para>
									<para>CHAR   precision is used as length: CHAR(N)</para>
									<para>CLOB</para>
									<para>DATALINK</para>
									<para>DATE</para>
									<para>DECIMAL precision and scale are used: DECIMAL(N, M)</para>
									<para>DISTINCT user defined type</para>
									<para>DOUBLE</para>
									<para>FLOAT</para>
									<para>INTEGER</para>
									<para>JAVA_OBJECT</para>
									<para>LONGNVARCHAR see CHAR</para>
									<para>LONGVARBINARY see CHAR</para>
									<para>LONGVARCHAR see CHAR</para>
									<para>NCHAR  see CHAR</para>
									<para>NCLOB</para>
									<para>NULL</para>
									<para>NUMERIC see DECIMAL</para>
									<para>NVARCHAR  see CHAR</para>
									<para>OTHER</para>
									<para>REAL</para>
									<para>REF</para>
									<para>ROWID</para>
									<para>SMALLINT</para>
									<para>SQLXML</para>
									<para>STRUCT</para>
									<para>TIME</para>
									<para>TIMESTAMP</para>
									<para>TINYINT</para>
									<para>VARBINARY see CHAR</para>
									<para>VARCHAR see CHAR</para>
									<para>TIMESTAMP_TZ</para>
									<para>TIME_TZ</para>
									<para>INTERVAL_YEAR</para>
									<para>INTERVAL_YEAR_TO_MONTH</para>
									<para>INTERVAL_MONTH</para>
									<para>INTERVAL_DAY</para>
									<para>INTERVAL_DAY_TO_HOUR</para>
									<para>INTERVAL_DAY_TO_MINUTE</para>
									<para>INTERVAL_DAY_TO_SECOND</para>
									<para>INTERVAL_HOUR</para>
									<para>INTERVAL_HOUR_TO_MINUTE</para>
									<para>INTERVAL_HOUR_TO_SECOND</para>
									<para>INTERVAL_MINUTE</para>
									<para>INTERVAL_MINUTE_TO_SECOND</para>
									<para>INTERVAL_SECOND</para>
									<para>PERIOD_DATE</para>
									<para>PERIOD_TIME</para>
									<para>PERIOD_TIME_TZ</para>
									<para>PERIOD_TIMESTAMP</para>
									<para>PERIOD_TIMESTAMP_TZ</para>
									<para>JSON</para>
									<para>ROWSET</para>
								</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="nullable" type="xsd:boolean" default="false" minOccurs="0">
							<xsd:annotation>
								<xsd:documentation>If true, this object can contain NULL values.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="vendorType" type="xsd:string" minOccurs="0">
							<xsd:annotation>
								<xsd:documentation>The vendor data type name.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:element name="index">
		<xsd:annotation>
			<xsd:documentation>The index.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="physicalObjectType">
					<xsd:sequence>
						<xsd:element name="isUnique" type="xsd:boolean" minOccurs="0"/>
						<xsd:element name="indexedColumn" minOccurs="0" maxOccurs="unbounded">
							<xsd:annotation>
								<xsd:documentation>The column used in the index.</xsd:documentation>
							</xsd:annotation>
							<xsd:complexType>
								<xsd:sequence>
									<xsd:element name="columnName" type="xsd:string" minOccurs="0"/>
									<xsd:element name="sortOrder" type="xsd:string" minOccurs="0"/>
								</xsd:sequence>
							</xsd:complexType>
						</xsd:element>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:element name="primaryKey">
		<xsd:annotation>
			<xsd:documentation>The unique key.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="physicalObjectType">
					<xsd:sequence>
						<xsd:element name="keyedColumn" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:element name="foreignKey">
		<xsd:annotation>
			<xsd:documentation>The foreign key.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="physicalObjectType">
					<xsd:sequence>
						<xsd:element name="fkColumn" minOccurs="0" maxOccurs="unbounded">
							<xsd:annotation>
								<xsd:documentation>The column used in the key.</xsd:documentation>
							</xsd:annotation>
							<xsd:complexType>
								<xsd:sequence>
									<xsd:element name="columnName" type="xsd:string" minOccurs="0"/>
									<xsd:element name="pkCatalog" type="xsd:string" minOccurs="0"/>
									<xsd:element name="pkSchema" type="xsd:string" minOccurs="0"/>
									<xsd:element name="pkTable" type="xsd:string" minOccurs="0"/>
									<xsd:element name="pkColumn" type="xsd:string" minOccurs="0"/>
								</xsd:sequence>
							</xsd:complexType>
						</xsd:element>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:element name="struct">
		<xsd:annotation>
			<xsd:documentation>A struct is a structured record containing specific columns contained as one row.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="physicalObjectType">
					<xsd:sequence>
						<xsd:element name="tableItem" type="tableItemType" minOccurs="0" maxOccurs="unbounded"/>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:element name="multiset">
		<xsd:annotation>
			<xsd:documentation>A multiset is a struct containing multiple rows.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="physicalObjectType">
					<xsd:sequence>
						<xsd:element name="tableItem" type="tableItemType" minOccurs="0" maxOccurs="unbounded"/>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:complexType name="tableItemType">
		<xsd:choice>
			<xsd:element ref="column"/>
			<xsd:element ref="struct"/>
			<xsd:element ref="multiset"/>
		</xsd:choice>
	</xsd:complexType>
	<xsd:simpleType name="tableType">
		<xsd:restriction base="xsd:NMTOKEN">
			<xsd:enumeration value="TABLE">
				<xsd:annotation>
					<xsd:documentation>Specifies the table as a table.</xsd:documentation>
				</xsd:annotation>
			</xsd:enumeration>
			<xsd:enumeration value="VIEW">
				<xsd:annotation>
					<xsd:documentation>Specifies the table as a view.</xsd:documentation>
				</xsd:annotation>
			</xsd:enumeration>
			<xsd:enumeration value="SYSTEM_TABLE"/>
			<xsd:enumeration value="GLOBAL_TEMPORARY"/>
			<xsd:enumeration value="LOCAL_TEMPORARY"/>
			<xsd:enumeration value="ALIAS"/>
			<xsd:enumeration value="SYNONYM"/>
		</xsd:restriction>
	</xsd:simpleType>
	<xsd:simpleType name="proParameterMode">
		<xsd:restriction base="xsd:NMTOKEN">
			<xsd:enumeration value="in">
				<xsd:annotation>
					<xsd:documentation>Specifies an input parameter.</xsd:documentation>
				</xsd:annotation>
			</xsd:enumeration>
			<xsd:enumeration value="out">
				<xsd:annotation>
					<xsd:documentation>Specifies an output parameter.</xsd:documentation>
				</xsd:annotation>
			</xsd:enumeration>
			<xsd:enumeration value="inout">
				<xsd:annotation>
					<xsd:documentation>Specifies a parameter that is overwritten during execution.</xsd:documentation>
				</xsd:annotation>
			</xsd:enumeration>
		</xsd:restriction>
	</xsd:simpleType>
</xsd:schema>