References

Built-in Functions

Database Functions

Name	Description
`rollbackTransaction()`	Marks the current transaction as failed and prevents all objects from being persisted in the database.	Open details
`remoteCypher()`	Returns the result of the given Cypher query against a remote instance.	Open details
`cypher()`	Executes the given Cypher query directly on the database and returns the results as Structr entities.	Open details
`isEntity()`	Returns true if the given argument is a Structr entity (node or relationship).	Open details
`get()`	Returns the value with the given name of the given entity, or an empty string.	Open details
`getOrNull()`	Returns the value with the given name of the given entity, or null.	Open details
`search()`	Returns a collection of entities of the given type from the database, takes optional key/value pairs. Searches case-insensitive / inexact.	Open details
`searchFulltext()`	Returns a map of entities and search scores matching the given search string from the given fulltext index.	Open details
`searchRelationshipsFulltext()`	Returns a map of entities and search scores matching the given search string from the given fulltext index. Searches case-insensitve / inexact.	Open details
`incoming()`	Returns all incoming relationships of a node, with an optional qualifying relationship type.	Open details
`outgoing()`	Returns all outgoing relationships of a node, with an optional qualifying relationship type.	Open details
`hasRelationship()`	Returns true if the given entity has relationships of the given type.	Open details
`hasOutgoingRelationship()`	Returns true if the given entity has outgoing relationships of the given type.	Open details
`hasIncomingRelationship()`	Returns true if the given entity has incoming relationships of the given type.	Open details
`getRelationships()`	Returns the relationships of the given entity with an optional relationship type.	Open details
`getOutgoingRelationships()`	Returns the outgoing relationships of the given entity with an optional relationship type.	Open details
`getIncomingRelationships()`	Returns all incoming relationships between the given nodes, with an optional qualifying relationship type.	Open details
`find()`	Returns a collection of entities of the given type from the database.	Open details
`getOrCreate()`	Returns an entity with the given properties, creating one if it doesn’t exist.	Open details
`createOrUpdate()`	Creates an object with the given properties or updates an existing object if it can be identified by a unique property.	Open details
`findRelationship()`	Returns a collection of relationship entities of the given type from the database, takes optional key/value pairs.	Open details
`prefetch()`	Prefetches a subgraph.	Open details
`addLabels()`	Adds the given set of labels to the given node.	Open details
`removeLabels()`	Removes the given set of labels from the given node.	Open details
`set()`	Sets a value or multiple values on an entity. The values can be provided as a map or as a list of alternating keys and values.	Open details
`create()`	Creates a new node with the given type and key-value pairs in the database.	Open details
`delete()`	Deletes the one or more nodes or relationships from the database.	Open details
`createRelationship()`	Creates and returns relationship of the given type between two entities.	Open details
`setPrivileged()`	Sets the given key/value pair(s) on the given entity with super-user privileges.	Open details
`findPrivileged()`	Executes a `find()` operation with elevated privileges.	Open details
`instantiate()`	Converts the given raw Neo4j entity to a Structr entity.	Open details
`jdbc()`	Fetches data from a JDBC source.	Open details
`mongodb()`	Opens a connection to a MongoDB source and returns a MongoCollection which can be used to further query the Mongo database.	Open details
`predicate.range`	Returns a range predicate that can be used in find() function calls.	Open details
`predicate.withinDistance`	Returns a query predicate that can be used with find() or search().	Open details
`predicate.or`	Returns a query predicate that can be used with find() or search().	Open details
`predicate.not`	Returns a query predicate that can be used with find() or search().	Open details
`predicate.sort`	Returns a query predicate that can be used with find() or search().	Open details
`predicate.page`	Returns a query predicate that can be used with find() or search().	Open details
`predicate.startsWith`	Returns a query predicate that can be used with find() or search().	Open details
`predicate.lt`	Returns an lt predicate that can be used in find() function calls.	Open details
`predicate.lte`	Returns an lte predicate that can be used in find() function calls.	Open details
`predicate.gte`	Returns a gte predicate that can be used in find() function calls.	Open details
`predicate.gt`	Returns a gt predicate that can be used in find() function calls.	Open details

Markdown Rendering Hint: Children of Topic(Database Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Conversion Functions

Name	Description
`md5()`	Returns the MD5 hash of a given object.	Open details
`num()`	Tries the convert given object into a floating-point number with double precision.	Open details
`long()`	Tries to convert the given object into a long integer value.	Open details
`int()`	Tries to convert the given object into an integer value.	Open details
`coalesce()`	Returns the first non-null value in the list of expressions passed to it. In case all arguments are null, null will be returned.	Open details
`formurlencode()`	Encodes the given object to an application/x-www-form-urlencoded string.	Open details
`urlencode()`	URL-encodes the given string.	Open details
`escapeJavascript()`	Escapes the given string for use with Javascript.	Open details
`escapeJson()`	Escapes the given string for use within JSON.	Open details
`dateFormat()`	Formats the given date object according to the given pattern, using the current locale (language/country settings).	Open details
`parseDate()`	Parses the given date string using the given format string.	Open details
`toDate()`	Converts the given number to a date.	Open details
`numberFormat()`	Formats the given value using the given locale and format string.	Open details
`parseNumber()`	Parses the given string using the given (optional) locale.	Open details
`hash()`	Returns the hash (as a hexadecimal string) of a given string, using the given algorithm (if available via the underlying JVM).	Open details
`escapeHtml()`	Replaces HTML characters with their corresponding HTML entities.	Open details
`escapeXml()`	Replaces XML characters with their corresponding XML entities.	Open details
`unescapeHtml()`	Reverses the effect of `escape_html()`.	Open details
`toGraphObject()`	Converts the given entity to GraphObjectMap.	Open details
`bson()`	Creates BSON document from a map / object.	Open details
`latLonToUtm()`	Converts the given latitude/longitude coordinates into an UTM string.	Open details
`utmToLatLon()`	Converts the given UTM string to latitude/longitude coordinates.	Open details

Markdown Rendering Hint: Children of Topic(Conversion Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

String Functions

Name	Description
`upper()`	Returns the uppercase value of its parameter.	Open details
`lower()`	Returns the lowercase version of the given string.	Open details
`join()`	Joins the given collection of strings into a single string, separated by the given separator.	Open details
`concat()`	Concatenates the given list of objects into a single string without a separator between them.	Open details
`split()`	Splits the given string by the whole separator string.	Open details
`splitRegex()`	Splits the given string by given regex.	Open details
`abbr()`	Abbreviates the given string at the last space character before the maximum length is reached.	Open details
`capitalize()`	Capitalizes the given string.	Open details
`titleize()`	Titleizes the given string.	Open details
`indexOf()`	Returns the position of the first occurrence of the given word in the given string, or -1 if the string doesn’t contain the word.	Open details
`contains()`	Returns true if the given string or collection contains a given element.	Open details
`substring()`	Returns the substring of the given string.	Open details
`length()`	Returns the length of the given string.	Open details
`replace()`	Replaces script expressions in the given template with values from the given entity.	Open details
`trim()`	Removes whitespace at the edges of the given string.	Open details
`clean()`	Cleans the given string.	Open details
`strReplace()`	Replaces each substring of the subject that matches the given regular expression with the given replacement.	Open details
`startsWith()`	Returns true if the given string starts with the given prefix.	Open details
`endsWith()`	Returns true if the given string ends with the given suffix.	Open details
`base64encode()`	Encodes the given string and returns a base64-encoded string.	Open details
`base64decode()`	Decodes the given base64 text using the supplied scheme.	Open details
`stripHtml()`	Removes all HTML tags from the given source string and returns only the content.	Open details
`stopWords()`	Returns a list of words (for the given language) which can be ignored for NLP purposes.	Open details
`localize()`	Returns a (cached) Localization result for the given key and optional domain.	Open details

Markdown Rendering Hint: Children of Topic(String Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

System Functions

Name	Description
`random()`	Returns a random alphanumeric string of the given length.	Open details
`timer()`	Starts/Stops/Pings a timer.	Open details
`store()`	Stores the given value in the current request context under the given key.	Open details
`stackDump()`	Logs the current execution stack.	Open details
`sleep()`	Pauses the execution of the current thread for the given number of milliseconds.	Open details
`randomUuid()`	Returns a random UUID.	Open details
`hasCacheValue()`	Checks if a cached value exists for the given key.	Open details
`getCacheValue()`	Retrieves the cached value for the given key.	Open details
`setLogLevel()`	Sets the application log level to the given level, if supported.	Open details
`setSessionAttribute()`	Store a value under the given key in the users session.	Open details
`getSessionAttribute()`	Retrieve a value for the given key from the user session.	Open details
`removeSessionAttribute()`	Remove key/value pair from the user session.	Open details
`isLocale()`	Returns true if the current user locale is equal to the given argument.	Open details
`logEvent()`	Logs an event to the Structr log.	Open details
`maintenance()`	Allows an admin user to execute a maintenance command from within a scripting context.	Open details
`jobInfo()`	Returns information about the job with the given job ID.	Open details
`jobList()`	Returns a list of running jobs.	Open details
`systemInfo()`	Returns information about the system.	Open details
`getenv()`	Returns the value of the specified environment variable. If no value is specified, all environment variables are returned as a map. An environment variable is a system-dependent external named value.	Open details
`changelog()`	Returns the changelog for a given entity.	Open details
`userChangelog()`	Returns the changelog for the changes a specific user made.	Open details
`serverlog()`	Returns the last n lines from the server log file.	Open details
`getAvailableServerlogs()`	Returns a collection of available server logs files.	Open details
`structrEnv()`	Returns Structr runtime env information.	Open details
`disableCascadingDelete()`	Disables cascading delete in the Structr Backend for the current transaction.	Open details
`enableCascadingDelete()`	Enables cascading delete in the Structr Backend for the current transaction.	Open details
`disableNotifications()`	Disables the Websocket broadcast notifications in the Structr Backend UI for the current transaction.	Open details
`disableUuidValidation()`	Disables the validation of user-supplied UUIDs when creating objects.	Open details
`enableNotifications()`	Enables the Websocket broadcast notifications in the Structr Backend Ui for the current transaction.	Open details
`evaluateScript()`	Evaluates a serverside script string in the context of the given entity.	Open details
`setEncryptionKey()`	Sets the secret key for encryt()/decrypt(), overriding the value from structr.conf.	Open details
`doInNewTransaction()`	Runs the given function in a new transaction context.	Open details
`doPrivileged()`	Runs the given function in a privileged (superuser) context.	Open details
`doAs()`	Runs the given function in the context of the given user.	Open details

Markdown Rendering Hint: Children of Topic(System Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Mathematical Functions

Name	Description
`rint()`	Returns a random integer in the given range.	Open details
`add()`	Returns the sum of the given arguments.	Open details
`subt()`	Subtracts the second argument from the first argument.	Open details
`mult()`	Returns the product of all given arguments.	Open details
`quot()`	Divides the first argument by the second argument.	Open details
`div()`	Returns the result of value1 divided by value2.	Open details
`mod()`	Implements the modulo operation on two integer values.	Open details
`floor()`	Returns the given value, rounded down to the nearest integer.	Open details
`ceil()`	Returns the given value, rounded up to the nearest integer.	Open details
`round()`	Rounds the given argument to the nearest integer.	Open details
`max()`	Returns the greater of the given values.	Open details
`min()`	Returns the smaller of the given values.	Open details

Markdown Rendering Hint: Children of Topic(Mathematical Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Access Control Functions

Name	Description
`copyPermissions()`	Copies the security configuration of an entity to another entity.	Open details
`grant()`	Grants the given permissions on the given node to the given principal.	Open details
`revoke()`	Revokes the given permissions on the given entity from a user.	Open details
`isAllowed()`	Returns true if the given principal has the given permissions on the given node.	Open details
`addToGroup()`	Adds the given user as a member of the given group.	Open details
`removeFromGroup()`	Removes the given user from the given group.	Open details
`isInGroup()`	Returns true if the given user is in the given group.	Open details

Markdown Rendering Hint: Children of Topic(Access Control Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Scripting Functions

Name	Description
`coalesceObjects()`	Returns the first non-null value in the list of expressions passed to it. In case all arguments are null, null will be returned.	Open details
`weekDays()`	Calculates the number of week days (working days) between given dates.	Open details
`mergeProperties()`	Copies the values for the given list of property keys from the source entity to the target entity.	Open details
`retrieve()`	Returns the value associated with the given key from the temporary store.	Open details
`schedule()`	Schedules a script or a function to be executed in a separate thread.	Open details
`applicationStorePut()`	Stores a value in the application level store.	Open details
`applicationStoreDelete()`	Removes a stored value from the application level store.	Open details
`applicationStoreGet()`	Returns a stored value from the application level store.	Open details
`applicationStoreGetKeys()`	Lists all keys stored in the application level store.	Open details
`applicationStoreHas()`	Checks if a key is present in the application level store.	Open details
`requestStorePut()`	Stores a value in the request level store.	Open details
`requestStoreDelete()`	Removes a stored value from the request level store.	Open details
`requestStoreGet()`	Retrieves a stored value from the request level store.	Open details
`requestStoreGetKeys()`	Lists all keys stored in the request level store.	Open details
`requestStoreHas()`	Checks if a key is present in the request level store.	Open details
`call()`	Calls the given user-defined function in the current users context.	Open details
`callPrivileged()`	Calls the given user-defined function in a superuser context.	Open details

Markdown Rendering Hint: Children of Topic(Scripting Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Logic Functions

Name	Description
`empty()`	Returns a boolean value that indicates whether the given object is null or empty.	Open details
`equal()`	Returns a boolean value that indicates whether the values are equal.	Open details
`lt()`	Returns true if the first argument is less than the second argument.	Open details
`gt()`	Returns true if the first argument is greater than the second argument.	Open details
`lte()`	Returns true if the first argument is less that or equal to the second argument.	Open details
`gte()`	Returns true if the first argument is greater than or equal to the second argument.	Open details
`not()`	Returns the logical negation given boolean expression.	Open details
`and()`	Returns the logical AND result of the given boolean expressions.	Open details
`or()`	Returns the logical OR result of the given boolean expressions.	Open details
`one()`	Checks if a number is equal to 1, returns the oneValue if yes, the otherValue if no.	Open details

Markdown Rendering Hint: Children of Topic(Logic Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Collection Functions

Name	Description
`doubleSum()`	Returns the sum of all the values in the given collection as a floating-point value.	Open details
`intSum()`	Returns the sum of the given arguments as an integer.	Open details
`isCollection()`	Returns true if the given argument is a collection.	Open details
`extract()`	Extracts property values from all elements of a collection and returns them as a collection.	Open details
`merge()`	Merges collections and objects into a single collection.	Open details
`mergeUnique()`	Merges collections and objects into a single collection, removing duplicates.	Open details
`complement()`	Removes objects from a list.	Open details
`unwind()`	Converts a list of lists into a flat list.	Open details
`sort()`	Sorts the given collection or array according to the given property key. Default sort key is ‘name’.	Open details
`size()`	Returns the size of the given collection.	Open details
`first()`	Returns the first element of the given collection.	Open details
`last()`	Returns the last element of the given collection.	Open details
`nth()`	Returns the element with the given index of the given collection.	Open details

Markdown Rendering Hint: Children of Topic(Collection Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Rendering Functions

Name	Description
`setLocale()`	Sets the locale for the current request.	Open details
`print()`	Prints the given strings or objects to the output buffer.	Open details
`include()`	Loads the element with the given name and renders its HTML representation into the output buffer.	Open details
`includeChild()`	Loads a template’s child element with the given name and renders its HTML representation into the output buffer.	Open details
`render()`	Renders the children of the current node.	Open details
`setDetailsObject()`	Allows overriding the `current` keyword with a given entity.	Open details
`removeDomChild()`	Removes a node from the DOM.	Open details
`replaceDomChild()`	Replaces a node from the DOM with new HTML.	Open details
`insertHtml()`	Inserts a new HTML subtree into the DOM.	Open details
`getSource()`	Returns the rendered HTML content for the given element.	Open details
`hasCssClass()`	Returns whether the given element has the given CSS class(es).	Open details
`template()`	Returns a MailTemplate object with the given name, replaces the placeholders with values from the given entity.	Open details

Markdown Rendering Hint: Children of Topic(Rendering Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Miscellaneous Functions

Name	Description
`dateAdd()`	Adds the given values to a date.	Open details
`invalidateCacheValue()`	Invalidates the cached value for the given key (if present).	Open details

Markdown Rendering Hint: Children of Topic(Miscellaneous Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Input Output Functions

Name	Description
`log()`	Logs the given objects to the logfile.	Open details
`fromJson()`	Parses the given JSON string and returns an object.	Open details
`toJson()`	Serializes the given object to JSON.	Open details
`importHtml()`	Imports HTML source code into an element.	Open details
`importCss()`	Imports CSS classes, media queries etc. from given CSS file.	Open details
`getContent()`	Returns the content of the given file.	Open details
`setContent()`	Sets the content of the given file. Content can either be of type String or byte[].	Open details
`appendContent()`	Appends content to a Structr File.	Open details
`copyFileContents()`	Copies the content of sourceFile to targetFile and updates the meta-data accordingly.	Open details
`fromXml()`	Parses the given XML and returns a JSON string.	Open details
`createArchive()`	Creates and returns a ZIP archive with the given files (and folders).	Open details
`createFolderPath()`	Creates a new folder in the virtual file system including all parent folders if they don’t exist already.	Open details
`createZip()`	Creates and returns a ZIP archive with the given files (and folders).	Open details
`unarchive()`	Unarchives given file to an optional parent folder.	Open details
`barcode()`	Creates a barcode image of given type with the given data.	Open details
`config()`	Returns the configuration value associated with the given key from structr.conf.	Open details
`exec()`	Executes a script returning the standard output of the script.	Open details
`execBinary()`	Executes a script returning the returning the raw output directly into the output stream.	Open details
`read()`	Reads text from a file in the `exchange/` folder.	Open details
`write()`	Writes text to a new file in the `exchange/` folder.	Open details
`append()`	Appends text to a file in the `exchange/` folder.	Open details
`xml()`	Tries to parse the contents of the given string into an XML document, returning the document on success.	Open details
`xpath()`	Returns the value of the given XPath expression from the given XML document.	Open details
`encrypt()`	Encrypts the given string using AES and returns the ciphertext encoded in base 64.	Open details
`decrypt()`	Decrypts a base 64 encoded AES ciphertext and returns the decrypted result.	Open details
`importGpx()`	Parses a given GPX string and returns its contents as an object with.	Open details
`flow()`	Executes a given Flow and returns the evaluation result.	Open details
`pdf()`	Creates the PDF representation of a given page.	Open details
`translate()`	Translates the given string from the source language to the target language.	Open details
`fromCsv()`	Parses the given CSV string and returns a list of objects.	Open details
`toCsv()`	Returns a CSV representation of the given nodes.	Open details
`getCsvHeaders()`	Parses the given CSV string and returns a list of column headers.	Open details
`toExcel()`	Creates Excel from given data.	Open details
`fromExcel()`	Reads data from a given Excel sheet.	Open details

Markdown Rendering Hint: Children of Topic(Input Output Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Security Functions

Name	Description
`hmac()`	Returns a keyed-hash message authentication code generated out of the given payload, secret and hash algorithm.	Open details
`confirmationKey()`	Creates a confirmation key to use as a one-time token. Used for user confirmation or password reset.	Open details
`createAccessToken()`	Creates a JWT access token for the given user entity that can be used for request authentication and authorization.	Open details
`createAccessAndRefreshToken()`	Creates both JWT access token and refresh token for the given User entity that can be used for request authentication and authorization.	Open details
`login()`	Logs the given user in if the given password is correct. Returns true on successful login.	Open details
`pdfEncrypt()`	Encrypts a PDF file so that it can’t be opened without password.	Open details

Markdown Rendering Hint: Children of Topic(Security Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Validation Functions

Name	Description
`getErrors()`	Returns all error tokens present in the current context.	Open details
`clearErrors()`	Clears all error tokens present in the current context.	Open details
`clearError()`	Clears the given error token from the current context.	Open details
`isValidUuid()`	Tests if a given string is a valid UUID.	Open details
`isValidEmail()`	Checks if the given address is a valid email address.	Open details
`assert()`	Aborts the current request if the given condition evaluates to false.	Open details
`error()`	Stores error tokens in the current context causing the transaction to fail at the end of the request.	Open details
`hasError()`	Allows checking if an error has been raised in the scripting context.	Open details

Markdown Rendering Hint: Children of Topic(Validation Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

EMail Functions

Name	Description
`sendHtmlMail()`	Sends an HTML email.	Open details
`sendPlaintextMail()`	Sends a plaintext email.	Open details
`mailBegin()`	Begins a new mail configuration.	Open details
`mailSetFrom()`	Overwrites/Sets the from address (and optionally name) of the current mail.	Open details
`mailSetSubject()`	Overwrites/Sets the subject of the current mail.	Open details
`mailSetHtmlContent()`	Overwrites/Sets the HTML content of the current mail.	Open details
`mailSetTextContent()`	Sets/Overwrites the text content of the current mail.	Open details
`mailAddTo()`	Adds a `To:` recipient to the current mail.	Open details
`mailClearTo()`	Clears the current list of `To:` recipients.	Open details
`mailAddCc()`	Adds a `Cc:` recipient to the current mail.	Open details
`mailClearCc()`	Clears the current list of `Cc:` recipients.	Open details
`mailAddBcc()`	Adds a `Bcc:` recipient to the current mail.	Open details
`mailClearBcc()`	Clears the current list of `Bcc:` recipients.	Open details
`mailSetBounceAddress()`	Sets the bounce address of the current mail.	Open details
`mailClearBounceAddress()`	Removes the bounce address from the current mail.	Open details
`mailAddReplyTo()`	Adds a `Reply-To:` recipient to the current mail.	Open details
`mailClearReplyTo()`	Removes all `Reply-To:` configuration from the current mail.	Open details
`mailAddMimePart()`	Adds a MIME part to the current mail.	Open details
`mailAddAttachment()`	Adds an attachment with an optional file name to the current mail.	Open details
`mailClearMimeParts()`	Removes all custom MIME parts from the current mail.	Open details
`mailClearAttachments()`	Removes all attachments from the current mail.	Open details
`mailAddHeader()`	Adds a custom header to the current mail.	Open details
`mailRemoveHeader()`	Removes a specific custom header from the current mail.	Open details
`mailClearHeaders()`	Clears any configured custom headers for the current mail.	Open details
`mailSetInReplyTo()`	Sets the `In-Reply-To` header for the outgoing mail.	Open details
`mailClearInReplyTo()`	Removes the `In-Reply-To` header from the current mail.	Open details
`mailSaveOutgoingMessage()`	Configures if the current mail should be saved or not.	Open details
`mailGetLastOutgoingMessage()`	Returns the last outgoing message sent by the advanced mail module in the current script as a node of type `EMailMessage`.	Open details
`mailSend()`	Sends the currently configured mail.	Open details
`mailDecodeText()`	Decodes RFC 822 “text” token from mail-safe form as per RFC 2047.	Open details
`mailEncodeText()`	Encodes RFC 822 “text” token into mail-safe form as per RFC 2047.	Open details
`mailSelectConfig()`	Selects a configuration prefix for the SMTP configuration.	Open details
`mailSetManualConfig()`	Sets a manual SMTP configuration for the current mail.	Open details
`mailResetManualConfig()`	Resets a manual SMTP configuration for the current mail.	Open details
`mailGetError()`	Returns the last error message (or null if no error has occurred).	Open details
`mailHasError()`	Returns true if an error occurred while sending the mail.	Open details

Markdown Rendering Hint: Children of Topic(EMail Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Http Functions

Name	Description
`GET()`	Sends an HTTP GET request to the given URL and returns the response headers and body.	Open details
`HEAD()`	Sends an HTTP HEAD request with optional username and password to the given URL and returns the response headers.	Open details
`PATCH()`	Sends an HTTP PATCH request to the given URL and returns the response headers and body.	Open details
`POST()`	Sends an HTTP POST request to the given URL and returns the response body.	Open details
`POSTMultiPart()`	Sends a multi-part HTTP POST request to the given URL and returns the response body.	Open details
`PUT()`	Sends an HTTP PUT request with an optional content type to the given URL and returns the response headers and body.	Open details
`DELETE()`	Sends an HTTP DELETE request with an optional content type to the given URL and returns the response headers and body.	Open details
`addHeader()`	Temporarily adds the given (key, value) tuple to the local list of request headers.	Open details
`clearHeaders()`	Clears headers for the next HTTP request.	Open details
`setResponseHeader()`	Adds the given header field and value to the response of the current rendering run.	Open details
`removeResponseHeader()`	Removes the given header field from the server response.	Open details
`setResponseCode()`	Sets the response code of the current rendering run.	Open details
`getRequestHeader()`	Returns the value of the given request header field.	Open details
`validateCertificates()`	Disables or enables strict certificate checking when performing a request in a scripting context. The setting remains for the whole request.	Open details
`getCookie()`	Returns the requested cookie if it exists.	Open details
`setCookie()`	Sets the given cookie.	Open details

Markdown Rendering Hint: Children of Topic(Http Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

MQTT Functions

Name	Description
`mqttPublish()`	Publishes message on given mqtt client with given topic.	Open details
`mqttSubscribe()`	Subscribes given topic on given mqtt client.	Open details
`mqttUnsubscribe()`	Unsubscribes given topic on given mqtt client.	Open details

Markdown Rendering Hint: Children of Topic(MQTT Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Geocoding Functions

Name	Description
`geocode()`	Returns the geolocation (latitude, longitude) for the given street address using the configured geocoding provider.	Open details
`readShapefile()`	Reads a shapefile from a Structr path and returns it as a list of WKT strings.	Open details
`wktToPolygons()`	Converts a WKT string into a list of polygons.	Open details
`wktToGeometry()`	Converts a WKT string into a geometry object.	Open details
`makePolygonValid()`	Makes a polygon valid.	Open details
`getWfsData()`	Reads features from a WFS endpoint and returns geometries.	Open details
`getWcsData()`	Reads coverage data from a WCS endpoint and returns it.	Open details
`getWcsHistogram()`	Reads coverage data from a WCS endpoint and returns it.	Open details
`coordsToPoint()`	Converts a coordinate into a point.	Open details
`coordsToMultipoint()`	Converts a coordinate array into a multipoint geometry.	Open details
`coordsToLineString()`	Converts a coordinate array into a line string geometry.	Open details
`coordsToPolygon()`	Converts a coordinate array into a polygon.	Open details
`azimuth()`	Returns the azimuth between two geometries.	Open details
`distance()`	Returns the distance between two geometries.	Open details
`lineSegment()`	Returns a line segment with start point, azimuth and length.	Open details
`lineStringsToPolygons()`	Merges line strings to polygons.	Open details
`convertGeometry()`	Converts the given geometry from source CRS to destination CRS.	Open details
`getCoordinates()`	Returns the coordinates of a geometry.	Open details

Markdown Rendering Hint: Children of Topic(Geocoding Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Schema Functions

Name	Description
`propertyInfo()`	Returns the schema information for the given property.	Open details
`functionInfo()`	Returns information about the currently running Structr method, or about the method defined in the given type and name.	Open details
`typeInfo()`	Returns the type information for the specified type.	Open details
`enumInfo()`	Returns the possible values of an enum property.	Open details
`ancestorTypes()`	Returns the list of parent types of the given type including the type itself.	Open details
`inheritingTypes()`	Returns the list of subtypes of the given type including the type itself.	Open details
`getRelationshipTypes()`	Returns the list of available relationship types form and/or to this node. Either potentially available (schema) or actually available (database).	Open details

Markdown Rendering Hint: Children of Topic(Schema Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Predicate Functions

Name	Description
`predicate.empty`	Returns a query predicate that can be used with find() or search().	Open details
`predicate.equals`	Returns a query predicate that can be used with find() or search().	Open details
`predicate.contains`	Returns a query predicate that can be used with find() or search().	Open details
`predicate.and`	Returns a query predicate that can be used with find() or search().	Open details
`predicate.endsWith`	Returns a query predicate that can be used with find() or search().	Open details

Markdown Rendering Hint: Children of Topic(Predicate Functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Miscellaneous functions

Name	Description
`cache()`	Stores a value in the global cache.	Open details

Markdown Rendering Hint: Children of Topic(Miscellaneous functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Logic functions

Name	Description
`if()`	Evaluates a condition and executes different expressions depending on the result.	Open details
`is()`	Evaluates a condition and executes an expressions if the result is `true`.	Open details

Markdown Rendering Hint: Children of Topic(Logic functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.

Collection functions

Name	Description
`each()`	Evaluates a StructrScript expression for every element of a collection.	Open details
`filter()`	Filters a list using a StructrScript expression.	Open details
`map()`	Returns a single result from all elements of a list by applying a reduction function.	Open details
`any()`	Evaluates a StructrScript expression for every element of a collection and returns `true` if the expression evaluates to `true` for any of the elements.	Open details
`all()`	Evaluates a StructrScript expression for every element of a collection and returns `true` if the expression evaluates to `true` for all of the elements.	Open details
`none()`	Evaluates a StructrScript expression for every element of a collection and returns `true` if the expression evaluates to `true` for none of the elements.	Open details

Markdown Rendering Hint: Children of Topic(Collection functions) not rendered because MarkdownTableWithDetailsFormatter prevents rendering of children.