Identifiers
In Materialize, identifiers are used to refer to columns and database objects like sources, views, and indexes.
Naming restrictions
-
The first character of an identifier must be an ASCII letter (
a-zandA-Z), an underscore (_), or any non-ASCII character. -
The remaining characters of an identifier must be ASCII letters (
a-zandA-Z), ASCII digits (0-9), underscores (_), dollar signs ($), or any non-ASCII characters.
You can circumvent any of the above rules by double-quoting the identifier,
e.g. "123_source" or "fun_source_@". All characters inside a quoted
identifier are taken literally, except that double-quotes must be escaped by
writing two adjacent double-quotes, as in "includes""quote".
Additionally, the identifiers "." and ".." are not permitted.
Case sensitivity
Materialize performs case folding (the caseless comparison of text) for identifiers, which means that identifiers are effectively case-insensitive (foo is the same as FOO is the same as fOo). This can cause issues when column names come from data sources which do support case-sensitive names, such as Avro-formatted sources or CSV headers.
To avoid conflicts, double-quote all field names ("field_name") when working with case-sensitive sources.
Keyword collision
Materialize is very permissive with accepting SQL keywords as identifiers (e.g.
offset, user). If Materialize cannot use a keyword as an
identifier in a particular location, it throws a syntax error. You can wrap the
identifier in double quotes to force Materialize to interpret the word as an
identifier instead of a keyword.
For example, SELECT offset is invalid, because it looks like a mistyping of
SELECT OFFSET <n>. You can wrap the identifier in double quotes, as in
SELECT "offset", to resolve the error.
We recommend that you avoid using keywords as identifiers whenever possible, as the syntax errors that result are not always obvious.
The current keywords are listed below.
ACCESSACTIONADDADDEDADDRESSADDRESSESAFTERAGGREGATEAGGREGATIONALIGNEDALLALTERANALYSISANDANYARITYARNARRANGEDARRANGEMENTARRAYASASCASSERTASSUMEATAUCTIONAUTHORITYAVAILABILITYAVROAWSBATCHBEGINBETWEENBIGINTBILLEDBODYBOOLEANBOTHBPCHARBROKENBROKERBROKERSBYBYTESCAPTURECARDINALITYCASCADECASECASTCERTIFICATECHAINCHAINSCHARCHARACTERCHARACTERISTICSCHECKCLASSCLIENTCLOCKCLOSECLUSTERCLUSTERSCOALESCECOLLATECOLUMNCOLUMNSCOMMENTCOMMITCOMMITTEDCOMPACTIONCOMPATIBILITYCOMPRESSIONCOMPUTECOMPUTECTLCONFIGCONFLUENTCONNECTIONCONNECTIONSCONSTRAINTCONTINUALCOPYCOUNTCOUNTERCREATECREATECLUSTERCREATEDBCREATENETWORKPOLICYCREATEROLECREATIONCROSSCSECSVCURRENTCURSORDATABASEDATABASESDATUMSDAYDAYSDEALLOCATEDEBEZIUMDEBUGDEBUGGINGDECDECIMALDECLAREDECODINGDECORRELATEDDEFAULTDEFAULTSDELETEDELIMITEDDELIMITERDELTADESCDETAILSDIRECTIONDISCARDDISKDISTINCTDOCDOTDOUBLEDROPEAGERELEMENTELSEENABLEENDENDPOINTENFORCEDENVELOPEEQUIVALENCESERRORERRORSESCAPEESTIMATEEVERYEXCEPTEXCLUDEEXECUTEEXISTSEXPECTEDEXPLAINEXPOSEEXPRESSIONSEXTERNALEXTRACTFACTORFALSEFASTFEATURESFETCHFIELDSFILEFILESFILTERFIRSTFIXPOINTFLOATFOLLOWINGFORFOREIGNFORMATFORWARDFROMFULLFULLNAMEFUNCTIONFUSIONGENERATORGRANTGREATESTGROUPGROUPSHAVINGHEADERHEADERSHISTORYHOLDHOSTHOURHOURSHUMANIZEDHYDRATIONIDIDENTIFIERSIDSIFIGNOREILIKEIMPLEMENTATIONSIMPORTEDININCLUDEINDEXINDEXESINFOINHERITINLINEINNERINPUTINSERTINSIGHTSINSPECTINSTANCEINTINTEGERINTERNALINTERSECTINTERVALINTOINTROSPECTIONISISNULLISOLATIONJOINJOINSJSONKAFKAKEYKEYSLASTLATERALLATESTLEADINGLEASTLEFTLEGACYLETRECLEVELLIKELIMITLINEARLISTLOADLOCALLOCALLYLOGLOGICALLOGINLOWERINGMANAGEDMANUALMAPMARKETINGMATERIALIZEMATERIALIZEDMAXMECHANISMSMEMBERSHIPMESSAGEMETADATAMINUTEMINUTESMODEMONTHMONTHSMUTUALLYMYSQLNAMENAMESNATURALNEGATIVENETWORKNEWNEXTNONOCREATECLUSTERNOCREATEDBNOCREATEROLENODENOINHERITNOLOGINNONNONENOSUPERUSERNOTNOTICENOTICESNULLNULLIFNULLSOBJECTSOFOFFSETONONLYOPERATOROPTIMIZEDOPTIMIZEROPTIONSORORDERORDINALITYOUTEROVEROWNEDOWNERPARTITIONPARTITIONSPASSWORDPATHPATTERNPHYSICALPLANPLANSPOLICIESPOLICYPORTPOSITIONPOSTGRESPRECEDINGPRECISIONPREFIXPREPAREPRIMARYPRIORITIZEPRIVATELINKPRIVILEGESPROGRESSPROJECTIONPROTOBUFPROTOCOLPUBLICPUBLICATIONPUSHDOWNQUALIFYQUERYQUOTERAISERANGERATERAWREADREADYREALREASSIGNRECURSIONRECURSIVEREDACTEDREDUCEREFERENCEREFERENCESREFRESHREGEXREGIONREGISTRYRELATIONRENAMEREOPTIMIZEREPEATABLEREPLACEREPLANREPLICAREPLICASREPLICATIONRESETRESPECTRESTRICTRETAINRETURNRETURNINGREVOKERIGHTROLEROLESROLLBACKROTATEROUNDSROWROWSRULESSASLSCALESCHEDULESCHEMASCHEMASSECONDSECONDSSECRETSECRETSSECURITYSEEDSELECTSEQUENCESSERIALIZABLESERVERSERVICESESSIONSETSHARDSHOWSINKSINKSSIZESMALLINTSNAPSHOTSOMESOURCESOURCESSQLSSHSSLSTARTSTDINSTDOUTSTORAGESTORAGECTLSTRATEGYSTRICTSTRINGSTRONGSUBSCRIBESUBSOURCESUBSOURCESSUBSTRINGSUBTREESUPERUSERSWAPSYNTAXSYSTEMTABLETABLESTAILTASKTASKSTEMPTEMPORARYTEXTTHENTICKTIESTIMETIMEOUTTIMESTAMPTIMESTAMPTZTIMINGTOTOKENTOPICTPCHTRACETRAILINGTRANSACTIONTRANSACTIONALTRANSFORMTRIMTRUETUNNELTYPETYPESUNBOUNDEDUNCOMMITTEDUNIONUNIQUEUNKNOWNUNNESTUNTILUPUPDATEUPSERTURLUSAGEUSERUSERNAMEUSERSUSINGVALIDATEVALUEVALUESVARCHARVARIADICVARYINGVERBOSEVERSIONVIEWVIEWSWAITWARNINGWEBHOOKWHENWHEREWHILEWINDOWWIREWITHWITHINWITHOUTWORKWORKERSWORKLOADWRITEYEARYEARSYUGABYTEZONEZONES