-
Notifications
You must be signed in to change notification settings - Fork 285
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/lucee/lucee-docs
- Loading branch information
Showing
210 changed files
with
1,054 additions
and
5,099 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
96 changes: 48 additions & 48 deletions
96
docs/03.reference/01.functions/datetimeformat/_arguments/mask.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,53 @@ | ||
| Date time formatting mask (case sensitive): | ||
|
|
||
| - a,..,aaaa: AM/PM marker (see also "t" and "tt"; Example:AM) | ||
| - d: Day in month, no leading zero for single-digit days (Example:3) | ||
| - dd: Day in month, leading zero for single-digit days (Example:03) | ||
| - D: Day in year, no leading zero for single-digit days (Example:4) | ||
| - DD: Day in year, leading zero for single-digit days (Example:04) | ||
| - DDD: Day in year, 2 leading zero for single-digit days (Example:004) | ||
| - E,EE,EEE: Day of week as a three-letter abbreviation (Example:Tue) | ||
| - EEEE: Day of week as its full name (Example:Tuesday) | ||
| - F: Day of week in month, no leading zero for single-digit days (Example:4) | ||
| - FF: Day of week in month, leading zero for single-digit days (Example:04) | ||
| - G,GG: Era designator (Example:AD) | ||
| - h: Hour in am/pm (1-12), no leading zero for single-digit hours (Example:3) | ||
| - hh: Hour in am/pm (1-12), leading zero for single-digit hours (Example:03) | ||
| - H: Hour in day (0-23), no leading zero for single-digit hours (Example:14) | ||
| - HH: Hour in day (00-23), leading zero for single-digit hours (Example:14) | ||
| - k: Hour in day (1-24), no leading zero for single-digit hours (Example:15) | ||
| - kk: Hour in day (1-24), leading zero for single-digit hours (Example:15) | ||
| - K: Hour in am/pm (0-11), no leading zero for single-digit hours (Example:2) | ||
| - KK: Hour in am/pm (0-11), leading zero for single-digit hours (Example:02) | ||
| - l,L: milliseconds, with no leading zeros (Example:3) | ||
| - ll,LL: milliseconds, leading zero for single-digit days (Example:03) | ||
| - lll,LLL: milliseconds, 2 leading zero for single-digit days (Example:003) | ||
| - m,M: Month as digits, no leading zero for single-digit months (Example:6) | ||
| - mm,MM: Month as digits, leading zero for single-digit months (Example:06) | ||
| - mmm,MMM: Month as a three-letter abbreviation (Example:Jun) | ||
| - mmmm,MMMM: Month as its full name (Example:June) | ||
| - n,N: minutes in hour, no leading zero for single-digit minutes (Example:3) | ||
| - nn,NN: minutes in hour, leading zero for single-digit minutes (Example:03) | ||
| - s,S: seconds in minute, no leading zero for single-digit seconds (Example:3) | ||
| - ss,SS: seconds in minute, leading zero for single-digit seconds (Example:03) | ||
| - t,T: one-character time marker string (Example:P) | ||
| - tt,TT: multiple-character time marker string (Example:PM) | ||
| - w: Week in year, no leading zero for single-digit hours (Example:27) | ||
| - ww: Week in year, leading zero for single-digit hours (Example:27) | ||
| - W: Week in month, no leading zero for single-digit hours (Example:2) | ||
| - WW: Week in month, leading zero for single-digit hours (Example:02) | ||
| - y,yy,yyy: Year as last two digits, leading zero for single-digit (Example:09) | ||
| - yyyy: Year represented by four digits (Example:2009) | ||
| - z,zz,zzz: General time zone as a 3 to 4 letter abbreviation (Example:PST) | ||
| - zzzz: General time zone as its full name (Example:Pacific Standard Time) | ||
| - Z,..,ZZZZ: RFC 822 time zone (Example:-0800) | ||
| - `a,..,aaaa`: AM/PM marker (see also "t" and "tt"; Example:AM) | ||
| - `d`: Day in month, no leading zero for single-digit days (Example:3) | ||
| - `dd`: Day in month, leading zero for single-digit days (Example:03) | ||
| - `D`: Day in year, no leading zero for single-digit days (Example:4) | ||
| - `DD`: Day in year, leading zero for single-digit days (Example:04) | ||
| - `DDD`: Day in year, 2 leading zero for single-digit days (Example:004) | ||
| - `E,EE,EEE`: Day of week as a three-letter abbreviation (Example:Tue) | ||
| - `EEEE`: Day of week as its full name (Example:Tuesday) | ||
| - `F`: Day of week in month, no leading zero for single-digit days (Example:4) | ||
| - `FF`: Day of week in month, leading zero for single-digit days (Example:04) | ||
| - `G,GG`: Era designator (Example:AD) | ||
| - `h`: Hour in am/pm (1-12), no leading zero for single-digit hours (Example:3) | ||
| - `hh`: Hour in am/pm (1-12), leading zero for single-digit hours (Example:03) | ||
| - `H`: Hour in day (0-23), no leading zero for single-digit hours (Example:14) | ||
| - `HH`: Hour in day (00-23), leading zero for single-digit hours (Example:14) | ||
| - `k`: Hour in day (1-24), no leading zero for single-digit hours (Example:15) | ||
| - `kk`: Hour in day (1-24), leading zero for single-digit hours (Example:15) | ||
| - `K`: Hour in am/pm (0-11), no leading zero for single-digit hours (Example:2) | ||
| - `KK`: Hour in am/pm (0-11), leading zero for single-digit hours (Example:02) | ||
| - `l,L`: milliseconds, with no leading zeros (Example:3) | ||
| - `ll,LL`: milliseconds, leading zero for single-digit days (Example:03) | ||
| - `lll,LLL`: milliseconds, 2 leading zero for single-digit days (Example:003) | ||
| - `m,M`: Month as digits, no leading zero for single-digit months (Example:6) | ||
| - `mm,MM`: Month as digits, leading zero for single-digit months (Example:06) | ||
| - `mmm,MMM`: Month as a three-letter abbreviation (Example:Jun) | ||
| - `mmmm,MMMM`: Month as its full name (Example:June) | ||
| - `n,N`: minutes in hour, no leading zero for single-digit minutes (Example:3) | ||
| - `nn,NN`: minutes in hour, leading zero for single-digit minutes (Example:03) | ||
| - `s,S`: seconds in minute, no leading zero for single-digit seconds (Example:3) | ||
| - `ss,SS`: seconds in minute, leading zero for single-digit seconds (Example:03) | ||
| - `t,T`: one-character time marker string (Example:P) | ||
| - `tt,TT`: multiple-character time marker string (Example:PM) | ||
| - `w`: Week in year, no leading zero for single-digit hours (Example:27) | ||
| - `ww`: Week in year, leading zero for single-digit hours (Example:27) | ||
| - `W`: Week in month, no leading zero for single-digit hours (Example:2) | ||
| - `WW`: Week in month, leading zero for single-digit hours (Example:02) | ||
| - `y,yy,yyy`: Year as last two digits, leading zero for single-digit (Example:09) | ||
| - `yyyy`: Year represented by four digits (Example:2009) | ||
| - `z,zz,zzz`: General time zone as a 3 to 4 letter abbreviation (Example:PST) | ||
| - `zzzz`: General time zone as its full name (Example:Pacific Standard Time) | ||
| - `Z,..,ZZZZ`: RFC 822 time zone (Example:-0800) | ||
|
|
||
| The following masks can be used to format the full date and time and may not be combined with other masks: | ||
|
|
||
| - short: equivalent to "m/d/y h:nn tt" | ||
| - medium: equivalent to "mmm d, yyyy h:nn:ss tt" | ||
| - long: medium followed by three-letter time zone; i.e. "mmmm d, yyyy h:nn:ss tt zzz" | ||
| - full: equivalent to "dddd, mmmm d, yyyy h:nn:ss tt zz" | ||
| - ISO8601/ISO: equivalent to "yyyy-mm-dd'T'HH:nn:ssXXX" | ||
| - epoch: Total seconds of a given date (Example:1567517664) (added in Lucee 6.0.0.83) | ||
| - epochms: Total milliseconds of a given date (Example:1567517664000) (added in Lucee 6.0.0.83) | ||
| - `short`: equivalent to "m/d/y h:nn tt" | ||
| - `medium`: equivalent to "mmm d, yyyy h:nn:ss tt" | ||
| - `long`: medium followed by three-letter time zone; i.e. "mmmm d, yyyy h:nn:ss tt zzz" | ||
| - `full`: equivalent to "dddd, mmmm d, yyyy h:nn:ss tt zz" | ||
| - `ISO8601/ISO`: equivalent to "yyyy-mm-dd'T'HH:nn:ssXXX" | ||
| - `epoch`: Total seconds of a given date (Example:1567517664) (added in Lucee 6.0.0.83) | ||
| - `epochms`: Total milliseconds of a given date (Example:1567517664000) (added in Lucee 6.0.0.83) |
8 changes: 5 additions & 3 deletions
8
docs/03.reference/01.functions/directorylist/_arguments/filter.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,6 @@ | ||
| Filter to be used to filter the results: | ||
| Specifies a filter to be used to filter the results: | ||
|
|
||
| * A string that uses "*" as a wildcard, for example, "*.cfm" | ||
| * a UDF (User defined Function) with signature `Boolean function(String path)`. The function is run for each file in turn; if the function returns `true`, then the file is will be added to the result; otherwise it will be omitted. | ||
| - A string that uses `*` as a wildcard, for example, `*.cfm` | ||
| - UDF (User Defined Function) using the following pattern: `boolean function(String path, String type, String ext)`. The function is run for every single file; if the function returns `true`, the file is included in the list; otherwise, it is omitted. `Type` is either `File` or `Directory` | ||
|
|
||
| `Type` and `Ext` arguments were added in Lucee 6.0 |
8 changes: 5 additions & 3 deletions
8
docs/03.reference/01.functions/directorylist/_arguments/listInfo.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| - name: returns an array of names of files and directories. | ||
| - path: returns an array of paths of files and directories. This is the default. | ||
| - query: returns a query. | ||
| Defines the return type of this function: | ||
|
|
||
| - `name`: returns an array of names of files and directories. | ||
| - `path`: returns an array of paths of files and directories. This is the default. | ||
| - `query`: returns a query object. |
2 changes: 1 addition & 1 deletion
2
docs/03.reference/01.functions/directorylist/_arguments/path.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| The absolute path of the directory to list the content from. | ||
|
|
||
| Alternatively, you can specify IP address as in the following example: DirectoryList(\"//12.3.123.123/c_drive/test\");. | ||
| This can be any type of supported [[virtual-file-system]] |
4 changes: 2 additions & 2 deletions
4
docs/03.reference/01.functions/directorylist/_arguments/recurse.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| Whether Lucee performs the action on sub-directories: | ||
| Specifies whether to include subdirectories in the listing. | ||
|
|
||
| If true, the contents of all sub-directories are also included. | ||
| If `true`, the content of all sub-directories is also included. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
docs/03.reference/01.functions/directorylist/_arguments/type.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| type of the result returned: | ||
|
|
||
| - file: includes only filenames | ||
| - dir: includes only directory names | ||
| - all: includes both filenames and directory names | ||
| - `file`: includes only filenames | ||
| - `dir`: includes only directory names | ||
| - `all`: includes both filenames and directory names |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1 @@ | ||
| For ACF compatibility, on Unix systems, the `mode` column is currently not populated | ||
|
|
||
| <https://luceeserver.atlassian.net/browse/LDEV-2118> | ||
| The Unix `mode` column was not populated prior to Lucee 6.1 |
1 change: 1 addition & 0 deletions
1
docs/03.reference/01.functions/ec2describeinstances/_arguments/accessKeyId.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Your AWS access key ID. Used for authentication with AWS services. This key must have appropriate permissions for EC2 describe instance operations. |
1 change: 1 addition & 0 deletions
1
docs/03.reference/01.functions/ec2describeinstances/_arguments/filters.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| A struct of filters to apply to the instance description request. Each key in the struct is a filter name, and its value is an array of filter values. |
1 change: 1 addition & 0 deletions
1
docs/03.reference/01.functions/ec2describeinstances/_arguments/host.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| The endpoint or the provider to connect to. If not set, Amazon AWS is used. This can be used to specify a different AWS region or a custom EC2-compatible endpoint. |
1 change: 1 addition & 0 deletions
1
docs/03.reference/01.functions/ec2describeinstances/_arguments/instanceIds.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| An array of instance IDs specifying the EC2 instances to describe. If not provided, information for all instances will be returned. |
1 change: 1 addition & 0 deletions
1
docs/03.reference/01.functions/ec2describeinstances/_arguments/location.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| The AWS region hosting the EC2 endpoint. If not specified, the default region associated with the provided credentials is used. |
1 change: 1 addition & 0 deletions
1
docs/03.reference/01.functions/ec2describeinstances/_arguments/secretAccessKey.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Your AWS secret access key associated with the access key ID. This key is used in conjunction with the accessKeyId for authentication. |
1 change: 1 addition & 0 deletions
1
docs/03.reference/01.functions/ec2describeinstances/_arguments/timeout.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| The timeout in milliseconds for the EC2 describe instances request. Defaults to 10000 milliseconds (10 seconds). |
Empty file.
Empty file.
11 changes: 11 additions & 0 deletions
11
docs/03.reference/01.functions/ec2describeinstances/function.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: EC2describeInstances | ||
| id: function-ec2describeinstances | ||
| categories: | ||
| - s3 | ||
| - server | ||
| --- | ||
|
|
||
| This function interfaces with the EC2 service to retrieve detailed information about specified EC2 instances. | ||
|
|
||
| It supports custom filtering, specific instance IDs, regional targeting, and legacy mode handling. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Variable to check |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| A string or a variable that contains one, with HTML to be parsed |
9 changes: 9 additions & 0 deletions
9
docs/03.reference/01.functions/logallthreads/_arguments/duration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| Total duration (in milliseconds) for which the function will collect thread data. | ||
|
|
||
| After this period, logging automatically stops. | ||
|
|
||
| Common durations: | ||
|
|
||
| - 1000-5000ms: Quick snapshots | ||
| - 10000ms: Standard analysis period | ||
| - 30000ms+: Extended analysis for complex operations |
8 changes: 8 additions & 0 deletions
8
docs/03.reference/01.functions/logallthreads/_arguments/interval.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| The time interval (in milliseconds) between stack trace captures. Lower values provide | ||
| more detailed analysis but generate larger log files and may impact performance. | ||
|
|
||
| Recommended ranges: | ||
|
|
||
| - 1-10ms: Very detailed analysis, higher overhead | ||
| - 10-100ms: Balanced detail and performance | ||
| - 100ms+: Lower detail, minimal performance impact |
5 changes: 5 additions & 0 deletions
5
docs/03.reference/01.functions/logallthreads/_arguments/path.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| Full file path where the log will be written. The file should have a `.jsonl` extension | ||
| for proper identification as a JSON Lines format file. The function will create the file | ||
| if it doesn't exist, or append to it if it does. | ||
|
|
||
| Example: `/var/log/lucee/thread_analysis.jsonl` |
Empty file.
Empty file.
Oops, something went wrong.