IBM Streams 4.2.1
Toolkit spl 1.3.0
SPL standard and specialized toolkits > spl 1.3.0
General Information
The IBM Streams Processing Language (SPL) standard toolkit provides a set of operators, types, and functions that are specific to IBM Streams.
- Version
- 1.3.0
- Required Product Version
- 4.2.0
Indexes
Namespaces
- spl
- The SPL standard toolkit defines several types in the composite operator spl::Sys.
- spl.XML
- Character encoding of XML: If the input is contained in an ustring value, then it is already in Unicode and internal encoding is ignored if it is present.
- Operators
- Functions
- convertToXML(X, T)
- convertToXML(X, T, int32)
- isDefaultValue(X)
- xquery(X, rstring)
- xquery(X, rstring, int32)
- xquery(X, rstring, map<rstring, rstring>)
- xquery(X, rstring, map<rstring, rstring>, int32)
- xquery(X, ustring)
- xquery(X, ustring, int32)
- xquery(X, ustring, map<ustring, ustring>)
- xquery(X, ustring, map<ustring, ustring>, int32)
- spl.adapter
- Schema checking for TCP operators using the confirmWireFormat parameter: Use the confirmWireFormat parameter on TCPSource and TCPSink operators to confirm that the transmitted data is compatible.
- spl.collection
- This namespace contains components for handling collections.
- Functions
- appendM(blob, list<uint8>)
- appendM(blob, uint8)
- appendM(list<T>, T)
- appendM(list<T>[N], T)
- at(list<T>, list<uint32>)
- at(list<T>[N], list<uint32>)
- blobSize(blob)
- clearM(T)
- clearM(blob)
- concat(list<T>, list<T>)
- concat(list<T>, list<T>[N])
- concat(list<T>[N], list<T>)
- concat(list<T>[N], list<T>[M])
- concatM(list<T>, list<T>)
- concatM(list<T>, list<T>[N])
- concatM(list<T>[N], list<T>)
- concatM(list<T>[N], list<T>[M])
- concatM(set<T>, set<T>)
- concatM(set<T>, set<T>[N])
- concatM(set<T>[N], set<T>)
- concatM(set<T>[N], set<T>[M])
- countDistinct(list<T>)
- countDistinct(list<T>[N])
- find(list<T>, T)
- find(list<T>[N], T)
- findFirst(list<T>, T)
- findFirst(list<T>, T, int32)
- findFirst(list<T>, list<T>)
- findFirst(list<T>, list<T>, int32)
- findFirst(list<T>[N], T)
- findFirst(list<T>[N], T, int32)
- findFirst(list<T>[N], list<T>[M])
- findFirst(list<T>[N], list<T>[M], int32)
- findFirstNotOf(list<T>, list<T>)
- findFirstNotOf(list<T>, list<T>, int32)
- findFirstNotOf(list<T>, list<T>[N])
- findFirstNotOf(list<T>, list<T>[N], int32)
- findFirstNotOf(list<T>[N], list<T>)
- findFirstNotOf(list<T>[N], list<T>, int32)
- findFirstNotOf(list<T>[N], list<T>[M])
- findFirstNotOf(list<T>[N], list<T>[M], int32)
- findFirstOf(list<T>, list<T>)
- findFirstOf(list<T>, list<T>, int32)
- findFirstOf(list<T>, list<T>[N])
- findFirstOf(list<T>, list<T>[N], int32)
- findFirstOf(list<T>[N], list<T>)
- findFirstOf(list<T>[N], list<T>, int32)
- findFirstOf(list<T>[N], list<T>[M])
- findFirstOf(list<T>[N], list<T>[M], int32)
- findLast(list<T>, T, int32)
- findLast(list<T>, list<T>, int32)
- findLast(list<T>[N], T, int32)
- findLast(list<T>[N], list<T>[M], int32)
- findLastNotOf(list<T>, list<T>, int32)
- findLastNotOf(list<T>, list<T>[N], int32)
- findLastNotOf(list<T>[N], list<T>, int32)
- findLastNotOf(list<T>[N], list<T>[M], int32)
- findLastOf(list<T>, list<T>, int32)
- findLastOf(list<T>, list<T>[N], int32)
- findLastOf(list<T>[N], list<T>, int32)
- findLastOf(list<T>[N], list<T>[M], int32)
- findNotOf(list<T>, list<T>)
- findNotOf(list<T>, list<T>[N])
- findNotOf(list<T>[N], list<T>)
- findNotOf(list<T>[N], list<T>[M])
- findOf(list<T>, list<T>)
- findOf(list<T>, list<T>[N])
- findOf(list<T>[N], list<T>)
- findOf(list<T>[N], list<T>[M])
- has(list<T>, T)
- has(list<T>[N], T)
- has(map<K, V>, K)
- has(map<K, V>[N], K)
- has(set<T>, T)
- has(set<T>[N], T)
- insert(list<T>, T, int32)
- insert(list<T>, list<T>, int32)
- insert(list<T>, list<T>[N], int32)
- insert(list<T>[N], T, int32)
- insert(list<T>[N], list<T>, int32)
- insert(list<T>[N], list<T>[M], int32)
- insert(map<K, V>, K, V)
- insert(map<K, V>[N], K, V)
- insert(set<V>, V)
- insert(set<V>[N], V)
- insertM(list<T>, T, int32)
- insertM(list<T>, list<T>, int32)
- insertM(list<T>, list<T>[N], int32)
- insertM(list<T>[N], T, int32)
- insertM(list<T>[N], list<T>, int32)
- insertM(list<T>[N], list<T>[M], int32)
- insertM(map<K, V>, K, V)
- insertM(map<K, V>[N], K, V)
- insertM(set<V>, V)
- insertM(set<V>[N], V)
- keys(map<K, V>)
- keys(map<K, V>[N])
- lexicographicalCompare(list<T>, list<T>)
- lexicographicalCompare(list<T>[N], list<T>[M])
- makeSequence(T, int32)
- makeSequence(T, int32)
- makeSequence(T, int32, T)
- pairwiseCompare(T, list<T>)
- pairwiseCompare(T, list<T>[N])
- pairwiseCompare(list<T>, T)
- pairwiseCompare(list<T>, list<T>)
- pairwiseCompare(list<T>[N], T)
- pairwiseCompare(list<T>[N], list<T>[N])
- pairwiseMax(list<T>, list<T>)
- pairwiseMax(list<T>[N], list<T>[N])
- pairwiseMin(list<T>, list<T>)
- pairwiseMin(list<T>[N], list<T>[N])
- range(T)
- range(int32)
- range(int32, int32)
- range(int32, int32, int32)
- remove(T, int32)
- remove(T, int32, int32)
- remove(T, list<int32>)
- remove(map<K, V>, K)
- remove(map<K, V>[N], K)
- remove(set<K>, K)
- remove(set<K>[N], K)
- removeM(T, int32)
- removeM(T, int32, int32)
- removeM(map<K, V>, K)
- removeM(map<K, V>[N], K)
- removeM(set<K>, K)
- removeM(set<K>[N], K)
- reverse(T)
- reverseM(T)
- selectFromList(list<boolean>, T, T)
- setDifference(T, T)
- setIntersection(T, T)
- setUnion(T, T)
- size(T)
- size(blob)
- slice(T, int32, int32)
- slice(T, int32, int32, int32)
- slice(T, int32, int32, int32, int32)
- sort(list<T>)
- sort(list<T>[N])
- sortIndices(list<T>)
- sortIndices(list<T>[N])
- sortM(list<T>)
- sortM(list<T>[N])
- toSet(list<T>)
- toSet(list<T>[N])
- spl.compat
- SPADE operators: The Stream Processing Application Declarative Engine (SPADE) language was introduced with the original release of IBM InfoSphere Streams.
- Operators
- spl.control
- This namespace contains components for creating and using a job control plane that can be used to communicate control information between operators within a job.
- Operators
- spl.file
- This namespace contains components for handling files.
- Functions
- clearerr(uint64)
- fclose(uint64, int32)
- feof(uint64)
- fflush(uint64, int32)
- fopen(rstring, rstring, int32)
- fopen(ustring, ustring, int32)
- fread(list<uint8>, uint64, uint64, int32)
- freadBin(T, uint64, int32)
- freadLine(uint64, int32)
- freadToken(uint64, int32)
- freadTxt(T, uint64, int32)
- freadfile(blob, uint64, int32)
- fseek(uint64, int64, int32, int32)
- fstat(rstring, rstring, timestamp, int32)
- fstat(rstring, rstring, uint64, int32)
- fstat(uint64, rstring, timestamp, int32)
- fstat(uint64, rstring, uint64, int32)
- fstat(uint64, ustring, timestamp, int32)
- fstat(uint64, ustring, uint64, int32)
- fstat(ustring, ustring, timestamp, int32)
- fstat(ustring, ustring, uint64, int32)
- ftell(uint64, int32)
- fwrite(list<uint8>, uint64, uint64, uint64, int32)
- fwriteBin(T, uint64, int32)
- fwriteString(T, uint64, int32)
- fwriteTxt(T, uint64, int32)
- fwriteblob(blob, uint64, int32)
- isEACCES(int32)
- isEAGAIN(int32)
- isEBADF(int32)
- isEFAULT(int32)
- isEFBIG(int32)
- isEINTR(int32)
- isEINVAL(int32)
- isEIO(int32)
- isEISDIR(int32)
- isELOOP(int32)
- isEMFILE(int32)
- isENAMETOOLONG(int32)
- isENFILE(int32)
- isENODEV(int32)
- isENOENT(int32)
- isENOMEM(int32)
- isENOSPC(int32)
- isENOTDIR(int32)
- isENXIO(int32)
- isEOF(int32)
- isEOVERFLOW(int32)
- isEPERM(int32)
- isEPIPE(int32)
- isEROFS(int32)
- isESPIPE(int32)
- isETXTBSY(int32)
- isEWOULDBLOCK(int32)
- mkdir(rstring, uint32, int32)
- optSEEK_CUR()
- optSEEK_END()
- optSEEK_SET()
- remove(rstring, int32)
- remove(ustring, int32)
- rewind(uint64)
- spl.math
- This namespace contains components for performing mathematical computations.
- Functions
- PI()
- abs(T)
- abs(T)
- abs(complex32)
- abs(complex64)
- abs(list<T>)
- abs(list<T>[N])
- acos(T)
- asin(T)
- atan(T)
- avg(list<T>)
- avg(list<T>[N])
- ceil(T)
- ceil(decimal32)
- ceil(decimal64)
- cos(T)
- exp(T)
- exp(T)
- floor(T)
- fmod(T, T)
- imag(complex32)
- imag(complex64)
- infl()
- infw()
- isInf(T)
- isInf(T)
- isNaN(T)
- isNaN(T)
- kthelem(list<T>, uint32)
- kthelem(list<T>[N], uint32)
- lg(T)
- lg(T)
- ln(T)
- ln(T)
- log(T)
- log(T)
- log10(T)
- log10(T)
- max(T, T)
- max(list<T>)
- max(list<T>[N])
- median(list<T>)
- median(list<T>[N])
- min(T, T)
- min(list<T>)
- min(list<T>[N])
- nanl()
- nanw()
- pow(T, T)
- pow(T, T)
- pow(T, T)
- random()
- random(int32)
- real(complex32)
- real(complex64)
- round(T)
- sin(T)
- sqrt(T)
- srand(int32)
- stddev(list<T>)
- stddev(list<T>, boolean)
- stddev(list<T>[N])
- stddev(list<T>[N], boolean)
- sum(list<T>)
- sum(list<T>[N])
- tan(T)
- spl.relational
- This namespace contains components that can transform streams using relational predicates.
- spl.string
- This namespace contains components for handling strings.
- Functions
- appendM(rstring[N], rstring)
- appendM(rstring[N], rstring[M])
- concat(rstring, rstring)
- concat(rstring, rstring[N])
- concat(rstring[N], rstring)
- concat(rstring[N], rstring[M])
- convertFromBlob(blob)
- convertFromUtf8(rstring, rstring)
- convertFromUtf8ToString(rstring, rstring)
- convertToBlob(rstring)
- convertToUtf8(list<uint8>, rstring)
- convertToUtf8(list<uint8>[N], rstring)
- convertToUtf8(rstring, rstring)
- csvTokenize(rstring)
- csvTokenize(ustring)
- findFirst(T, T)
- findFirst(T, T, int32)
- findFirstNotOf(T, T)
- findFirstNotOf(T, T, int32)
- findFirstOf(T, T)
- findFirstOf(T, T, int32)
- findLast(T, T, int32)
- findLastNotOf(T, T, int32)
- findLastOf(T, T, int32)
- interpretRStringLiteral(rstring)
- interpretUStringLiteral(rstring)
- length(T)
- lower(T)
- ltrim(T, T)
- makeRStringLiteral(rstring)
- makeUStringLiteral(ustring)
- regexMatch(rstring, rstring)
- regexMatch(ustring, ustring)
- regexMatchPerl(rstring, rstring)
- regexMatchPerl(ustring, ustring)
- regexReplace(rstring, rstring, rstring, boolean)
- regexReplace(ustring, ustring, ustring, boolean)
- regexReplacePerl(rstring, rstring, rstring, boolean)
- regexReplacePerl(ustring, ustring, ustring, boolean)
- rtrim(T, T)
- substring(T, int32, int32)
- toCharacterCode(T)
- tokenize(rstring, rstring, boolean)
- tokenize(rstring, rstring, boolean, boolean, list<rstring>)
- tokenize(ustring, ustring, boolean)
- tokenize(ustring, ustring, boolean, boolean, list<ustring>)
- trim(T, T)
- upper(T)
- spl.time
- This namespace contains components for handling times and timestamps.
- Functions
- add(timestamp, float64)
- add(timestamp, int64)
- createTimestamp(int64, uint32)
- createTimestamp(int64, uint32, int32)
- ctime(timestamp)
- day(timestamp)
- dayOfWeek(timestamp)
- dayOfYear(timestamp)
- diffAsNanos(timestamp, timestamp)
- diffAsSecs(timestamp, timestamp)
- fromDecimal128(decimal128)
- getCPUCounterInNanoSeconds()
- getMachineId(timestamp)
- getNanoseconds(timestamp)
- getSeconds(timestamp)
- getTimestamp()
- getTimestampInSecs()
- gmday(timestamp)
- gmdayOfWeek(timestamp)
- gmdayOfYear(timestamp)
- gmhour(timestamp)
- gmminute(timestamp)
- gmmonth(timestamp)
- gmsecond(timestamp)
- gmtime(timestamp, tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>)
- gmyear(timestamp)
- hour(timestamp)
- minute(timestamp)
- month(timestamp)
- second(timestamp)
- strftime(tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>, rstring)
- strptime(rstring, rstring, tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>, uint32)
- time(timestamp, rstring, tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>)
- time(timestamp, tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>)
- timeStringToTimestamp(rstring, rstring, boolean)
- timeStringToTimestamp(rstring, rstring, rstring, boolean)
- timeStringToTimestamp(ustring, ustring, boolean)
- timeStringToTimestamp(ustring, ustring, ustring, boolean)
- timeStringtoTimestamp(rstring, rstring, boolean)
- timeStringtoTimestamp(rstring, rstring, rstring, boolean)
- timeStringtoTimestamp(ustring, ustring, boolean)
- timeStringtoTimestamp(ustring, ustring, ustring, boolean)
- toDecimal128(timestamp)
- toTimestamp(enum{YYYYMMDDhhmmss, YYYY_MM_DD_hh_mm_ss, MM_DD_YYYY_hh_mm_ss, DD_MM_YYYY_hh_mm_ss, YYYY_MM_DD_hh_mm_ss_mmm, MM_DD_YYYY_hh_mm_ss_mmm, DD_MM_YYYY_hh_mm_ss_mmm}, T)
- toTimestamp(enum{YYYYMMDDhhmmss, YYYY_MM_DD_hh_mm_ss, MM_DD_YYYY_hh_mm_ss, DD_MM_YYYY_hh_mm_ss, YYYY_MM_DD_hh_mm_ss_mmm, MM_DD_YYYY_hh_mm_ss_mmm, DD_MM_YYYY_hh_mm_ss_mmm}, T, T)
- toTimestamp(tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>)
- toTimestamp(tuple<int32 sec, int32 min, int32 hour, int32 mday, int32 mon, int32 year, int32 wday, int32 yday, int32 isdst, int32 gmtoff, rstring zone>, boolean)
- year(timestamp)
- spl.utility
- This namespace contains components of general utility that include customizable operators, and functions for obtaining configuration information, logging, managing consistent regions and using custom metrics.
- Functions
- PEID()
- abort()
- appLog(enum{error, warn, info}, T)
- appLog(enum{error, warn, info}, T, T)
- appTrc(enum{error, warn, info, debug, trace}, T)
- appTrc(enum{error, warn, info, debug, trace}, T, T)
- assert(boolean)
- assert(boolean, T)
- assert(list<boolean>)
- assert(list<boolean>[N])
- assert(map<T, boolean>)
- assert(map<T, boolean>[N])
- assignFrom(T1, T2)
- block(float64)
- createCustomMetric(rstring, rstring, enum{Gauge, Counter, Time}, int64)
- createCustomMetric(ustring, ustring, enum{Gauge, Counter, Time}, int64)
- dataDirectory()
- domainID()
- evalPredicate(rstring, T, int32)
- flushStdio()
- formatNumber(float64)
- formatNumber(float64, uint32, uint32, boolean)
- formatNumber(int64)
- formatNumber(int64, uint32)
- getAllChannels()
- getAllMaxChannels()
- getApplicationConfiguration(map<rstring, rstring>, rstring)
- getApplicationConfigurationProperty(rstring, rstring, int32)
- getApplicationConfigurationProperty(rstring, rstring, rstring)
- getApplicationDir()
- getApplicationName()
- getChannel()
- getCompileTimeListValue(rstring)
- getCompileTimeValue(rstring)
- getCompileTimeValue(rstring, rstring)
- getConfiguredHostName()
- getConsistentRegionIndex()
- getCustomMetricNames()
- getCustomMetricValue(rstring, int64)
- getCustomMetricValue(ustring, int64)
- getDrainTimeout()
- getEnvironmentVariable(rstring)
- getEnvironmentVariable(rstring, boolean)
- getEnvironmentVariable(rstring, rstring)
- getHostName()
- getIPAddress()
- getInputPortImportFilterExpression(uint32, int32)
- getInputPortImportSubscription(uint32, int32)
- getInputPortMetricValue(uint32, enum{nTuplesProcessed, nTuplesDropped, nTuplesQueued, nWindowPunctsProcessed, nFinalPunctsProcessed, nWindowPunctsQueued, nFinalPunctsQueued, queueSize}, int64)
- getJobGroup()
- getJobName()
- getLocalChannel()
- getLocalMaxChannels()
- getMainCompositeName()
- getMaxChannels()
- getOutputPortCongestionFactor(uint32)
- getOutputPortExportProperties(list<tuple<rstring name, rstring value, rstring typ>>, uint32)
- getOutputPortMetricValue(uint32, enum{nTuplesSubmitted, nWindowPunctsSubmitted, nFinalPunctsSubmitted}, int64)
- getPEOutputPortConnections(uint32, list<tuple<int64 pe, int64 port, uint8 congestionFactor, uint64 nTuplesFilteredOut>>)
- getRelaunchCount()
- getResetAttempt()
- getResetTimeout()
- getSequenceId()
- getShortHostName()
- getSubmissionTimeListValue(rstring)
- getSubmissionTimeListValue(rstring, list<rstring>)
- getSubmissionTimeValue(rstring)
- getSubmissionTimeValue(rstring, rstring)
- getThisCompositeInstanceName()
- getThisFileDir()
- getThisFileName()
- getThisFilePath()
- getThisLine()
- getThisOperatorLogicalName()
- getThisOperatorName()
- getThisToolkitDir()
- hasCustomMetric(rstring)
- hasCustomMetric(ustring)
- hashCode(T)
- hashCodeForEach(L)
- inputPort(T)
- instanceID()
- isConsistentInputPort(uint32)
- isControlInputPort(uint32)
- isEndOfConsistentRegion()
- isInConsistentRegion()
- isLoggable(enum{error, warn, info})
- isShutdown()
- isStartOfConsistentRegion()
- isTraceable(enum{error, warn, info, debug, trace})
- isTriggerOfConsistentRegion()
- jobID()
- loadAndFormatResource(rstring, rstring, rstring)
- loadAndFormatResource(rstring, rstring, rstring, T)
- loadAndFormatResource(rstring, rstring, rstring, T, rstring)
- loadAndFormatResource(rstring, rstring, rstring, rstring)
- log(enum{error, info, debug, trace}, T)
- log(enum{error, info, debug, trace}, T, T)
- mktemp(rstring)
- outputPort(T)
- parseNumber(float64, rstring)
- parseNumber(float64, ustring)
- parseNumber(int64, rstring)
- parseNumber(int64, rstring, int32)
- parseNumber(int64, ustring)
- print(T)
- printString(T)
- printStringLn(T)
- println(T)
- resetConsistentRegion()
- setCustomMetricValue(rstring, int64)
- setCustomMetricValue(ustring, int64)
- setInputPortImportFilterExpression(rstring, uint32)
- setInputPortImportSubscription(rstring, uint32)
- setOutputPortExportProperties(T, uint32)
- setOutputPortExportProperties(list<tuple<rstring name, rstring value, rstring typ>>, uint32)
- shutdownPE()
- strerror(int32)
- strtod(rstring)
- strtod(rstring, int32)
- strtoll(rstring, int32)
- strtoll(rstring, int32, int32)
- strtoull(rstring, int32)
- strtoull(rstring, int32, int32)
- swap(T, T)