Skip to main content

Commands

Every PPL command of the OpenSearch command reference and how LynxDB executes it. full follows the OpenSearch semantics apart from the listed deviations; partial runs with the listed options and limits and rejects the others with an UNSUPPORTED_FEATURE error; unsupported commands fail with UNSUPPORTED_COMMAND.

CommandSupportNotes
adunsupportedit runs the OpenSearch ML Commons plugin, which LynxDB does not have
addcoltotalsfull
addtotalsfull
appendfull
appendcolfull
appendpipefullthe input is computed twice
binpartialspan= with numeric and time units; bins, minspan, aligntime, start, end and logarithmic spans are unsupported
chartpartiallimit (topN, bottomN), useother, usenull, nullstr, otherstr and span= on splits supported; bins, minspan, start and end unsupported
convertfullauto, num, rmcomma, rmunit, memk, dur2sec, mstime, ctime, mktime, none
dedupfull
describepartialreturns TABLE_NAME, COLUMN_NAME, TYPE_NAME and ORDINAL_POSITION from the values stored in the index
evalfull
eventstatspartialbucket_nullable=false with a by clause and the window functions row_number, rank, dense_rank, percent_rank, cume_dist, nth and ntile are unsupported
expandfull
explainpartialreturns LynxDB's logical and optimized IR plans; the simple, standard, cost and extended modes render the same plans
fieldformatunsupporteddisplay formatting with prefix and suffix is not implemented; use eval with concat()
fieldsfull
fillnullfullwithout a field list, fills NULL values of the columns each row has
flattenpartialaliases are assigned to members in key order
foreachunsupportedtemplated per-field evaluation is not implemented; write one eval per field
graphlookupunsupportedrecursive graph traversal needs an iterative join operator LynxDB does not have
grokpartialbuilt-in library of common patterns (pkg/ppl/grok); custom pattern definitions are not supported
headfull
joinpartialinner, left, right, full, semi, anti and cross joins with equality keys and a residual condition, overwrite and max; the right side is held in memory
kmeansunsupportedit runs the OpenSearch ML Commons plugin, which LynxDB does not have
lookuppartialreplace, append and output with an explicit output field list
makeresultsfull
mlunsupportedit runs the OpenSearch ML Commons plugin, which LynxDB does not have
multisearchfullresults are merged newest first
mvcombinefull
mvexpandfull
nomvfull
parsefullRE2 regular expressions: no lookaround or backreferences
patternspartialsimple_pattern in label and aggregation modes; a by clause only in aggregation mode; brain and show_numbered_token=true unsupported
rarefull
regexfullRE2 syntax
renamefull
replacefull
restunsupportedit reads OpenSearch cluster management endpoints; use the LynxDB REST API
reversefull
rexpartialextract mode and sed s/regex/replacement/[g]; offset_field unsupported; RE2 syntax
searchpartialfree-text terms match whole tokens of the event's raw text through the term index (OpenSearch searches all fields); quoted phrases match at token boundaries; field comparisons are exact and case-sensitive; field wildcards match the whole value; time modifiers supported; cross-cluster prefixes are read as part of the index name
show datasourcesunsupportedLynxDB has no external data sources; every index is local
sortfullip(field) sorts by the text form of the address
spathpartialauto-extract keeps JSON value types; a JSON null stays NULL
statspartialbucket_nullable supported; partitions, allnum and delim accepted without effect; dedup_splitvalues unsupported; distinct_count is estimated beyond 10,000 values per group only by the row operators; output row order is unspecified
streamstatspartialcurrent, window and global=false supported; bucket_nullable=false with a by clause, reset_before, reset_after, time_window, and window with global=true and a by clause are unsupported
subquerypartialuncorrelated IN, EXISTS and scalar subqueries; a subquery is evaluated once before the outer query; correlated subqueries are not supported: a reference through the outer source name or alias (outer.b), or to a field only the outer query has, fails to compile, and an unqualified name the subquery can also have reads the subquery's own field
tablefull
timechartpartialspan, limit, useother, usenull, nullstr and timefield supported (the default time field is _time); bins and minspan unsupported; per_second, per_minute, per_hour and per_day supported
timewrapunsupportedperiod-over-period wrapping is not implemented; compute the shifted period with eval and join
topfull
transposefull
trendlinefull
unionfull
wherefull
xyseriesfull