├── .gitignore
├── README.md
├── Signature.pq
├── book.json
├── doc2markdown.pq
├── docs
├── Accessing data
│ ├── Access
│ │ └── Access.Database.md
│ ├── ActiveDirectory
│ │ └── ActiveDirectory.Domains.md
│ ├── AdoDotNet
│ │ ├── AdoDotNet.DataSource.md
│ │ └── AdoDotNet.Query.md
│ ├── AdobeAnalytics
│ │ └── AdobeAnalytics.Cubes.md
│ ├── AmazonRedshift
│ │ └── AmazonRedshift.Database.md
│ ├── AnalysisServices
│ │ ├── AnalysisServices.Database.md
│ │ └── AnalysisServices.Databases.md
│ ├── ApacheSpark
│ │ └── ApacheSpark.Tables.md
│ ├── AzureEnterprise
│ │ ├── AzureEnterprise.Contents.md
│ │ └── AzureEnterprise.Tables.md
│ ├── AzureHiveLLAP
│ │ └── AzureHiveLLAP.Database.md
│ ├── AzureSpark
│ │ └── AzureSpark.Tables.md
│ ├── AzureStorage
│ │ ├── AzureStorage.BlobContents.md
│ │ ├── AzureStorage.Blobs.md
│ │ ├── AzureStorage.DataLakeContents.md
│ │ └── AzureStorage.Tables.md
│ ├── Cdm
│ │ └── Cdm.MapToEntity.md
│ ├── Cds
│ │ ├── Cds.Contents.md
│ │ └── Cds.Entities.md
│ ├── Csv
│ │ └── Csv.Document.md
│ ├── CustomerInsights
│ │ └── CustomerInsights.Tables.md
│ ├── DB2
│ │ └── DB2.Database.md
│ ├── DataLake
│ │ ├── DataLake.Contents.md
│ │ └── DataLake.Files.md
│ ├── DataWorld
│ │ ├── DataWorld.Contents.md
│ │ └── DataWorld.Dataset.md
│ ├── Denodo
│ │ └── Denodo.Contents.md
│ ├── DocumentDB
│ │ └── DocumentDB.Contents.md
│ ├── Dremio
│ │ └── Dremio.Databases.md
│ ├── Dynamics365BusinessCentral
│ │ └── Dynamics365BusinessCentral.Contents.md
│ ├── Dynamics365BusinessCentralOnPremises
│ │ └── Dynamics365BusinessCentralOnPremises.Contents.md
│ ├── Dynamics365Financials
│ │ └── Dynamics365Financials.Contents.md
│ ├── DynamicsNav
│ │ └── DynamicsNav.Contents.md
│ ├── Exasol
│ │ └── Exasol.Database.md
│ ├── Excel
│ │ ├── Excel.CurrentWorkbook.md
│ │ └── Excel.Workbook.md
│ ├── Exchange
│ │ └── Exchange.Contents.md
│ ├── Facebook
│ │ └── Facebook.Graph.md
│ ├── File
│ │ └── File.Contents.md
│ ├── Folder
│ │ ├── Folder.Contents.md
│ │ └── Folder.Files.md
│ ├── Github
│ │ ├── Github.Contents.md
│ │ ├── Github.PagedTable.md
│ │ └── Github.Tables.md
│ ├── GoogleAnalytics
│ │ └── GoogleAnalytics.Accounts.md
│ ├── GoogleBigQuery
│ │ └── GoogleBigQuery.Database.md
│ ├── HdInsight
│ │ ├── HdInsight.Containers.md
│ │ ├── HdInsight.Contents.md
│ │ └── HdInsight.Files.md
│ ├── Hdfs
│ │ ├── Hdfs.Contents.md
│ │ └── Hdfs.Files.md
│ ├── Impala
│ │ └── Impala.Database.md
│ ├── Informix
│ │ └── Informix.Database.md
│ ├── JethroODBC
│ │ └── JethroODBC.Database.md
│ ├── Json
│ │ └── Json.Document.md
│ ├── Kusto
│ │ ├── Kusto.Contents.md
│ │ └── Kusto.Databases.md
│ ├── Kyligence
│ │ └── Kyligence.Database.md
│ ├── MailChimp
│ │ ├── MailChimp.Collection.md
│ │ ├── MailChimp.Instance.md
│ │ ├── MailChimp.Tables.md
│ │ └── MailChimp.TablesV2.md
│ ├── Marketo
│ │ ├── Marketo.Activities.md
│ │ ├── Marketo.Leads.md
│ │ └── Marketo.Tables.md
│ ├── Marketplace
│ │ └── Marketplace.Subscriptions.md
│ ├── MicrosoftAzureConsumptionInsights
│ │ ├── MicrosoftAzureConsumptionInsights.Contents.md
│ │ ├── MicrosoftAzureConsumptionInsights.Tables.md
│ │ └── MicrosoftAzureConsumptionInsights.Test.md
│ ├── Mixpanel
│ │ ├── Mixpanel.Contents.md
│ │ ├── Mixpanel.Export.md
│ │ ├── Mixpanel.FunnelById.md
│ │ ├── Mixpanel.FunnelByName.md
│ │ ├── Mixpanel.Funnels.md
│ │ ├── Mixpanel.Segmentation.md
│ │ └── Mixpanel.Tables.md
│ ├── MySQL
│ │ └── MySQL.Database.md
│ ├── Netezza
│ │ └── Netezza.Database.md
│ ├── OData
│ │ └── OData.Feed.md
│ ├── Odbc
│ │ ├── Odbc.DataSource.md
│ │ ├── Odbc.InferOptions.md
│ │ └── Odbc.Query.md
│ ├── OleDb
│ │ ├── OleDb.DataSource.md
│ │ └── OleDb.Query.md
│ ├── Oracle
│ │ └── Oracle.Database.md
│ ├── Paxata
│ │ └── Paxata.Contents.md
│ ├── PlanviewEnterprise
│ │ ├── PlanviewEnterprise.CallQueryService.md
│ │ └── PlanviewEnterprise.Feed.md
│ ├── PostgreSQL
│ │ └── PostgreSQL.Database.md
│ ├── PowerBI
│ │ └── PowerBI.Dataflows.md
│ ├── Projectplace
│ │ └── Projectplace.Feed.md
│ ├── Python
│ │ └── Python.Execute.md
│ ├── QuickBooks
│ │ ├── QuickBooks.Query.md
│ │ ├── QuickBooks.Report.md
│ │ └── QuickBooks.Tables.md
│ ├── R
│ │ └── R.Execute.md
│ ├── RData
│ │ └── RData.FromBinary.md
│ ├── README.md
│ ├── Salesforce
│ │ ├── Salesforce.Data.md
│ │ └── Salesforce.Reports.md
│ ├── SapBusinessWarehouse
│ │ └── SapBusinessWarehouse.Cubes.md
│ ├── SapHana
│ │ └── SapHana.Database.md
│ ├── SharePoint
│ │ ├── SharePoint.Contents.md
│ │ ├── SharePoint.Files.md
│ │ └── SharePoint.Tables.md
│ ├── Smartsheet
│ │ ├── Smartsheet.Content.md
│ │ ├── Smartsheet.Query.md
│ │ └── Smartsheet.Tables.md
│ ├── Snowflake
│ │ └── Snowflake.Databases.md
│ ├── Soda
│ │ └── Soda.Feed.md
│ ├── Spark
│ │ └── Spark.Tables.md
│ ├── SparkPost
│ │ ├── SparkPost.GetContents.md
│ │ ├── SparkPost.GetMetrics.md
│ │ ├── SparkPost.Metrics.md
│ │ └── SparkPost.NavTable.md
│ ├── Sql
│ │ ├── Sql.Database.md
│ │ └── Sql.Databases.md
│ ├── Stripe
│ │ ├── Stripe.Contents.md
│ │ ├── Stripe.Method.md
│ │ └── Stripe.Tables.md
│ ├── SweetIQ
│ │ ├── SweetIQ.Contents.md
│ │ └── SweetIQ.Tables.md
│ ├── Sybase
│ │ └── Sybase.Database.md
│ ├── TeamDesk
│ │ ├── TeamDesk.Database.md
│ │ ├── TeamDesk.Select.md
│ │ └── TeamDesk.SelectView.md
│ ├── Teradata
│ │ └── Teradata.Database.md
│ ├── Troux
│ │ ├── Troux.CustomFeed.md
│ │ ├── Troux.Feed.md
│ │ └── Troux.TestConnection.md
│ ├── Twilio
│ │ ├── Twilio.Contents.md
│ │ ├── Twilio.Tables.md
│ │ └── Twilio.URL.md
│ ├── VSTS
│ │ ├── VSTS.AccountContents.md
│ │ ├── VSTS.AnalyticsViews.md
│ │ ├── VSTS.Contents.md
│ │ ├── VSTS.Feed.md
│ │ └── VSTS.Views.md
│ ├── Vertica
│ │ └── Vertica.Database.md
│ ├── Web
│ │ ├── Web.Contents.md
│ │ └── Web.Page.md
│ ├── Webtrends
│ │ ├── Webtrends.KeyMetrics.md
│ │ ├── Webtrends.Profile.md
│ │ ├── Webtrends.ReportContents.md
│ │ └── Webtrends.Tables.md
│ ├── Xml
│ │ ├── Xml.Document.md
│ │ └── Xml.Tables.md
│ ├── Zendesk
│ │ ├── Zendesk.Collection.md
│ │ └── Zendesk.Tables.md
│ ├── appFigures
│ │ ├── appFigures.Content.md
│ │ └── appFigures.Tables.md
│ ├── comScore
│ │ ├── comScore.GetReport.md
│ │ ├── comScore.NavTable.md
│ │ └── comScore.ReportItems.md
│ └── tyGraph
│ │ ├── tyGraph.Feed.md
│ │ └── tyGraph.NavTable.md
├── Action
│ └── WebAction.Request.md
├── Binary Formats
│ ├── BinaryFormat.7BitEncodedSignedInteger.md
│ ├── BinaryFormat.7BitEncodedUnsignedInteger.md
│ ├── BinaryFormat.Binary.md
│ ├── BinaryFormat.Byte.md
│ ├── BinaryFormat.ByteOrder.md
│ ├── BinaryFormat.Choice.md
│ ├── BinaryFormat.Decimal.md
│ ├── BinaryFormat.Double.md
│ ├── BinaryFormat.Group.md
│ ├── BinaryFormat.Length.md
│ ├── BinaryFormat.List.md
│ ├── BinaryFormat.Null.md
│ ├── BinaryFormat.Record.md
│ ├── BinaryFormat.SignedInteger16.md
│ ├── BinaryFormat.SignedInteger32.md
│ ├── BinaryFormat.SignedInteger64.md
│ ├── BinaryFormat.Single.md
│ ├── BinaryFormat.Text.md
│ ├── BinaryFormat.Transform.md
│ ├── BinaryFormat.UnsignedInteger16.md
│ ├── BinaryFormat.UnsignedInteger32.md
│ ├── BinaryFormat.UnsignedInteger64.md
│ └── Table.PartitionValues.md
├── Binary
│ ├── Binary.Buffer.md
│ ├── Binary.Combine.md
│ ├── Binary.Compress.md
│ ├── Binary.Decompress.md
│ ├── Binary.From.md
│ ├── Binary.FromList.md
│ ├── Binary.FromText.md
│ ├── Binary.InferContentType.md
│ ├── Binary.Length.md
│ ├── Binary.ToList.md
│ └── Binary.ToText.md
├── Combiner
│ ├── Combiner.CombineTextByDelimiter.md
│ ├── Combiner.CombineTextByEachDelimiter.md
│ ├── Combiner.CombineTextByLengths.md
│ ├── Combiner.CombineTextByPositions.md
│ └── Combiner.CombineTextByRanges.md
├── Comparer
│ ├── Comparer.Equals.md
│ ├── Comparer.FromCulture.md
│ ├── Comparer.Ordinal.md
│ └── Comparer.OrdinalIgnoreCase.md
├── Cube
│ ├── Cube.AddAndExpandDimensionColumn.md
│ ├── Cube.AddMeasureColumn.md
│ ├── Cube.ApplyParameter.md
│ ├── Cube.AttributeMemberId.md
│ ├── Cube.AttributeMemberProperty.md
│ ├── Cube.CollapseAndRemoveColumns.md
│ ├── Cube.Dimensions.md
│ ├── Cube.DisplayFolders.md
│ ├── Cube.MeasureProperties.md
│ ├── Cube.MeasureProperty.md
│ ├── Cube.Measures.md
│ ├── Cube.Parameters.md
│ ├── Cube.Properties.md
│ ├── Cube.PropertyKey.md
│ ├── Cube.ReplaceDimensions.md
│ └── Cube.Transform.md
├── Date
│ ├── Date.AddDays.md
│ ├── Date.AddMonths.md
│ ├── Date.AddQuarters.md
│ ├── Date.AddWeeks.md
│ ├── Date.AddYears.md
│ ├── Date.Day.md
│ ├── Date.DayOfWeek.md
│ ├── Date.DayOfWeekName.md
│ ├── Date.DayOfYear.md
│ ├── Date.DaysInMonth.md
│ ├── Date.EndOfDay.md
│ ├── Date.EndOfMonth.md
│ ├── Date.EndOfQuarter.md
│ ├── Date.EndOfWeek.md
│ ├── Date.EndOfYear.md
│ ├── Date.From.md
│ ├── Date.FromText.md
│ ├── Date.IsInCurrentDay.md
│ ├── Date.IsInCurrentMonth.md
│ ├── Date.IsInCurrentQuarter.md
│ ├── Date.IsInCurrentWeek.md
│ ├── Date.IsInCurrentYear.md
│ ├── Date.IsInNextDay.md
│ ├── Date.IsInNextMonth.md
│ ├── Date.IsInNextNDays.md
│ ├── Date.IsInNextNMonths.md
│ ├── Date.IsInNextNQuarters.md
│ ├── Date.IsInNextNWeeks.md
│ ├── Date.IsInNextNYears.md
│ ├── Date.IsInNextQuarter.md
│ ├── Date.IsInNextWeek.md
│ ├── Date.IsInNextYear.md
│ ├── Date.IsInPreviousDay.md
│ ├── Date.IsInPreviousMonth.md
│ ├── Date.IsInPreviousNDays.md
│ ├── Date.IsInPreviousNMonths.md
│ ├── Date.IsInPreviousNQuarters.md
│ ├── Date.IsInPreviousNWeeks.md
│ ├── Date.IsInPreviousNYears.md
│ ├── Date.IsInPreviousQuarter.md
│ ├── Date.IsInPreviousWeek.md
│ ├── Date.IsInPreviousYear.md
│ ├── Date.IsInYearToDate.md
│ ├── Date.IsLeapYear.md
│ ├── Date.Month.md
│ ├── Date.MonthName.md
│ ├── Date.QuarterOfYear.md
│ ├── Date.StartOfDay.md
│ ├── Date.StartOfMonth.md
│ ├── Date.StartOfQuarter.md
│ ├── Date.StartOfWeek.md
│ ├── Date.StartOfYear.md
│ ├── Date.ToRecord.md
│ ├── Date.ToText.md
│ ├── Date.WeekOfMonth.md
│ ├── Date.WeekOfYear.md
│ ├── Date.Year.md
│ ├── Time.EndOfHour.md
│ └── Time.StartOfHour.md
├── DateTime
│ ├── DateTime.AddZone.md
│ ├── DateTime.Date.md
│ ├── DateTime.FixedLocalNow.md
│ ├── DateTime.From.md
│ ├── DateTime.FromFileTime.md
│ ├── DateTime.FromText.md
│ ├── DateTime.IsInCurrentHour.md
│ ├── DateTime.IsInCurrentMinute.md
│ ├── DateTime.IsInCurrentSecond.md
│ ├── DateTime.IsInNextHour.md
│ ├── DateTime.IsInNextMinute.md
│ ├── DateTime.IsInNextNHours.md
│ ├── DateTime.IsInNextNMinutes.md
│ ├── DateTime.IsInNextNSeconds.md
│ ├── DateTime.IsInNextSecond.md
│ ├── DateTime.IsInPreviousHour.md
│ ├── DateTime.IsInPreviousMinute.md
│ ├── DateTime.IsInPreviousNHours.md
│ ├── DateTime.IsInPreviousNMinutes.md
│ ├── DateTime.IsInPreviousNSeconds.md
│ ├── DateTime.IsInPreviousSecond.md
│ ├── DateTime.LocalNow.md
│ ├── DateTime.Time.md
│ ├── DateTime.ToRecord.md
│ └── DateTime.ToText.md
├── DateTimeZone
│ ├── DateTimeZone.FixedLocalNow.md
│ ├── DateTimeZone.FixedUtcNow.md
│ ├── DateTimeZone.From.md
│ ├── DateTimeZone.FromFileTime.md
│ ├── DateTimeZone.FromText.md
│ ├── DateTimeZone.LocalNow.md
│ ├── DateTimeZone.RemoveZone.md
│ ├── DateTimeZone.SwitchZone.md
│ ├── DateTimeZone.ToLocal.md
│ ├── DateTimeZone.ToRecord.md
│ ├── DateTimeZone.ToText.md
│ ├── DateTimeZone.ToUtc.md
│ ├── DateTimeZone.UtcNow.md
│ ├── DateTimeZone.ZoneHours.md
│ └── DateTimeZone.ZoneMinutes.md
├── Diagnostics
│ ├── Diagnostics.ActivityId.md
│ └── Diagnostics.Trace.md
├── Duration
│ ├── Duration.Days.md
│ ├── Duration.From.md
│ ├── Duration.FromText.md
│ ├── Duration.Hours.md
│ ├── Duration.Minutes.md
│ ├── Duration.Seconds.md
│ ├── Duration.ToRecord.md
│ ├── Duration.ToText.md
│ ├── Duration.TotalDays.md
│ ├── Duration.TotalHours.md
│ ├── Duration.TotalMinutes.md
│ └── Duration.TotalSeconds.md
├── Error
│ └── Error.Record.md
├── Expression
│ ├── Expression.Constant.md
│ ├── Expression.Evaluate.md
│ └── Expression.Identifier.md
├── Function
│ ├── Function.From.md
│ ├── Function.Invoke.md
│ ├── Function.InvokeAfter.md
│ └── Function.ScalarVector.md
├── Lines
│ ├── Lines.FromBinary.md
│ ├── Lines.FromText.md
│ ├── Lines.ToBinary.md
│ └── Lines.ToText.md
├── List
│ ├── List.Accumulate.md
│ ├── List.AllTrue.md
│ ├── List.Alternate.md
│ ├── List.AnyTrue.md
│ ├── List.Average.md
│ ├── List.Buffer.md
│ ├── List.Combine.md
│ ├── List.Contains.md
│ ├── List.ContainsAll.md
│ ├── List.ContainsAny.md
│ ├── List.Count.md
│ ├── List.Covariance.md
│ ├── List.DateTimeZones.md
│ ├── List.DateTimes.md
│ ├── List.Dates.md
│ ├── List.Difference.md
│ ├── List.Distinct.md
│ ├── List.Durations.md
│ ├── List.FindText.md
│ ├── List.First.md
│ ├── List.FirstN.md
│ ├── List.Generate.md
│ ├── List.InsertRange.md
│ ├── List.Intersect.md
│ ├── List.IsDistinct.md
│ ├── List.IsEmpty.md
│ ├── List.Last.md
│ ├── List.LastN.md
│ ├── List.MatchesAll.md
│ ├── List.MatchesAny.md
│ ├── List.Max.md
│ ├── List.MaxN.md
│ ├── List.Median.md
│ ├── List.Min.md
│ ├── List.MinN.md
│ ├── List.Mode.md
│ ├── List.Modes.md
│ ├── List.NonNullCount.md
│ ├── List.Numbers.md
│ ├── List.PositionOf.md
│ ├── List.PositionOfAny.md
│ ├── List.Positions.md
│ ├── List.Product.md
│ ├── List.Random.md
│ ├── List.Range.md
│ ├── List.RemoveFirstN.md
│ ├── List.RemoveItems.md
│ ├── List.RemoveLastN.md
│ ├── List.RemoveMatchingItems.md
│ ├── List.RemoveNulls.md
│ ├── List.RemoveRange.md
│ ├── List.Repeat.md
│ ├── List.ReplaceMatchingItems.md
│ ├── List.ReplaceRange.md
│ ├── List.ReplaceValue.md
│ ├── List.Reverse.md
│ ├── List.Select.md
│ ├── List.Single.md
│ ├── List.SingleOrDefault.md
│ ├── List.Skip.md
│ ├── List.Sort.md
│ ├── List.Split.md
│ ├── List.StandardDeviation.md
│ ├── List.Sum.md
│ ├── List.Times.md
│ ├── List.Transform.md
│ ├── List.TransformMany.md
│ ├── List.Union.md
│ └── List.Zip.md
├── Logical
│ ├── Logical.From.md
│ ├── Logical.FromText.md
│ └── Logical.ToText.md
├── Metadata
│ ├── Value.Metadata.md
│ ├── Value.RemoveMetadata.md
│ └── Value.ReplaceMetadata.md
├── Number
│ ├── Byte.From.md
│ ├── Currency.From.md
│ ├── Decimal.From.md
│ ├── Double.From.md
│ ├── Int16.From.md
│ ├── Int32.From.md
│ ├── Int64.From.md
│ ├── Int8.From.md
│ ├── Number.Abs.md
│ ├── Number.Acos.md
│ ├── Number.Asin.md
│ ├── Number.Atan.md
│ ├── Number.Atan2.md
│ ├── Number.BitwiseAnd.md
│ ├── Number.BitwiseNot.md
│ ├── Number.BitwiseOr.md
│ ├── Number.BitwiseShiftLeft.md
│ ├── Number.BitwiseShiftRight.md
│ ├── Number.BitwiseXor.md
│ ├── Number.Combinations.md
│ ├── Number.Cos.md
│ ├── Number.Cosh.md
│ ├── Number.Exp.md
│ ├── Number.Factorial.md
│ ├── Number.From.md
│ ├── Number.FromText.md
│ ├── Number.IntegerDivide.md
│ ├── Number.IsEven.md
│ ├── Number.IsNaN.md
│ ├── Number.IsOdd.md
│ ├── Number.Ln.md
│ ├── Number.Log.md
│ ├── Number.Log10.md
│ ├── Number.Mod.md
│ ├── Number.Permutations.md
│ ├── Number.Power.md
│ ├── Number.Random.md
│ ├── Number.RandomBetween.md
│ ├── Number.Round.md
│ ├── Number.RoundAwayFromZero.md
│ ├── Number.RoundDown.md
│ ├── Number.RoundTowardZero.md
│ ├── Number.RoundUp.md
│ ├── Number.Sign.md
│ ├── Number.Sin.md
│ ├── Number.Sinh.md
│ ├── Number.Sqrt.md
│ ├── Number.Tan.md
│ ├── Number.Tanh.md
│ ├── Number.ToText.md
│ ├── Percentage.From.md
│ └── Single.From.md
├── README.md
├── Record
│ ├── Record.AddField.md
│ ├── Record.Combine.md
│ ├── Record.Field.md
│ ├── Record.FieldCount.md
│ ├── Record.FieldNames.md
│ ├── Record.FieldOrDefault.md
│ ├── Record.FieldValues.md
│ ├── Record.FromList.md
│ ├── Record.FromTable.md
│ ├── Record.HasFields.md
│ ├── Record.RemoveFields.md
│ ├── Record.RenameFields.md
│ ├── Record.ReorderFields.md
│ ├── Record.SelectFields.md
│ ├── Record.ToList.md
│ ├── Record.ToTable.md
│ └── Record.TransformFields.md
├── Replacer
│ ├── Replacer.ReplaceText.md
│ └── Replacer.ReplaceValue.md
├── SUMMARY.md
├── Splitter
│ ├── Splitter.SplitByNothing.md
│ ├── Splitter.SplitTextByAnyDelimiter.md
│ ├── Splitter.SplitTextByDelimiter.md
│ ├── Splitter.SplitTextByEachDelimiter.md
│ ├── Splitter.SplitTextByLengths.md
│ ├── Splitter.SplitTextByPositions.md
│ ├── Splitter.SplitTextByRanges.md
│ ├── Splitter.SplitTextByRepeatedLengths.md
│ └── Splitter.SplitTextByWhitespace.md
├── Table
│ ├── ItemExpression.From.md
│ ├── RowExpression.Column.md
│ ├── RowExpression.From.md
│ ├── Table.AddColumn.md
│ ├── Table.AddIndexColumn.md
│ ├── Table.AddJoinColumn.md
│ ├── Table.AddKey.md
│ ├── Table.AggregateTableColumn.md
│ ├── Table.AlternateRows.md
│ ├── Table.Buffer.md
│ ├── Table.Column.md
│ ├── Table.ColumnCount.md
│ ├── Table.ColumnNames.md
│ ├── Table.ColumnsOfType.md
│ ├── Table.Combine.md
│ ├── Table.CombineColumns.md
│ ├── Table.Contains.md
│ ├── Table.ContainsAll.md
│ ├── Table.ContainsAny.md
│ ├── Table.DemoteHeaders.md
│ ├── Table.Distinct.md
│ ├── Table.DuplicateColumn.md
│ ├── Table.ExpandListColumn.md
│ ├── Table.ExpandRecordColumn.md
│ ├── Table.ExpandTableColumn.md
│ ├── Table.FillDown.md
│ ├── Table.FillUp.md
│ ├── Table.FilterWithDataTable.md
│ ├── Table.FindText.md
│ ├── Table.First.md
│ ├── Table.FirstN.md
│ ├── Table.FirstValue.md
│ ├── Table.FromColumns.md
│ ├── Table.FromList.md
│ ├── Table.FromPartitions.md
│ ├── Table.FromRecords.md
│ ├── Table.FromRows.md
│ ├── Table.FromValue.md
│ ├── Table.FuzzyJoin.md
│ ├── Table.FuzzyNestedJoin.md
│ ├── Table.Group.md
│ ├── Table.HasColumns.md
│ ├── Table.InsertRows.md
│ ├── Table.IsDistinct.md
│ ├── Table.IsEmpty.md
│ ├── Table.Join.md
│ ├── Table.Keys.md
│ ├── Table.Last.md
│ ├── Table.LastN.md
│ ├── Table.MatchesAllRows.md
│ ├── Table.MatchesAnyRows.md
│ ├── Table.Max.md
│ ├── Table.MaxN.md
│ ├── Table.Min.md
│ ├── Table.MinN.md
│ ├── Table.NestedJoin.md
│ ├── Table.Partition.md
│ ├── Table.Pivot.md
│ ├── Table.PositionOf.md
│ ├── Table.PositionOfAny.md
│ ├── Table.PrefixColumns.md
│ ├── Table.Profile.md
│ ├── Table.PromoteHeaders.md
│ ├── Table.Range.md
│ ├── Table.RemoveColumns.md
│ ├── Table.RemoveFirstN.md
│ ├── Table.RemoveLastN.md
│ ├── Table.RemoveMatchingRows.md
│ ├── Table.RemoveRows.md
│ ├── Table.RemoveRowsWithErrors.md
│ ├── Table.RenameColumns.md
│ ├── Table.ReorderColumns.md
│ ├── Table.Repeat.md
│ ├── Table.ReplaceErrorValues.md
│ ├── Table.ReplaceKeys.md
│ ├── Table.ReplaceMatchingRows.md
│ ├── Table.ReplaceRelationshipIdentity.md
│ ├── Table.ReplaceRows.md
│ ├── Table.ReplaceValue.md
│ ├── Table.ReverseRows.md
│ ├── Table.RowCount.md
│ ├── Table.Schema.md
│ ├── Table.SelectColumns.md
│ ├── Table.SelectRows.md
│ ├── Table.SelectRowsWithErrors.md
│ ├── Table.SingleRow.md
│ ├── Table.Skip.md
│ ├── Table.Sort.md
│ ├── Table.Split.md
│ ├── Table.SplitColumn.md
│ ├── Table.ToColumns.md
│ ├── Table.ToList.md
│ ├── Table.ToRecords.md
│ ├── Table.ToRows.md
│ ├── Table.TransformColumnNames.md
│ ├── Table.TransformColumnTypes.md
│ ├── Table.TransformColumns.md
│ ├── Table.TransformRows.md
│ ├── Table.Transpose.md
│ ├── Table.Unpivot.md
│ ├── Table.UnpivotOtherColumns.md
│ ├── Table.View.md
│ ├── Table.ViewFunction.md
│ └── Tables.GetRelationships.md
├── Text
│ ├── Character.FromNumber.md
│ ├── Character.ToNumber.md
│ ├── Guid.From.md
│ ├── Json.FromValue.md
│ ├── Text.AfterDelimiter.md
│ ├── Text.At.md
│ ├── Text.BeforeDelimiter.md
│ ├── Text.BetweenDelimiters.md
│ ├── Text.Clean.md
│ ├── Text.Combine.md
│ ├── Text.Contains.md
│ ├── Text.End.md
│ ├── Text.EndsWith.md
│ ├── Text.Format.md
│ ├── Text.From.md
│ ├── Text.FromBinary.md
│ ├── Text.Insert.md
│ ├── Text.Length.md
│ ├── Text.Lower.md
│ ├── Text.Middle.md
│ ├── Text.NewGuid.md
│ ├── Text.PadEnd.md
│ ├── Text.PadStart.md
│ ├── Text.PositionOf.md
│ ├── Text.PositionOfAny.md
│ ├── Text.Proper.md
│ ├── Text.Range.md
│ ├── Text.Remove.md
│ ├── Text.RemoveRange.md
│ ├── Text.Repeat.md
│ ├── Text.Replace.md
│ ├── Text.ReplaceRange.md
│ ├── Text.Reverse.md
│ ├── Text.Select.md
│ ├── Text.Split.md
│ ├── Text.SplitAny.md
│ ├── Text.Start.md
│ ├── Text.StartsWith.md
│ ├── Text.ToBinary.md
│ ├── Text.ToList.md
│ ├── Text.Trim.md
│ ├── Text.TrimEnd.md
│ ├── Text.TrimStart.md
│ ├── Text.Upper.md
│ └── Value.FromText.md
├── Time
│ ├── Time.From.md
│ ├── Time.FromText.md
│ ├── Time.Hour.md
│ ├── Time.Minute.md
│ ├── Time.Second.md
│ ├── Time.ToRecord.md
│ └── Time.ToText.md
├── Type
│ ├── Function.IsDataSource.md
│ ├── Type.AddTableKey.md
│ ├── Type.ClosedRecord.md
│ ├── Type.Facets.md
│ ├── Type.ForFunction.md
│ ├── Type.ForRecord.md
│ ├── Type.FunctionParameters.md
│ ├── Type.FunctionRequiredParameters.md
│ ├── Type.FunctionReturn.md
│ ├── Type.Is.md
│ ├── Type.IsNullable.md
│ ├── Type.IsOpenRecord.md
│ ├── Type.ListItem.md
│ ├── Type.NonNullable.md
│ ├── Type.OpenRecord.md
│ ├── Type.RecordFields.md
│ ├── Type.ReplaceFacets.md
│ ├── Type.ReplaceTableKeys.md
│ ├── Type.TableColumn.md
│ ├── Type.TableKeys.md
│ ├── Type.TableRow.md
│ ├── Type.TableSchema.md
│ └── Type.Union.md
├── Uri
│ ├── Uri.BuildQueryString.md
│ ├── Uri.Combine.md
│ ├── Uri.EscapeDataString.md
│ └── Uri.Parts.md
└── Values
│ ├── DirectQueryCapabilities.From.md
│ ├── Embedded.Value.md
│ ├── Html.Table.md
│ ├── Pdf.Tables.md
│ ├── Resource.Access.md
│ ├── SqlExpression.SchemaFrom.md
│ ├── SqlExpression.ToExpression.md
│ ├── Value.Add.md
│ ├── Value.As.md
│ ├── Value.Compare.md
│ ├── Value.Divide.md
│ ├── Value.Equals.md
│ ├── Value.Firewall.md
│ ├── Value.Is.md
│ ├── Value.Multiply.md
│ ├── Value.NativeQuery.md
│ ├── Value.NullableEquals.md
│ ├── Value.ReplaceType.md
│ ├── Value.ResourceExpression.md
│ ├── Value.Subtract.md
│ ├── Value.Type.md
│ ├── Variable.Value.md
│ └── Web.BrowserContents.md
├── dox.pbix
├── dox.pq
├── dox.ps1
├── node_modules
├── balanced-match
│ ├── .npmignore
│ ├── LICENSE.md
│ ├── README.md
│ ├── index.js
│ └── package.json
├── brace-expansion
│ ├── LICENSE
│ ├── README.md
│ ├── index.js
│ └── package.json
├── concat-map
│ ├── .travis.yml
│ ├── LICENSE
│ ├── README.markdown
│ ├── example
│ │ └── map.js
│ ├── index.js
│ ├── package.json
│ └── test
│ │ └── map.js
├── fs.realpath
│ ├── LICENSE
│ ├── README.md
│ ├── index.js
│ ├── old.js
│ └── package.json
├── gitbook-plugin-summary
│ ├── LICENSE
│ ├── README.md
│ ├── index.js
│ └── package.json
├── glob
│ ├── LICENSE
│ ├── README.md
│ ├── changelog.md
│ ├── common.js
│ ├── glob.js
│ ├── package.json
│ └── sync.js
├── inflight
│ ├── LICENSE
│ ├── README.md
│ ├── inflight.js
│ └── package.json
├── inherits
│ ├── LICENSE
│ ├── README.md
│ ├── inherits.js
│ ├── inherits_browser.js
│ └── package.json
├── markdown-parser
│ ├── .npmignore
│ ├── .travis.yml
│ ├── Gruntfile.js
│ ├── MIT-LICENSE.txt
│ ├── README.md
│ ├── package.json
│ ├── src
│ │ ├── markdown-grammar.pegjs
│ │ ├── markdown-parser.js
│ │ ├── parser-browser.js
│ │ └── parser.js
│ └── test
│ │ └── main.js
├── minimatch
│ ├── LICENSE
│ ├── README.md
│ ├── minimatch.js
│ └── package.json
├── once
│ ├── LICENSE
│ ├── README.md
│ ├── once.js
│ └── package.json
├── path-is-absolute
│ ├── index.js
│ ├── license
│ ├── package.json
│ └── readme.md
└── wrappy
│ ├── LICENSE
│ ├── README.md
│ ├── package.json
│ └── wrappy.js
└── package-lock.json
/.gitignore:
--------------------------------------------------------------------------------
1 |
2 | _book
3 | node_modules
--------------------------------------------------------------------------------
/book.json:
--------------------------------------------------------------------------------
1 | {
2 | "plugins": [ "theme-api","collapsible-chapters","disqus"],
3 | "root": "./docs",
4 | "structure": {
5 | "readme": "README.md",
6 | "summary": "SUMMARY.md"
7 | },
8 | "pluginsConfig": {
9 | "theme-api": {
10 | "languages": [
11 | {
12 | "lang": "js",
13 | "name": "JavaScript",
14 | "default": true
15 | },
16 | {
17 | "lang": "go",
18 | "name": "Go"
19 | }
20 | ]
21 | },
22 | "disqus":{
23 | "shortName": "powerquery"
24 | }
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/docs/Accessing data/ActiveDirectory/ActiveDirectory.Domains.md:
--------------------------------------------------------------------------------
1 | # ActiveDirectory.Domains
2 | Returns a list of Active Directory domains in the same forest as the specified domain or of the current machine's domain if none is specified.
3 | > _function (optional forestRootDomainName
as nullable any) as table_
4 |
5 | # Description
6 | Returns a list of Active Directory domains in the same forest as the specified domain or of the current machine's domain if none is specified.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/AmazonRedshift/AmazonRedshift.Database.md:
--------------------------------------------------------------------------------
1 | # AmazonRedshift.Database
2 | Import data from an Amazon Redshift database.
3 | > _function (server
as text, database
as text, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Returns a table listing the tables on the Amazon Redshift cluster server
in the database database
.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/ApacheSpark/ApacheSpark.Tables.md:
--------------------------------------------------------------------------------
1 | # ApacheSpark.Tables
2 | Returns a table listing the tables on the specified Spark cluster.
3 | > _function (server
as text, protocol
as number) as table_
4 |
5 | # Description
6 | Returns a table listing the tables on the Spark cluster host
using protocol
. Valid protocols are:
7 | SparkProtocol.Standard, SparkProtocol.HTTP
8 | # Category
9 | Accessing data
10 |
--------------------------------------------------------------------------------
/docs/Accessing data/AzureEnterprise/AzureEnterprise.Tables.md:
--------------------------------------------------------------------------------
1 | # AzureEnterprise.Tables
2 | Enter the URL of the Azure Enterprise REST API endpoint associated with your enrollment
3 | > _function (url
as text) as table_
4 |
5 | # Description
6 | Returns a list of reports and months available from the Azure Enterprise API
7 | # Category
8 | Accessing data
9 | # Examples
10 | Using the AzureEnterprise.Tables function and navigate to a particular value to obtain the results.
11 | ```
12 | let
13 | Source = AzureEnterprise.Tables("http://ea.azure.com/rest/12345"),
14 | Contents = Source{[Key="Contents"]}[Data]
15 | in
16 | Contents
17 | ```
18 | > Table
19 |
20 | ***
21 |
--------------------------------------------------------------------------------
/docs/Accessing data/AzureSpark/AzureSpark.Tables.md:
--------------------------------------------------------------------------------
1 | # AzureSpark.Tables
2 | List the tables in an Azure Spark instance.
3 | > _function (server
as text) as table_
4 |
5 | # Description
6 | List the tables in an Azure Spark instance.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/AzureStorage/AzureStorage.BlobContents.md:
--------------------------------------------------------------------------------
1 | # AzureStorage.BlobContents
2 | Returns the content of the specified blob from an Azure storage vault.
3 | > _function (url
as text, optional options
as nullable record) as binary_
4 |
5 | # Description
6 | Returns the content of the blob at the URL, url
, from an Azure storage vault.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/AzureStorage/AzureStorage.Blobs.md:
--------------------------------------------------------------------------------
1 | # AzureStorage.Blobs
2 | Returns a navigational table containing the containers found in the specified account from an Azure storage vault.
3 | > _function (account
as text, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Returns a navigational table containing a row for each container found at the account URL, account
, from an Azure storage vault. Each row contains a link to the container blobs.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/AzureStorage/AzureStorage.DataLakeContents.md:
--------------------------------------------------------------------------------
1 | # AzureStorage.DataLakeContents
2 | Returns the content of the specified file from an Azure Data Lake Storage filesystem.
3 | > _function (url
as text, optional options
as nullable record) as binary_
4 |
5 | # Description
6 | Returns the content of the file at the URL, url
, from an Azure Data Lake Storage filesystem.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/AzureStorage/AzureStorage.Tables.md:
--------------------------------------------------------------------------------
1 | # AzureStorage.Tables
2 | Returns a navigational table containing the tables found in the specified account from an Azure storage vault.
3 | > _function (account
as text) as table_
4 |
5 | # Description
6 | Returns a navigational table containing a row for each table found at the account URL, account
, from an Azure storage vault. Each row contains a link to the azure table.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Cdm/Cdm.MapToEntity.md:
--------------------------------------------------------------------------------
1 | # Cdm.MapToEntity
2 | Returns a table with columns mapped to the attributes of an entity in the Common Data Model, including data types.
3 | > _function (table
as table, optional columnDefinitions
as nullable any, optional defaultType
as nullable any, optional defaultCdmClass
as nullable any) as table_
4 |
5 | # Description
6 | Returns a table with columns mapped to the attributes of an entity in the Common Data Model, including data types. Columns from the entity definition will be added if not mapped, and any unmapped columns will be removed.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Cds/Cds.Contents.md:
--------------------------------------------------------------------------------
1 | # Cds.Contents
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Cds/Cds.Entities.md:
--------------------------------------------------------------------------------
1 | # Cds.Entities
2 |
3 | > _function (url
as text, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Connect to your Common Data Service for Apps data (Dynamics 365 and PowerApps).
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/CustomerInsights/CustomerInsights.Tables.md:
--------------------------------------------------------------------------------
1 | # CustomerInsights.Tables
2 | Enter the URL for your Customer Insights account
3 | > _function (url
as text) as table_
4 |
5 | # Description
6 | Dynamics 365 for Customer Insights
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/DataLake/DataLake.Contents.md:
--------------------------------------------------------------------------------
1 | # DataLake.Contents
2 | Enter the URL of your Azure Data Lake Storage account.
3 | > _function (url
as text, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Returns a table containing a row for each folder and file found at url
from Azure Data Lake Storage. Each row contains properties of the folder or file and a link to its content.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/DataLake/DataLake.Files.md:
--------------------------------------------------------------------------------
1 | # DataLake.Files
2 | Enter the URL of your Azure Data Lake Storage account.
3 | > _function (url
as text, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Returns a table containing a row for each file found at url
, from Azure Data Lake Storage. Each row contains properties of the file and a link to its content.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/DataWorld/DataWorld.Contents.md:
--------------------------------------------------------------------------------
1 | # DataWorld.Contents
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/DataWorld/DataWorld.Dataset.md:
--------------------------------------------------------------------------------
1 | # DataWorld.Dataset
2 |
3 | > _function (owner
as text, id
as text, optional query
as nullable any) as table_
4 |
5 | # Description
6 | Retrieves a dataset from Data.World
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Denodo/Denodo.Contents.md:
--------------------------------------------------------------------------------
1 | # Denodo.Contents
2 |
3 | > _function (DSN
as text, optional debug
as nullable any) as table_
4 |
5 | # Description
6 | The Denodo Connector allows you to connect to Denodo's VDP server from PowerBI
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/DocumentDB/DocumentDB.Contents.md:
--------------------------------------------------------------------------------
1 | # DocumentDB.Contents
2 | Enter the URL of an Azure Cosmos DB account.
3 | > _function (url
as text, optional database
as nullable any, optional collection
as nullable any, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Returns a table of Azure Cosmos DB databases at url
. If database
is specified, a table of collections will be returned instead. Additionally, if the field Query
is specified in the options
record the results of the query being executed on either the specified database and/or collection will be returned.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Dremio/Dremio.Databases.md:
--------------------------------------------------------------------------------
1 | # Dremio.Databases
2 | The Self-Service Data Platform
3 | > _function (server
as text) as table_
4 |
5 | # Description
6 | DremioDatabase_LongDescription
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Dynamics365BusinessCentral/Dynamics365BusinessCentral.Contents.md:
--------------------------------------------------------------------------------
1 | # Dynamics365BusinessCentral.Contents
2 | Enter your Dynamics 365 Business Central company.
3 | > _function (optional company
as nullable any) as table_
4 |
5 | # Description
6 | Returns a table with relevant Dynamics 365 Business Central data.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Dynamics365BusinessCentralOnPremises/Dynamics365BusinessCentralOnPremises.Contents.md:
--------------------------------------------------------------------------------
1 | # Dynamics365BusinessCentralOnPremises.Contents
2 | Enter the URL of your Dynamics 365 Business Central (on-premises) OData service endpoint.
3 | > _function (url
as text, optional company
as nullable any) as table_
4 |
5 | # Description
6 | Returns a table with relevant Dynamics 365 Business Central (on-premises) data.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Dynamics365Financials/Dynamics365Financials.Contents.md:
--------------------------------------------------------------------------------
1 | # Dynamics365Financials.Contents
2 | Enter your Dynamics 365 for Financials company.
3 | > _function (optional company
as nullable any) as table_
4 |
5 | # Description
6 | Returns a table with relevant Dynamics 365 for Financials data.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/DynamicsNav/DynamicsNav.Contents.md:
--------------------------------------------------------------------------------
1 | # DynamicsNav.Contents
2 | Enter the URL of your Dynamics NAV OData service endpoint.
3 | > _function (url
as text, optional company
as nullable any) as table_
4 |
5 | # Description
6 | Returns a table with relevant Dynamics NAV data.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Exasol/Exasol.Database.md:
--------------------------------------------------------------------------------
1 | # Exasol.Database
2 |
3 | > _function (server
as text, encrypted
as text) as table_
4 |
5 | # Description
6 | Exasol
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Excel/Excel.CurrentWorkbook.md:
--------------------------------------------------------------------------------
1 | # Excel.CurrentWorkbook
2 | Returns the tables in the current Excel Workbook.
3 | > _function () as table_
4 |
5 | # Description
6 | Returns the tables in the current Excel Workbook.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Excel/Excel.Workbook.md:
--------------------------------------------------------------------------------
1 | # Excel.Workbook
2 | Returns a record of Sheets from the Excel workbook.
3 | > _function (workbook
as binary, optional useHeaders
as nullable any, optional delayTypes
as nullable any) as table_
4 |
5 | # Description
6 | Returns a record of Sheets from the Excel workbook.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Exchange/Exchange.Contents.md:
--------------------------------------------------------------------------------
1 | # Exchange.Contents
2 | Returns a table of contents from a Microsoft Exchange account.
3 | > _function (optional mailboxAddress
as nullable any) as table_
4 |
5 | # Description
6 | Returns a table of contents from the Microsoft Exchange account mailboxAddress
. If mailboxAddress
is not specified, the default account for the credential will be used.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Facebook/Facebook.Graph.md:
--------------------------------------------------------------------------------
1 | # Facebook.Graph
2 | Returns a record containing content from the Facebook graph.
3 | > _function (url
as text) as nullable any_
4 |
5 | # Description
6 | Returns a record containing a set of tables found in the Facebook graph at the specified URL, url
.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/File/File.Contents.md:
--------------------------------------------------------------------------------
1 | # File.Contents
2 | Returns the contents of the specified file as binary.
3 | > _function (path
as text) as binary_
4 |
5 | # Description
6 | Returns the contents of the file, path
, as binary.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Folder/Folder.Contents.md:
--------------------------------------------------------------------------------
1 | # Folder.Contents
2 | Returns a table containing the properties and contents of the files and folders found in the specifed folder.
3 | > _function (path
as text) as table_
4 |
5 | # Description
6 | Returns a table containing a row for each folder and file found at the folder path, path
. Each row contains properties of the folder or file and a link to its content.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Folder/Folder.Files.md:
--------------------------------------------------------------------------------
1 | # Folder.Files
2 | Returns a table containing the properties and contents of the files found in the specified folder and subfolders.
3 | > _function (path
as text) as table_
4 |
5 | # Description
6 | Returns a table containing a row for each file found at the folder path, path
, and subfolders. Each row contains properties of the file and a link to its content.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Github/Github.Contents.md:
--------------------------------------------------------------------------------
1 | # Github.Contents
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Github/Github.PagedTable.md:
--------------------------------------------------------------------------------
1 | # Github.PagedTable
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Github/Github.Tables.md:
--------------------------------------------------------------------------------
1 | # Github.Tables
2 | Enter the GitHub repository owner and the repository name.
3 | > _function (RepositoryOwner
as text, Repository
as text) as table_
4 |
5 | # Description
6 | Returns a table with relevant GitHub data.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/GoogleAnalytics/GoogleAnalytics.Accounts.md:
--------------------------------------------------------------------------------
1 | # GoogleAnalytics.Accounts
2 | Returns Google Analytics accounts.
3 | > _function () as table_
4 |
5 | # Description
6 | Returns Google Analytics accounts that are accessible from the current credential.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/HdInsight/HdInsight.Containers.md:
--------------------------------------------------------------------------------
1 | # HdInsight.Containers
2 | Returns a navigational table containing the containers found in the specified account from an Azure storage vault.
3 | > _function (account
as text) as table_
4 |
5 | # Description
6 | Returns a navigational table containing a row for each container found at the account URL, account
, from an Azure storage vault. Each row contains a link to the container blobs.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/HdInsight/HdInsight.Contents.md:
--------------------------------------------------------------------------------
1 | # HdInsight.Contents
2 | Returns a navigational table containing the containers found in the specified account from an Azure storage vault.
3 | > _function (account
as text) as table_
4 |
5 | # Description
6 | Returns a navigational table containing a row for each container found at the account URL, account
, from an Azure storage vault. Each row contains a link to the container blobs.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/HdInsight/HdInsight.Files.md:
--------------------------------------------------------------------------------
1 | # HdInsight.Files
2 | Returns a table containing the properties and contents of the blobs found in the specified container from an Azure storage vault.
3 | > _function (account
as text, containerName
as text) as table_
4 |
5 | # Description
6 | Returns a table containing a row for each blob file found at the container URL, account
, from an Azure storage vault. Each row contains properties of the file and a link to its content.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Hdfs/Hdfs.Contents.md:
--------------------------------------------------------------------------------
1 | # Hdfs.Contents
2 | Returns a table containing the properties and contents of the files and folders found in the specified folder from a Hadoop file system.
3 | > _function (url
as text) as table_
4 |
5 | # Description
6 | Returns a table containing a row for each folder and file found at the folder URL, url
, from a Hadoop file system. Each row contains properties of the folder or file and a link to its content.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Hdfs/Hdfs.Files.md:
--------------------------------------------------------------------------------
1 | # Hdfs.Files
2 | Returns a table containing the properties and contents of the files found in the specified folder and subfolders from a Hadoop file system.
3 | > _function (url
as text) as table_
4 |
5 | # Description
6 | Returns a table containing a row for each file found at the folder URL, url
, and subfolders from a Hadoop file system. Each row contains properties of the file and a link to its content.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Impala/Impala.Database.md:
--------------------------------------------------------------------------------
1 | # Impala.Database
2 | Import data from an Impala cluster
3 | > _function (server
as text) as table_
4 |
5 | # Description
6 | Import data from an Impala cluster server
. If a port wasn't specified, the default port 21050 will be used.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/JethroODBC/JethroODBC.Database.md:
--------------------------------------------------------------------------------
1 | # JethroODBC.Database
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Json/Json.Document.md:
--------------------------------------------------------------------------------
1 | # Json.Document
2 | Returns the content of the JSON document.
3 | > _function (optional jsonText
as nullable any, optional encoding
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the content of the JSON document.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Kusto/Kusto.Contents.md:
--------------------------------------------------------------------------------
1 | # Kusto.Contents
2 | Imports data from Azure Kusto
3 | > _function (cluster
as text, optional database
as nullable any, optional tableOrQuery
as nullable any, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Imports data from your Azure Kusto instance
7 | # Category
8 | Accessing data
9 | # Examples
10 | Returns a table of Storm Events information
11 | ```
12 | Kusto.Contents("help", "Samples", "StormEvents", [])
13 | ```
14 | > A table with Storm Events from the Samples database in the help cluster
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/Kusto/Kusto.Databases.md:
--------------------------------------------------------------------------------
1 | # Kusto.Databases
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Kyligence/Kyligence.Database.md:
--------------------------------------------------------------------------------
1 | # Kyligence.Database
2 |
3 | > _function (Server
as text, Port
as text, Project
as text, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Connect your Kyligence Enterprise
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/MailChimp/MailChimp.Instance.md:
--------------------------------------------------------------------------------
1 | # MailChimp.Instance
2 | Returns raw response results from a MailChimp API endpoint.
3 | > _function (path
as text) as table_
4 |
5 | # Description
6 | Makes a call to the MailChimp API and returns the raw response.
7 | # Category
8 | Accessing data
9 | # Examples
10 | Returns raw data from the reports/click-details MailChimp API endpoint for a given campaign.
11 | ```
12 | MailChimp.Instance("reports/{campaign_id}/click-details")
13 | ```
14 | > Raw click details data from the given campaign.
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/MailChimp/MailChimp.Tables.md:
--------------------------------------------------------------------------------
1 | # MailChimp.Tables
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/MailChimp/MailChimp.TablesV2.md:
--------------------------------------------------------------------------------
1 | # MailChimp.TablesV2
2 | Returns a table with key MailChimp data.
3 | > _function () as table_
4 |
5 | # Description
6 | Returns a table with key MailChimp data.
7 | # Category
8 | Accessing data
9 | # Examples
10 | Returns a table with key MailChimp data.
11 | ```
12 | MailChimp.Tables()
13 | ```
14 | > A table with key MailChimp data.
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/Marketo/Marketo.Activities.md:
--------------------------------------------------------------------------------
1 | # Marketo.Activities
2 | Returns a table with lead activities.
3 | > _function (url
as text, startTime
as date, activityIds
as list) as table_
4 |
5 | # Description
6 | Makes a call to the Marketo REST API endpoint at url
/rest/v1/activities.json. All activities in list activityIds
that have occurred since startTime
are returned.
7 | # Category
8 | Accessing data
9 | # Examples
10 | Pulls a table of "Visit Webpage" activities since November 1, 2015
11 | ```
12 | Marketo.Activities("https://100-AAA-999.mktorest.com/rest", #date(2015,11,1), {1})
13 | ```
14 | > A table with details of all "Visit Webpage" activities since November 1
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/Marketo/Marketo.Leads.md:
--------------------------------------------------------------------------------
1 | # Marketo.Leads
2 | Returns a table with lead details.
3 | > _function (url
as text, leadIds
as list, optional options
as nullable any) as table_
4 |
5 | # Description
6 | Makes a call to the Marketo REST API endpoint at url
/rest/v1/leads.json. All leads in list leadIds
are returned.
7 | # Category
8 | Accessing data
9 | # Examples
10 | Pulls the details for three leads
11 | ```
12 | Marketo.Leads("https://100-AAA-999.mktorest.com/rest", {50, 2343, 88498})
13 | ```
14 | > A table with details for the supplied leads
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/Marketo/Marketo.Tables.md:
--------------------------------------------------------------------------------
1 | # Marketo.Tables
2 | Enter the URL of the Marketo REST API endpoint associated with your account.
3 | > _function (url
as text, QueryStart
as date) as table_
4 |
5 | # Description
6 | Returns a table with relevant Marketo data.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Marketplace/Marketplace.Subscriptions.md:
--------------------------------------------------------------------------------
1 | # Marketplace.Subscriptions
2 | Returns all the subscribed feeds from Azure Marketplace.
3 | > _function () as table_
4 |
5 | # Description
6 | Returns all the subscribed feeds from Azure Marketplace.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/MicrosoftAzureConsumptionInsights/MicrosoftAzureConsumptionInsights.Tables.md:
--------------------------------------------------------------------------------
1 | # MicrosoftAzureConsumptionInsights.Tables
2 | Microsoft Azure Consumption Insights
3 | > _function (enrollmentNumber
as any, optional parameters
as nullable record) as table_
4 |
5 | # Description
6 | Microsoft Azure Consumption Insights
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/MicrosoftAzureConsumptionInsights/MicrosoftAzureConsumptionInsights.Test.md:
--------------------------------------------------------------------------------
1 | # MicrosoftAzureConsumptionInsights.Test
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Mixpanel/Mixpanel.Contents.md:
--------------------------------------------------------------------------------
1 | # Mixpanel.Contents
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Mixpanel/Mixpanel.Export.md:
--------------------------------------------------------------------------------
1 | # Mixpanel.Export
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Mixpanel/Mixpanel.FunnelById.md:
--------------------------------------------------------------------------------
1 | # Mixpanel.FunnelById
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Mixpanel/Mixpanel.FunnelByName.md:
--------------------------------------------------------------------------------
1 | # Mixpanel.FunnelByName
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Mixpanel/Mixpanel.Funnels.md:
--------------------------------------------------------------------------------
1 | # Mixpanel.Funnels
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Mixpanel/Mixpanel.Segmentation.md:
--------------------------------------------------------------------------------
1 | # Mixpanel.Segmentation
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Mixpanel/Mixpanel.Tables.md:
--------------------------------------------------------------------------------
1 | # Mixpanel.Tables
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Odbc/Odbc.InferOptions.md:
--------------------------------------------------------------------------------
1 | # Odbc.InferOptions
2 | Returns the result of trying to infer SQL capabilities for an ODBC driver.
3 | > _function (optional connectionString
as nullable any) as record_
4 |
5 | # Description
6 | Returns the result of trying to infer SQL capbabilities with the connection string connectionString
using ODBC. connectionString
can be text or a record of property value pairs. Property values can either be text or number.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Paxata/Paxata.Contents.md:
--------------------------------------------------------------------------------
1 | # Paxata.Contents
2 |
3 | > _function (url
as text) as table_
4 |
5 | # Description
6 |
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/PlanviewEnterprise/PlanviewEnterprise.Feed.md:
--------------------------------------------------------------------------------
1 | # PlanviewEnterprise.Feed
2 | Enter the URL and database name associated with your Enterprise One - Portfolio and Resource Management account.
3 | > _function (url
as text, database
as text) as table_
4 |
5 | # Description
6 | Returns a table with Enterprise One - Portfolio and Resource Management data.
7 | # Category
8 | Accessing data
9 | # Examples
10 | Returns a table of Enterprise One - Portfolio and Resource Management information
11 | ```
12 | PlanviewEnterprise.Feed("https://contoso.com/planview", "pve")
13 | ```
14 | > A table of Enterprise One - Portfolio and Resource Management data about database pve
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/PowerBI/PowerBI.Dataflows.md:
--------------------------------------------------------------------------------
1 | # PowerBI.Dataflows
2 |
3 | > _function (optional options
as nullable record) as table_
4 |
5 | # Description
6 | Connect to all the Power BI dataflows you have access to, and choose the entities you?d like to use.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Projectplace/Projectplace.Feed.md:
--------------------------------------------------------------------------------
1 | # Projectplace.Feed
2 | Enter the URL of your Planview Projectplace account.
3 | > _function (ODataURL
as text) as table_
4 |
5 | # Description
6 | Returns a table with relevant Planview Projectplace data.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Python/Python.Execute.md:
--------------------------------------------------------------------------------
1 | # Python.Execute
2 | Executes Python script and returns data frames
3 | > _function (script
as text, optional arguments
as nullable record) as table_
4 |
5 | # Description
6 |
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/QuickBooks/QuickBooks.Query.md:
--------------------------------------------------------------------------------
1 | # QuickBooks.Query
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/QuickBooks/QuickBooks.Report.md:
--------------------------------------------------------------------------------
1 | # QuickBooks.Report
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/QuickBooks/QuickBooks.Tables.md:
--------------------------------------------------------------------------------
1 | # QuickBooks.Tables
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/R/R.Execute.md:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/RData/RData.FromBinary.md:
--------------------------------------------------------------------------------
1 | # RData.FromBinary
2 | Returns a record of data frames from the RData file.
3 | > _function (stream
as binary) as nullable any_
4 |
5 | # Description
6 | Returns a record of data frames from the RData file.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/README.md:
--------------------------------------------------------------------------------
1 | # Accessing data
2 |
3 | Functions in this section access data and return table values. Most of these functions return a table value that is called a *navigation table*. A *navigation table* is a two column table. The first column contains the name of an item and the corresponding second column contains the value of that item. This shape is primarily used by the Power Query user interface to provide navigation experience over the potentially large hierarchical data returned.
--------------------------------------------------------------------------------
/docs/Accessing data/Smartsheet/Smartsheet.Content.md:
--------------------------------------------------------------------------------
1 | # Smartsheet.Content
2 | Returns a table of data from an Smartsheet index endpoint.
3 | > _function (endpoint
as text) as nullable any_
4 |
5 | # Description
6 | Makes a call to the Smartsheet 2.0 REST API at the specified endpoint and transforms the data element returned into a table.
7 | # Category
8 | Accessing data
9 | # Examples
10 | Pulls a table of users information from the Smartsheet API
11 | ```
12 | Smartsheet.Content("users")
13 | ```
14 | > A table with users information as returned by the Smartsheet API
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/Smartsheet/Smartsheet.Query.md:
--------------------------------------------------------------------------------
1 | # Smartsheet.Query
2 | Returns a JSON result from the Smartsheet API
3 | > _function (endpoint
as text, args
as text, headers
as record) as nullable any_
4 |
5 | # Description
6 | Makes a call to the Smartsheet 2.0 REST API at the specified endpoint and returns results as a JSON record.
7 | # Category
8 | Accessing data
9 | # Examples
10 | Pulls data from the sheets Smartsheet API endpoint with additional arguments specified
11 | ```
12 | Smartsheet.Content("sheets", "include=ownerInfo&includeAll=true", [])
13 | ```
14 | > A table with sheets information as returned by the Smartsheet API
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/Smartsheet/Smartsheet.Tables.md:
--------------------------------------------------------------------------------
1 | # Smartsheet.Tables
2 | Returns a table of sheets, reports, folders, and workspaces from the Smartsheet API
3 | > _function () as table_
4 |
5 | # Description
6 | Returns a nested table of available sheets, reports, folders, and workspaces from the Smartsheet API.
7 | # Category
8 | Accessing data
9 | # Examples
10 | Returns sheets, folders, reports, and workspaces available at the top level of the Smartsheet hierarchy
11 | ```
12 | Smartsheet.Tables()
13 | ```
14 | > A table of folders, reports, and workspaces from the top level of the Smartsheet hierarchy
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/Snowflake/Snowflake.Databases.md:
--------------------------------------------------------------------------------
1 | # Snowflake.Databases
2 | Import data from a Snowflake Computing warehouse.
3 | > _function (server
as text, warehouse
as text, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Returns a table listing the tables in the Snowflake Computing warehouse
located at server
. An optional record parameter, options
, may be specified to control the following options:
7 |
ConnectionTimeout
: The number of seconds to wait for network responses from Snowflake.CommandTimeout
: The number of seconds to wait for a query to execute.url
as text) as table_
4 |
5 | # Description
6 | Returns a table from the contents at the specified URL url
formatted according to the SODA 2.0 API. The URL must point to a valid SODA-compliant source that ends in a .csv extension.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Spark/Spark.Tables.md:
--------------------------------------------------------------------------------
1 | # Spark.Tables
2 | Returns a table listing the tables on the specified Spark cluster.
3 | > _function (server
as text, protocol
as number) as table_
4 |
5 | # Description
6 | Returns a table listing the tables on the Spark cluster host
using protocol
. Valid protocols are:
7 | SparkProtocol.Standard, SparkProtocol.Azure, SparkProtocol.HTTP
8 | # Category
9 | Accessing data
10 |
--------------------------------------------------------------------------------
/docs/Accessing data/SparkPost/SparkPost.GetContents.md:
--------------------------------------------------------------------------------
1 | # SparkPost.GetContents
2 | Returns a table of available data from the SparkPost API v1
3 | > _function (path
as text, optional query
as nullable any) as table_
4 |
5 | # Description
6 | This function can be used to call any endpoint offered by SparkPost V1.
7 | # Category
8 | Accessing data
9 | # Examples
10 |
11 | ```
12 | Source = SparkPost.GetContents("metrics/campaigns",[Query=[match="c1", limit=5]])
13 | ```
14 | > Json.Document
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/SparkPost/SparkPost.GetMetrics.md:
--------------------------------------------------------------------------------
1 | # SparkPost.GetMetrics
2 | Returns a table of available metrics from the SparkPost API v1
3 | > _function (DaysOffset
as number, MetricsColumns
as text, path
as text) as table_
4 |
5 | # Description
6 | This function can be used to pull specific metrics for a period of days at an hour-by-hour granularity. The function automatically handles the paging of data.
7 | # Category
8 | Accessing data
9 | # Examples
10 |
11 | ```
12 | Source = SparkPost.GetMetrics(3, "count_sent,count_bounce", "metrics/deliverability")
13 | ```
14 | > table
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/SparkPost/SparkPost.Metrics.md:
--------------------------------------------------------------------------------
1 | # SparkPost.Metrics
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/SparkPost/SparkPost.NavTable.md:
--------------------------------------------------------------------------------
1 | # SparkPost.NavTable
2 | Enter the number of days of metrics to retrieve from SparkPost.
3 | > _function (DaysOffset
as number) as table_
4 |
5 | # Description
6 |
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Stripe/Stripe.Tables.md:
--------------------------------------------------------------------------------
1 | # Stripe.Tables
2 | Returns a table listing the available Stripe tables and functions.
3 | > _function () as table_
4 |
5 | # Description
6 | Returns a table listing the available Stripe tables and functions.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/SweetIQ/SweetIQ.Contents.md:
--------------------------------------------------------------------------------
1 | # SweetIQ.Contents
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/SweetIQ/SweetIQ.Tables.md:
--------------------------------------------------------------------------------
1 | # SweetIQ.Tables
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/TeamDesk/TeamDesk.Database.md:
--------------------------------------------------------------------------------
1 | # TeamDesk.Database
2 |
3 | > _function (url
as text) as table_
4 |
5 | # Description
6 | Connects to TeamDesk database and let you select a table and a view to retrieve the data from.
7 | # Category
8 | Accessing data
9 | # Examples
10 | Connect to sample TeamDesk database
11 | ```
12 | TeamDesk.Database("https://www.teamdesk.net/secure/db/57692")
13 | ```
14 | > Navigation table
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/Troux/Troux.CustomFeed.md:
--------------------------------------------------------------------------------
1 | # Troux.CustomFeed
2 | Enter the URL of your Planview Enterprise One - Capability and Technology Management account and a query.
3 | > _function (url
as text, query
as text) as table_
4 |
5 | # Description
6 | Returns a table with relevant Planview Enterprise One - Capability and Technology Management data specified by the query.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Troux/Troux.Feed.md:
--------------------------------------------------------------------------------
1 | # Troux.Feed
2 | Enter the URL of your Planview Enterprise One - Capability and Technology Management account.
3 | > _function (url
as text) as table_
4 |
5 | # Description
6 | Returns a table with relevant Planview Enterprise One - Capability and Technology Management data.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Troux/Troux.TestConnection.md:
--------------------------------------------------------------------------------
1 | # Troux.TestConnection
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Twilio/Twilio.Contents.md:
--------------------------------------------------------------------------------
1 | # Twilio.Contents
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Twilio/Twilio.Tables.md:
--------------------------------------------------------------------------------
1 | # Twilio.Tables
2 | Enter the number of months of historical Twilio data to retrieve.
3 | > _function (historyMonths
as number) as table_
4 |
5 | # Description
6 | Returns a table with relevant Twilio data.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Twilio/Twilio.URL.md:
--------------------------------------------------------------------------------
1 | # Twilio.URL
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/VSTS/VSTS.AccountContents.md:
--------------------------------------------------------------------------------
1 | # VSTS.AccountContents
2 | Enter Url of your VSTS Analytics Service.
3 | > _function (url
as text, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Returns the contents downloaded from the VSTS Analytics Service url as a binary value. This function uses different credentials for different accounts.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/VSTS/VSTS.AnalyticsViews.md:
--------------------------------------------------------------------------------
1 | # VSTS.AnalyticsViews
2 | Enter account and project names.
3 | > _function (url
as text, project
as text, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Returns a table of Analytics Views offered by Visual Studio Team Services.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/VSTS/VSTS.Contents.md:
--------------------------------------------------------------------------------
1 | # VSTS.Contents
2 | Enter Url of your VSTS Analytics Service.
3 | > _function (url
as text, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Returns the contents downloaded from the VSTS Analytics Service url as a binary value. This function uses global credentials for all the accessible account.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/VSTS/VSTS.Feed.md:
--------------------------------------------------------------------------------
1 | # VSTS.Feed
2 | Visual Studio Team Services Feed.
3 | > _function (url
as text, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Returns a table of OData feeds offered by Visual Studio Team Services.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/VSTS/VSTS.Views.md:
--------------------------------------------------------------------------------
1 | # VSTS.Views
2 | Enter account and project names.
3 | > _function (url
as text, project
as text, optional areaPath
as nullable any, optional options
as nullable record) as table_
4 |
5 | # Description
6 | Returns a table of OData feeds offered by Visual Studio Team Services.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Web/Web.Page.md:
--------------------------------------------------------------------------------
1 | # Web.Page
2 | Returns the contents of the HTML document broken into its constituent structures, as well as a representation of the full document and its text after removing tags.
3 | > _function (optional html
as nullable any) as table_
4 |
5 | # Description
6 | Returns the contents of the HTML document broken into its constituent structures, as well as a representation of the full document and its text after removing tags.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Webtrends/Webtrends.KeyMetrics.md:
--------------------------------------------------------------------------------
1 | # Webtrends.KeyMetrics
2 | Returns a table with key Webtrends metrics.
3 | > _function (ProfileId
as text, optional startDate
as nullable any, optional endDate
as nullable any) as table_
4 |
5 | # Description
6 | Makes a call to the Webtrends KeyMetrics endpoint and returns all data as a table.
7 | # Category
8 | Accessing data
9 | # Examples
10 | Pulls a table of key metrics for tenant 98765 in last 30 days
11 | ```
12 | Webtrends.KeyMetrics("98765")
13 | ```
14 | > A table of key metrics
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/Webtrends/Webtrends.Profile.md:
--------------------------------------------------------------------------------
1 | # Webtrends.Profile
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Webtrends/Webtrends.ReportContents.md:
--------------------------------------------------------------------------------
1 | # Webtrends.ReportContents
2 | Returns a table with report content from Webtrends.
3 | > _function (ProfileId
as text, ReportId
as text, optional startDate
as nullable any, optional endDate
as nullable any) as table_
4 |
5 | # Description
6 | Makes a call to the given Webtrends reporting endpoint and returns all data as a table.
7 | # Category
8 | Accessing data
9 | # Examples
10 | Makes a call to the Webtrends visitors report endpoint for data in the last 30 days
11 | ```
12 | Webtrends.ReportContents("98765", "xPcmTDDP0P6")
13 | ```
14 | > A table of visitor data
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/Webtrends/Webtrends.Tables.md:
--------------------------------------------------------------------------------
1 | # Webtrends.Tables
2 | Enter the Profile ID associated with your Webtrends account.
3 | > _function (ProfileId
as text, optional startDate
as nullable any, optional endDate
as nullable any) as table_
4 |
5 | # Description
6 | Returns a table with relevant Webtrends data.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Xml/Xml.Document.md:
--------------------------------------------------------------------------------
1 | # Xml.Document
2 | Returns the contents of the XML document as a hierarchical table.
3 | > _function (optional contents
as nullable any, optional encoding
as nullable any) as table_
4 |
5 | # Description
6 | Returns the contents of the XML document as a hierarchical table.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Xml/Xml.Tables.md:
--------------------------------------------------------------------------------
1 | # Xml.Tables
2 | Returns the contents of the XML document as a nested collection of flattened tables.
3 | > _function (optional contents
as nullable any, optional options
as nullable record, optional encoding
as nullable any) as table_
4 |
5 | # Description
6 | Returns the contents of the XML document as a nested collection of flattened tables.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/Zendesk/Zendesk.Collection.md:
--------------------------------------------------------------------------------
1 | # Zendesk.Collection
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/Zendesk/Zendesk.Tables.md:
--------------------------------------------------------------------------------
1 | # Zendesk.Tables
2 | Enter the URL of your Zendesk account.
3 | > _function (url
as text) as table_
4 |
5 | # Description
6 | Returns a table with relevant Zendesk data.
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Accessing data/appFigures/appFigures.Content.md:
--------------------------------------------------------------------------------
1 | # appFigures.Content
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/appFigures/appFigures.Tables.md:
--------------------------------------------------------------------------------
1 | # appFigures.Tables
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/comScore/comScore.NavTable.md:
--------------------------------------------------------------------------------
1 | # comScore.NavTable
2 |
3 | > _function (datacenter
as text, client
as text, optional startDate
as nullable any, optional endDate
as nullable any) as table_
4 |
5 | # Description
6 |
7 | # Category
8 | Accessing data
9 | # Examples
10 |
11 | ```
12 |
13 | ```
14 | >
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Accessing data/tyGraph/tyGraph.Feed.md:
--------------------------------------------------------------------------------
1 | # tyGraph.Feed
2 |
--------------------------------------------------------------------------------
/docs/Accessing data/tyGraph/tyGraph.NavTable.md:
--------------------------------------------------------------------------------
1 | # tyGraph.NavTable
2 | uses https://api.tygraph.com/odata
3 | > _function () as table_
4 |
5 | # Description
6 |
7 | # Category
8 | Accessing data
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.7BitEncodedSignedInteger.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.7BitEncodedSignedInteger
2 | A binary format that reads a 64-bit signed integer that was encoded using a 7-bit variable-length encoding.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads a 64-bit signed integer that was encoded using a 7-bit variable-length encoding.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.7BitEncodedUnsignedInteger.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.7BitEncodedUnsignedInteger
2 | A binary format that reads a 64-bit unsigned integer that was encoded using a 7-bit variable-length encoding.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads a 64-bit unsigned integer that was encoded using a 7-bit variable-length encoding.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.Binary.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.Binary
2 | Returns a binary format that reads a binary value.
3 | > _function (optional length
as nullable any) as function_
4 |
5 | # Description
6 | Returns a binary format that reads a binary value. If length
is specified, the binary value will contain that many bytes. If length
is not specified, the binary value will contain the remaining bytes. The length
can be specified either as a number, or as a binary format of the length that preceeds the binary data.
7 | # Category
8 | Binary Formats.Reading binary data
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.Byte.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.Byte
2 | A binary format that reads an 8-bit unsigned integer.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads an 8-bit unsigned integer.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.ByteOrder.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.ByteOrder
2 | Returns a binary format with the byte order specified by a function.
3 | > _function (binaryFormat
as function, byteOrder
as number) as function_
4 |
5 | # Description
6 | Returns a binary format with the byte order specified by binaryFormat
. The default byte order is ByteOrder.BigEndian
.
7 | # Category
8 | Binary Formats.Controlling byte order
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.Decimal.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.Decimal
2 | A binary format that reads a .NET 16-byte decimal value.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads a .NET 16-byte decimal value.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.Double.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.Double
2 | A binary format that reads an 8-byte IEEE double-precision floating point value.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads an 8-byte IEEE double-precision floating point value.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.Null.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.Null
2 | A binary format that reads zero bytes and returns null.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads zero bytes and returns null.
7 | # Category
8 | Binary Formats.Controlling what comes next
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.SignedInteger16.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.SignedInteger16
2 | A binary format that reads a 16-bit signed integer.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads a 16-bit signed integer.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.SignedInteger32.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.SignedInteger32
2 | A binary format that reads a 32-bit signed integer.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads a 32-bit signed integer.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.SignedInteger64.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.SignedInteger64
2 | A binary format that reads a 64-bit signed integer.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads a 64-bit signed integer.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.Single.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.Single
2 | A binary format that reads a 4-byte IEEE single-precision floating point value.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads a 4-byte IEEE single-precision floating point value.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.UnsignedInteger16.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.UnsignedInteger16
2 | A binary format that reads a 16-bit unsigned integer.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads a 16-bit unsigned integer.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.UnsignedInteger32.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.UnsignedInteger32
2 | A binary format that reads a 32-bit unsigned integer.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads a 32-bit unsigned integer.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/BinaryFormat.UnsignedInteger64.md:
--------------------------------------------------------------------------------
1 | # BinaryFormat.UnsignedInteger64
2 | A binary format that reads a 64-bit unsigned integer.
3 | > _function (binary
as binary) as nullable any_
4 |
5 | # Description
6 | A binary format that reads a 64-bit unsigned integer.
7 | # Category
8 | Binary Formats.Reading numbers
9 |
--------------------------------------------------------------------------------
/docs/Binary Formats/Table.PartitionValues.md:
--------------------------------------------------------------------------------
1 | # Table.PartitionValues
2 | Returns information about how a table is partitioned.
3 | > _function (table
as table) as table_
4 |
5 | # Description
6 | Returns information about how a table is partitioned. A table is returned where each column is a partition column in the original table, and each row corresponds to a partition in the original table.
7 | # Category
8 | Binary Formats.Controlling byte order
9 |
--------------------------------------------------------------------------------
/docs/Binary/Binary.Buffer.md:
--------------------------------------------------------------------------------
1 | # Binary.Buffer
2 | Buffers the binary value in memory.
3 | > _function (optional binary
as nullable any) as nullable any_
4 |
5 | # Description
6 | Buffers the binary value in memory. The result of this call is a stable binary value, which means it will have a deterministic length and order of bytes.
7 | # Category
8 | Binary
9 | # Examples
10 | Create a stable version of the binary value.
11 | ```
12 | Binary.Buffer(Binary.FromList({0..10}))
13 | ```
14 | > #binary({0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10})
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Binary/Binary.Combine.md:
--------------------------------------------------------------------------------
1 | # Binary.Combine
2 | Combines a list of binaries into a single binary.
3 | > _function (binaries
as list) as binary_
4 |
5 | # Description
6 | Combines a list of binaries into a single binary.
7 | # Category
8 | Binary
9 |
--------------------------------------------------------------------------------
/docs/Binary/Binary.Compress.md:
--------------------------------------------------------------------------------
1 | # Binary.Compress
2 | Compresses a binary value using the given compression type.
3 | > _function (optional binary
as nullable any, compressionType
as number) as nullable any_
4 |
5 | # Description
6 | Compresses a binary value using the given compression type. The result of this call is a compressed copy of the input. Compression types include:
7 | Compression.GZip
Compression.Deflate
list
as list) as binary_
4 |
5 | # Description
6 | Converts a list of numbers into a binary value.
7 | # Category
8 | Binary
9 |
--------------------------------------------------------------------------------
/docs/Binary/Binary.Length.md:
--------------------------------------------------------------------------------
1 | # Binary.Length
2 | Returns the number of characters.
3 | > _function (optional binary
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the number of characters.
7 | # Category
8 | Binary
9 |
--------------------------------------------------------------------------------
/docs/Binary/Binary.ToList.md:
--------------------------------------------------------------------------------
1 | # Binary.ToList
2 | Converts a binary value into a list of numbers.
3 | > _function (binary
as binary) as list_
4 |
5 | # Description
6 | Converts a binary value into a list of numbers.
7 | # Category
8 | Binary
9 |
--------------------------------------------------------------------------------
/docs/Binary/Binary.ToText.md:
--------------------------------------------------------------------------------
1 | # Binary.ToText
2 | Encodes binary data into a text form.
3 | > _function (optional binary
as nullable any, optional encoding
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of converting a binary list of numbers binary
into a text value. Optionally, encoding
may be specified to indicate the encoding to be used in the text value produced
7 | The following BinaryEncoding
values may be used for encoding
.
8 | BinaryEncoding.Base64
: Base 64 encodingBinaryEncoding.Hex
: Hex encodingdelimiter
as text, optional quoteStyle
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that combines a list of text into a single text using the specified delimiter.
7 | # Category
8 | Combiner
9 |
--------------------------------------------------------------------------------
/docs/Combiner/Combiner.CombineTextByEachDelimiter.md:
--------------------------------------------------------------------------------
1 | # Combiner.CombineTextByEachDelimiter
2 | Returns a function that combines a list of text into a single text using each specified delimiter in sequence.
3 | > _function (delimiters
as list, optional quoteStyle
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that combines a list of text into a single text using each specified delimiter in sequence.
7 | # Category
8 | Combiner
9 |
--------------------------------------------------------------------------------
/docs/Combiner/Combiner.CombineTextByLengths.md:
--------------------------------------------------------------------------------
1 | # Combiner.CombineTextByLengths
2 | Returns a function that combines a list of text into a single text using the specified lengths.
3 | > _function (lengths
as list, optional template
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that combines a list of text into a single text using the specified lengths.
7 | # Category
8 | Combiner
9 |
--------------------------------------------------------------------------------
/docs/Combiner/Combiner.CombineTextByPositions.md:
--------------------------------------------------------------------------------
1 | # Combiner.CombineTextByPositions
2 | Returns a function that combines a list of text into a single text using the specified positions.
3 | > _function (positions
as list, optional template
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that combines a list of text into a single text using the specified positions.
7 | # Category
8 | Combiner
9 |
--------------------------------------------------------------------------------
/docs/Combiner/Combiner.CombineTextByRanges.md:
--------------------------------------------------------------------------------
1 | # Combiner.CombineTextByRanges
2 | Returns a function that combines a list of text into a single text using the specified positions and lengths.
3 | > _function (ranges
as list, optional template
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that combines a list of text into a single text using the specified positions and lengths.
7 | # Category
8 | Combiner
9 |
--------------------------------------------------------------------------------
/docs/Comparer/Comparer.Ordinal.md:
--------------------------------------------------------------------------------
1 | # Comparer.Ordinal
2 | Returns a comparer function which uses Ordinal rules to compare values.
3 | > _function (optional x
as nullable any, optional y
as nullable any) as number_
4 |
5 | # Description
6 | Returns a comparer function which uses Ordinal rules to compare the provided values x
and y
.
7 | # Category
8 | Comparer
9 | # Examples
10 | Using Ordinal rules, compare if "encyclop?dia" and "encyclopaedia" are equivalent. Note these are equivalent using Comparer.FromCulture("en-us")
.
11 | ```
12 | Comparer.Equals(Comparer.Ordinal, "encyclop?dia", "encyclopaedia")
13 | ```
14 | > false
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Comparer/Comparer.OrdinalIgnoreCase.md:
--------------------------------------------------------------------------------
1 | # Comparer.OrdinalIgnoreCase
2 | Returns a case-insensitive comparer function which uses Ordinal rules to compare values.
3 | > _function (optional x
as nullable any, optional y
as nullable any) as number_
4 |
5 | # Description
6 | Returns a case-insensitive comparer function which uses Ordinal rules to compare the provided values x
and y
.
7 | # Category
8 | Comparer
9 | # Examples
10 | Using case-insensitive Ordinal rules, compare "Abc" with "abc". Note "Abc" is less than "abc" using Comparer.Ordinal
.
11 | ```
12 | Comparer.OrdinalIgnoreCase("Abc", "abc")
13 | ```
14 | > 0
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.AddMeasureColumn.md:
--------------------------------------------------------------------------------
1 | # Cube.AddMeasureColumn
2 | Adds a column to the cube that contains the results of the measure applied in the row context of each row.
3 | > _function (cube
as table, column
as text, optional measureSelector
as nullable any) as table_
4 |
5 | # Description
6 | Adds a column with the name column
to the cube
that contains the results of the measure measureSelector
applied in the row context of each row. Measure application is affected by changes to dimension granularity and slicing. Measure values will be adjusted after certain cube operations are performed.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.ApplyParameter.md:
--------------------------------------------------------------------------------
1 | # Cube.ApplyParameter
2 | Returns a cube after applying a parameter to it.
3 | > _function (cube
as table, optional parameter
as nullable any, optional arguments
as nullable list) as table_
4 |
5 | # Description
6 | Returns a cube after applying parameter
with arguments
to cube
.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.AttributeMemberId.md:
--------------------------------------------------------------------------------
1 | # Cube.AttributeMemberId
2 | Returns the unique member identifier from members property value.
3 | > _function (optional attribute
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the unique member identifier from a member property value. attribute
. Returns null for any other values.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.AttributeMemberProperty.md:
--------------------------------------------------------------------------------
1 | # Cube.AttributeMemberProperty
2 | Returns a property of a dimension attribute.
3 | > _function (optional attribute
as nullable any, propertyName
as text) as nullable any_
4 |
5 | # Description
6 | Returns the property propertyName
of dimension attribute attribute
.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.CollapseAndRemoveColumns.md:
--------------------------------------------------------------------------------
1 | # Cube.CollapseAndRemoveColumns
2 | Changes the dimensional granularity of the filter context for the cube by collapsing the attributes mapped to the specified columns.
3 | > _function (cube
as table, columnNames
as list) as table_
4 |
5 | # Description
6 | Changes the dimensional granularity of the filter context for the cube
by collapsing the attributes mapped to the specified columns columnNames
. The columns are also removed from the tabular view of the cube.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.Dimensions.md:
--------------------------------------------------------------------------------
1 | # Cube.Dimensions
2 | Returns a table containing the set of available dimensions.
3 | > _function (cube
as table) as table_
4 |
5 | # Description
6 | Returns a table containing the set of available dimensions within the cube
. Each dimension is a table containing a set of dimension attributes and each dimension attribute is represented as a column in the dimension table. Dimensions can be expanded in the cube using Cube.AddAndExpandDimensionColumn.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.DisplayFolders.md:
--------------------------------------------------------------------------------
1 | # Cube.DisplayFolders
2 | Returns a nested tree of tables representing the display folder hierarchy of the objects (e.g. dimensions and measures).
3 | > _function (cube
as table) as table_
4 |
5 | # Description
6 | Returns a nested tree of tables representing the display folder hierarchy of the objects (e.g. dimensions and measures) available for use in the cube
.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.MeasureProperties.md:
--------------------------------------------------------------------------------
1 | # Cube.MeasureProperties
2 | Returns a table containing the set of available measure properties that are expanded in the cube.
3 | > _function (cube
as table) as table_
4 |
5 | # Description
6 | Returns a table containing the set of available properties for measures that are expanded in the cube.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.MeasureProperty.md:
--------------------------------------------------------------------------------
1 | # Cube.MeasureProperty
2 | Returns a property of a measure (cell property).
3 | > _function (optional measure
as nullable any, propertyName
as text) as nullable any_
4 |
5 | # Description
6 | Returns the property propertyName
of measure measure
.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.Measures.md:
--------------------------------------------------------------------------------
1 | # Cube.Measures
2 | Returns a table containing the set of available measures.
3 | > _function (optional cube
as nullable any) as table_
4 |
5 | # Description
6 | Returns a table containing the set of available measures within the cube
.
7 | Each measure is represented as a function. Measures can be applied to the cube using Cube.AddMeasureColumn.
8 | # Category
9 | Cube
10 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.Parameters.md:
--------------------------------------------------------------------------------
1 | # Cube.Parameters
2 | Returns a table containing the set of parameters that can be applied to the cube.
3 | > _function (cube
as table) as table_
4 |
5 | # Description
6 | Returns a table containing the set of parameters that can be applied to cube
. Each parameter is a function that can be invoked to get cube
with the parameter and its arguments applied.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.Properties.md:
--------------------------------------------------------------------------------
1 | # Cube.Properties
2 | Returns a table containing the set of available properties for dimensions that are expanded in the cube.
3 | > _function (cube
as table) as table_
4 |
5 | # Description
6 | Returns a table containing the set of available properties for dimensions that are expanded in the cube.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.PropertyKey.md:
--------------------------------------------------------------------------------
1 | # Cube.PropertyKey
2 | Returns the key of a property.
3 | > _function (optional property
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the key of property property
.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.ReplaceDimensions.md:
--------------------------------------------------------------------------------
1 | # Cube.ReplaceDimensions
2 | Cube.ReplaceDimensions
3 | > _function (cube
as table, dimensions
as table) as table_
4 |
5 | # Description
6 | Cube.ReplaceDimensions
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Cube/Cube.Transform.md:
--------------------------------------------------------------------------------
1 | # Cube.Transform
2 | Applies a list of cube functions.
3 | > _function (cube
as table, transforms
as list) as table_
4 |
5 | # Description
6 | Applies the list cube functions, transforms
, on the cube
.
7 | # Category
8 | Cube
9 |
--------------------------------------------------------------------------------
/docs/Date/Date.Day.md:
--------------------------------------------------------------------------------
1 | # Date.Day
2 | Returns the day component.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the day component of a date
, datetime
, or datetimezone
value.
7 | dateTime
: A date
, datetime
, or datetimezone
value from which the day component is extracted.date
, datetime
, or datetimezone
value representing the date and time of 5/14/2011 05:00:00 PM.
14 | ```
15 | Date.Day(#datetime(2011, 5, 14, 17, 0, 0))
16 | ```
17 | > 14
18 |
19 | ***
20 |
--------------------------------------------------------------------------------
/docs/Date/Date.DayOfWeekName.md:
--------------------------------------------------------------------------------
1 | # Date.DayOfWeekName
2 | Returns the day of the week name.
3 | > _function (optional date
as nullable any, optional culture
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the day of the week name for the provided date
and, optionally, a culture culture
.
7 | # Category
8 | Date
9 | # Examples
10 | Get the day of the week name.
11 | ```
12 | Date.DayOfWeekName(#date(2011, 12, 31), "en-US")
13 | ```
14 | > "Saturday"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Date/Date.DayOfYear.md:
--------------------------------------------------------------------------------
1 | # Date.DayOfYear
2 | Returns a number from 1 to 366 representing the day of the year.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns a number representing the day of the year in the provided date
, datetime
, or datetimezone
value, dateTime
.
7 | # Category
8 | Date
9 | # Examples
10 | The number of the day March 1st, 2011 (#date(2011, 03, 01)
).
11 | ```
12 | Date.DayOfYear(#date(2011, 03, 01))
13 | ```
14 | > 60
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Date/Date.IsLeapYear.md:
--------------------------------------------------------------------------------
1 | # Date.IsLeapYear
2 | Indicates whether this date falls in a leap year.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Indicates whether the given datetime value dateTime
falls in is a leap year.
7 | dateTime
: A date
, datetime
, or datetimezone
value to be evaluated.#date(2012, 01, 01)
is a leap year.
14 | ```
15 | Date.IsLeapYear(#date(2012, 01, 01))
16 | ```
17 | > true
18 |
19 | ***
20 |
--------------------------------------------------------------------------------
/docs/Date/Date.Month.md:
--------------------------------------------------------------------------------
1 | # Date.Month
2 | Returns the month component.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the month component of the provided datetime
value, dateTime
.
7 | # Category
8 | Date
9 | # Examples
10 | Find the month in #datetime(2011, 12, 31, 9, 15, 36).
11 | ```
12 | Date.Month(#datetime(2011, 12, 31, 9, 15, 36))
13 | ```
14 | > 12
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Date/Date.MonthName.md:
--------------------------------------------------------------------------------
1 | # Date.MonthName
2 | Returns the name of the month component.
3 | > _function (optional date
as nullable any, optional culture
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the name of the month component for the provided date
and, optionally, a culture culture
.
7 | # Category
8 | Date
9 | # Examples
10 | Get the month name.
11 | ```
12 | Date.MonthName(#datetime(2011, 12, 31, 5, 0, 0), "en-US")
13 | ```
14 | > "December"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Date/Date.QuarterOfYear.md:
--------------------------------------------------------------------------------
1 | # Date.QuarterOfYear
2 | Returns a number indicating which quarter of the year the date falls in.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns a number from 1 to 4 indicating which quarter of the year the date dateTime
falls in. dateTime
can be a date
, datetime
, or datetimezone
value.
7 | # Category
8 | Date
9 | # Examples
10 | Find which quarter of the year the date #date(2011, 12, 31) falls in.
11 | ```
12 | Date.QuarterOfYear(#date(2011, 12, 31))
13 | ```
14 | > 4
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Date/Date.StartOfDay.md:
--------------------------------------------------------------------------------
1 | # Date.StartOfDay
2 | Returns the first value of the day.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the first value of the day dateTime
.
7 | dateTime
must be a date
, datetime
, or datetimezone
value.
8 | # Category
9 | Date
10 | # Examples
11 | Find the start of the day for October 10th, 2011, 8:00AM (#datetime(2011, 10, 10, 8, 0, 0)
).
12 | ```
13 | Date.StartOfDay(#datetime(2011, 10, 10, 8, 0, 0))
14 | ```
15 | > #datetime(2011, 10, 10, 0, 0, 0)
16 |
17 | ***
18 |
--------------------------------------------------------------------------------
/docs/Date/Date.StartOfMonth.md:
--------------------------------------------------------------------------------
1 | # Date.StartOfMonth
2 | Returns the first value of the month.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the first value of the month given a date
or datetime
type.
7 | # Category
8 | Date
9 | # Examples
10 | Find the start of the month for October 10th, 2011, 8:10:32AM (#datetime(2011, 10, 10, 8, 10, 32)
).
11 | ```
12 | Date.StartOfMonth(#datetime(2011, 10, 10, 8, 10, 32))
13 | ```
14 | > #datetime(2011, 10, 1, 0, 0, 0)
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Date/Date.StartOfQuarter.md:
--------------------------------------------------------------------------------
1 | # Date.StartOfQuarter
2 | Returns the first value of the quarter.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the first value of the quarter dateTime
.
7 | dateTime
must be a date
, datetime
, or datetimezone
value.
8 | # Category
9 | Date
10 | # Examples
11 | Find the start of the quarter for October 10th, 2011, 8:00AM (#datetime(2011, 10, 10, 8, 0, 0)
).
12 | ```
13 | Date.StartOfQuarter(#datetime(2011, 10, 10, 8, 0, 0))
14 | ```
15 | > #datetime(2011, 10, 1, 0, 0, 0)
16 |
17 | ***
18 |
--------------------------------------------------------------------------------
/docs/Date/Date.StartOfWeek.md:
--------------------------------------------------------------------------------
1 | # Date.StartOfWeek
2 | Returns the first value of the week.
3 | > _function (optional dateTime
as nullable any, optional firstDayOfWeek
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the first value of the week given a date
, datetime
, or datetimezone
value.
7 | # Category
8 | Date
9 | # Examples
10 | Find the start of the week for October 10th, 2011, 8:10:32AM (#datetime(2011, 10, 10, 8, 10, 32)
).
11 | ```
12 | Date.StartOfWeek(#datetime(2011, 10, 10, 8, 10, 32))
13 | ```
14 | > #datetime(2011, 10, 9, 0, 0, 0)
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Date/Date.StartOfYear.md:
--------------------------------------------------------------------------------
1 | # Date.StartOfYear
2 | Returns the first value of the year.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the first value of the year given a date
, datetime
, or datetimezone
value.
7 | # Category
8 | Date
9 | # Examples
10 | Find the start of the year for October 10th, 2011, 8:10:32AM (#datetime(2011, 10, 10, 8, 10, 32)
).
11 | ```
12 | Date.StartOfYear(#datetime(2011, 10, 10, 8, 10, 32))
13 | ```
14 | > #datetime(2011, 1, 1, 0, 0, 0)
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Date/Date.ToRecord.md:
--------------------------------------------------------------------------------
1 | # Date.ToRecord
2 | Returns a record containing parts of the date value.
3 | > _function (date
as date) as record_
4 |
5 | # Description
6 | Returns a record containing the parts of the given date value, date
.
7 | date
: A date
value for from which the record of its parts is to be calculated.#date(2011, 12, 31)
value into a record containing parts from the date value.
14 | ```
15 | Date.ToRecord(#date(2011, 12, 31))
16 | ```
17 | > [
18 | Year = 2011,
19 | Month = 12,
20 | Day = 31
21 | ]
22 |
23 | ***
24 |
--------------------------------------------------------------------------------
/docs/Date/Date.WeekOfMonth.md:
--------------------------------------------------------------------------------
1 | # Date.WeekOfMonth
2 | Returns a number from 1 to 5 indicating which week of the month this date falls in.
3 | > _function (optional dateTime
as nullable any, optional firstDayOfWeek
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns a number from 1 to 5 indicating which week of the year month the date dateTime
falls in.
7 | dateTime
: A datetime
value for which the week-of-the-month is determined.#date(2011, 03, 15)
).
14 | ```
15 | Date.WeekOfMonth(#date(2011, 03, 15))
16 | ```
17 | > 3
18 |
19 | ***
20 |
--------------------------------------------------------------------------------
/docs/Date/Date.WeekOfYear.md:
--------------------------------------------------------------------------------
1 | # Date.WeekOfYear
2 | Returns a number from 1 to 54 indicating which week of the year this date falls in.
3 | > _function (optional dateTime
as nullable any, optional firstDayOfWeek
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns a number from 1 to 54 indicating which week of the year the date, dateTime
, falls in.
7 | dateTime
: A datetime
value for which the week-of-the-year is determined.#date(2011, 03, 23)
).
14 | ```
15 | Date.WeekOfYear(#date(2011, 03, 23))
16 | ```
17 | > 13
18 |
19 | ***
20 |
--------------------------------------------------------------------------------
/docs/Date/Date.Year.md:
--------------------------------------------------------------------------------
1 | # Date.Year
2 | Returns the year component.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the year component of the provided datetime
value, dateTime
.
7 | # Category
8 | Date
9 | # Examples
10 | Find the year in #datetime(2011, 12, 31, 9, 15, 36).
11 | ```
12 | Date.Year(#datetime(2011, 12, 31, 9, 15, 36))
13 | ```
14 | > 2011
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Date/Time.StartOfHour.md:
--------------------------------------------------------------------------------
1 | # Time.StartOfHour
2 | Returns the first value of the hour.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the first value of the hour given a time
, datetime
or datetimezone
type.
7 | # Category
8 | Date
9 | # Examples
10 | Find the start of the hour for October 10th, 2011, 8:10:32AM (#datetime(2011, 10, 10, 8, 10, 32)
).
11 | ```
12 | Time.StartOfHour(#datetime(2011, 10, 10, 8, 10, 32))
13 | ```
14 | > #datetime(2011, 10, 10, 8, 0, 0)
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/DateTime/DateTime.AddZone.md:
--------------------------------------------------------------------------------
1 | # DateTime.AddZone
2 | Sets timezone information on the datetime value.
3 | > _function (optional dateTime
as nullable any, timezoneHours
as number, optional timezoneMinutes
as nullable any) as nullable any_
4 |
5 | # Description
6 | Sets timezone information to on the datetime value dateTime
. The timezone information will include timezoneHours
and optionally timezoneMinutes
.
7 | # Category
8 | DateTime
9 | # Examples
10 | Set timezone information for #datetime(2010, 12, 31, 11, 56, 02) to 7 hours, 30 minutes.
11 | ```
12 | DateTime.AddZone(#datetime(2010, 12, 31, 11, 56, 02), 7, 30)
13 | ```
14 | > #datetimezone(2010, 12, 31, 11, 56, 2, 7, 30)
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/DateTime/DateTime.Date.md:
--------------------------------------------------------------------------------
1 | # DateTime.Date
2 | Returns the date component of the given date, datetime, or datetimezone value.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the date component of dateTime
, the given date
, datetime
, or datetimezone
value.
7 | # Category
8 | DateTime
9 | # Examples
10 | Find date value of #datetime(2010, 12, 31, 11, 56, 02).
11 | ```
12 | DateTime.Date(#datetime(2010, 12, 31, 11, 56, 02))
13 | ```
14 | > #date(2010, 12, 31)
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/DateTime/DateTime.FixedLocalNow.md:
--------------------------------------------------------------------------------
1 | # DateTime.FixedLocalNow
2 | Returns the current date and time in the local timezone. This value is fixed and will not change with successive calls.
3 | > _function () as datetime_
4 |
5 | # Description
6 | Returns a datetime
value set to the current date and time on the system. This value is fixed and will not change with successive calls, unlike DateTime.LocalNow, which may return different values over the course of execution of an expression.
7 | # Category
8 | DateTime
9 |
--------------------------------------------------------------------------------
/docs/DateTime/DateTime.FromFileTime.md:
--------------------------------------------------------------------------------
1 | # DateTime.FromFileTime
2 | Creates a datetime from a 64 bits long number.
3 | > _function (optional fileTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Creates a datetime
value from the fileTime
value and converts it to the local time zone. The filetime is a Windows file time value that represents the number of 100-nanosecond intervals that have elapsed since 12:00 midnight, January 1, 1601 A.D. (C.E.) Coordinated Universal Time (UTC).
7 | # Category
8 | DateTime
9 | # Examples
10 | Convert 129876402529842245
into a datetime value.
11 | ```
12 | DateTime.FromFileTime(129876402529842245)
13 | ```
14 | > #datetime(2012, 7, 24, 14, 50, 52.9842245)
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/DateTime/DateTime.LocalNow.md:
--------------------------------------------------------------------------------
1 | # DateTime.LocalNow
2 | Returns the current date and time in the local timezone.
3 | > _function () as datetime_
4 |
5 | # Description
6 | Returns a datetime
value set to the current date and time on the system.
7 | # Category
8 | DateTime
9 |
--------------------------------------------------------------------------------
/docs/DateTime/DateTime.Time.md:
--------------------------------------------------------------------------------
1 | # DateTime.Time
2 | Returns the time part of the given datetime value.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the time part of the given datetime value, dateTime
.
7 | # Category
8 | DateTime
9 | # Examples
10 | Find the time value of #datetime(2010, 12, 31, 11, 56, 02).
11 | ```
12 | DateTime.Time(#datetime(2010, 12, 31, 11, 56, 02))
13 | ```
14 | > #time(11, 56, 2)
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/DateTimeZone/DateTimeZone.FixedLocalNow.md:
--------------------------------------------------------------------------------
1 | # DateTimeZone.FixedLocalNow
2 | Returns the current date & time in the local timezone. This value is fixed and will not change with successive calls.
3 | > _function () as datetimezone_
4 |
5 | # Description
6 | Returns a datetime
value set to the current date and time on the system. The returned value contains timezone information representing the local timezone. This value is fixed and will not change with successive calls, unlike DateTimeZone.LocalNow, which may return different values over the course of execution of an expression.
7 | # Category
8 | DateTimeZone
9 |
--------------------------------------------------------------------------------
/docs/DateTimeZone/DateTimeZone.FixedUtcNow.md:
--------------------------------------------------------------------------------
1 | # DateTimeZone.FixedUtcNow
2 | Returns the current date and time in UTC (the GMT timezone). This value is fixed and will not change with successive calls.
3 | > _function () as datetimezone_
4 |
5 | # Description
6 | Returns the current date and time in UTC (the GMT timezone). This value is fixed and will not change with successive calls.
7 | # Category
8 | DateTimeZone
9 |
--------------------------------------------------------------------------------
/docs/DateTimeZone/DateTimeZone.LocalNow.md:
--------------------------------------------------------------------------------
1 | # DateTimeZone.LocalNow
2 | Returns the current date & time in the local timezone.
3 | > _function () as datetimezone_
4 |
5 | # Description
6 | Returns a datetimezone
value set to the current date and time on the system.
7 | The returned value contains timezone information representing the local timezone.
8 | # Category
9 | DateTimeZone
10 |
--------------------------------------------------------------------------------
/docs/DateTimeZone/DateTimeZone.RemoveZone.md:
--------------------------------------------------------------------------------
1 | # DateTimeZone.RemoveZone
2 | Removes timezone information from the given datetimezone value.
3 | > _function (optional dateTimeZone
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns a #datetime value from dateTimeZone
with timezone information removed.
7 | # Category
8 | DateTimeZone
9 | # Examples
10 | Remove timezone information from the value #datetimezone(2011, 12, 31, 9, 15, 36, -7, 0).
11 | ```
12 | DateTimeZone.RemoveZone( #datetimezone(2011, 12, 31, 9, 15, 36,-7, 0))
13 | ```
14 | > #datetime(2011, 12, 31, 9, 15, 36)
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/DateTimeZone/DateTimeZone.ToUtc.md:
--------------------------------------------------------------------------------
1 | # DateTimeZone.ToUtc
2 | Converts the timezone component to UTC timezone.
3 | > _function (optional dateTimeZone
as nullable any) as nullable any_
4 |
5 | # Description
6 | Changes timezone information of the datetime value dateTimeZone
to the UTC or Universal Time timezone information.
7 | If dateTimeZone
does not have a timezone component, the UTC timezone information is added.
8 | # Category
9 | DateTimeZone
10 | # Examples
11 | Change timezone information for #datetimezone(2010, 12, 31, 11, 56, 02, 7, 30) to UTC timezone.
12 | ```
13 | DateTimeZone.ToUtc(#datetimezone(2010, 12, 31, 11, 56, 02, 7, 30))
14 | ```
15 | > #datetimezone(2010, 12, 31, 4, 26, 2, 0, 0)
16 |
17 | ***
18 |
--------------------------------------------------------------------------------
/docs/DateTimeZone/DateTimeZone.UtcNow.md:
--------------------------------------------------------------------------------
1 | # DateTimeZone.UtcNow
2 | Returns the current date and time in UTC (the GMT timezone).
3 | > _function () as datetimezone_
4 |
5 | # Description
6 | Returns the current date and time in UTC (the GMT timezone).
7 | # Category
8 | DateTimeZone
9 | # Examples
10 | Get the current date & time in UTC.
11 | ```
12 | DateTimeZone.UtcNow()
13 | ```
14 | > #datetimezone(2011, 8, 16, 23, 34, 37.745, 0, 0)
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/DateTimeZone/DateTimeZone.ZoneHours.md:
--------------------------------------------------------------------------------
1 | # DateTimeZone.ZoneHours
2 | Changes the timezone of the value.
3 | > _function (optional dateTimeZone
as nullable any) as nullable any_
4 |
5 | # Description
6 | Changes the timezone of the value.
7 | # Category
8 | DateTimeZone
9 |
--------------------------------------------------------------------------------
/docs/DateTimeZone/DateTimeZone.ZoneMinutes.md:
--------------------------------------------------------------------------------
1 | # DateTimeZone.ZoneMinutes
2 | Changes the timezone of the value.
3 | > _function (optional dateTimeZone
as nullable any) as nullable any_
4 |
5 | # Description
6 | Changes the timezone of the value.
7 | # Category
8 | DateTimeZone
9 |
--------------------------------------------------------------------------------
/docs/Diagnostics/Diagnostics.ActivityId.md:
--------------------------------------------------------------------------------
1 | # Diagnostics.ActivityId
2 | Returns an opaque identifier for the currently-running evaluation.
3 | > _function () as nullable any_
4 |
5 | # Description
6 | Returns an opaque identifier for the currently-running evaluation.
7 | # Category
8 | Diagnostics
9 |
--------------------------------------------------------------------------------
/docs/Duration/Duration.Days.md:
--------------------------------------------------------------------------------
1 | # Duration.Days
2 | Returns the days part of this duration.
3 | > _function (optional duration
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the day component of the provided duration
value, duration
.
7 | # Category
8 | Duration
9 | # Examples
10 | Find the day in #duration(5, 4, 3, 2).
11 | ```
12 | Duration.Days(#duration(5, 4, 3, 2))
13 | ```
14 | > 5
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Duration/Duration.Hours.md:
--------------------------------------------------------------------------------
1 | # Duration.Hours
2 | Returns the hours part of this duration.
3 | > _function (optional duration
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the hour component of the provided duration
value, duration
.
7 | # Category
8 | Duration
9 | # Examples
10 | Find the hours in #duration(5, 4, 3, 2).
11 | ```
12 | Duration.Hours(#duration(5, 4, 3, 2))
13 | ```
14 | > 4
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Duration/Duration.Minutes.md:
--------------------------------------------------------------------------------
1 | # Duration.Minutes
2 | Returns the minutes part of this duration.
3 | > _function (optional duration
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the minutes component of the provided duration
value, duration
.
7 | # Category
8 | Duration
9 | # Examples
10 | Find the minutes in #duration(5, 4, 3, 2).
11 | ```
12 | Duration.Minutes(#duration(5, 4, 3, 2))
13 | ```
14 | > 3
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Duration/Duration.Seconds.md:
--------------------------------------------------------------------------------
1 | # Duration.Seconds
2 | Returns the seconds part of this duration.
3 | > _function (optional duration
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the seconds component of the provided duration
value, duration
.
7 | # Category
8 | Duration
9 | # Examples
10 | Find the seconds in #duration(5, 4, 3, 2).
11 | ```
12 | Duration.Seconds(#duration(5, 4, 3, 2))
13 | ```
14 | > 2
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Duration/Duration.ToRecord.md:
--------------------------------------------------------------------------------
1 | # Duration.ToRecord
2 | Returns a record containing the parts of the duration.
3 | > _function (duration
as duration) as record_
4 |
5 | # Description
6 | Returns a record containing the parts the duration value, duration
.
7 | duration
: A duration
from which the record is created.#duration(2, 5, 55, 20)
into a record of its parts including days, hours, minutes and seconds if applicable.
14 | ```
15 | Duration.ToRecord(#duration(2, 5, 55, 20))
16 | ```
17 | > [Days = 2,
18 | Hours = 5,
19 | Minutes = 55,
20 | Seconds = 20]
21 |
22 | ***
23 |
--------------------------------------------------------------------------------
/docs/Duration/Duration.TotalDays.md:
--------------------------------------------------------------------------------
1 | # Duration.TotalDays
2 | Returns the total days this duration spans.
3 | > _function (optional duration
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the total days spanned by the provided duration
value, duration
.
7 | # Category
8 | Duration
9 | # Examples
10 | Find the total days spanned in #duration(5, 4, 3, 2).
11 | ```
12 | Duration.TotalDays(#duration(5, 4, 3, 2))
13 | ```
14 | > 5.1687731481481478
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Duration/Duration.TotalHours.md:
--------------------------------------------------------------------------------
1 | # Duration.TotalHours
2 | Returns the total hours this duration spans.
3 | > _function (optional duration
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the total hours spanned by the provided duration
value, duration
.
7 | # Category
8 | Duration
9 | # Examples
10 | Find the total hours spanned in #duration(5, 4, 3, 2).
11 | ```
12 | Duration.TotalHours(#duration(5, 4, 3, 2))
13 | ```
14 | > 124.05055555555555
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Duration/Duration.TotalMinutes.md:
--------------------------------------------------------------------------------
1 | # Duration.TotalMinutes
2 | Returns the total minutes this duration spans.
3 | > _function (optional duration
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the total minutes spanned by the provided duration
value, duration
.
7 | # Category
8 | Duration
9 | # Examples
10 | Find the total minutes spanned in #duration(5, 4, 3, 2).
11 | ```
12 | Duration.TotalMinutes(#duration(5, 4, 3, 2))
13 | ```
14 | > 7443.0333333333338
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Duration/Duration.TotalSeconds.md:
--------------------------------------------------------------------------------
1 | # Duration.TotalSeconds
2 | Returns the total seconds this duration spans.
3 | > _function (optional duration
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the total seconds spanned by the provided duration
value, duration
.
7 | # Category
8 | Duration
9 | # Examples
10 | Find the total seconds spanned in #duration(5, 4, 3, 2).
11 | ```
12 | Duration.TotalSeconds(#duration(5, 4, 3, 2))
13 | ```
14 | > 446582
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Error/Error.Record.md:
--------------------------------------------------------------------------------
1 | # Error.Record
2 | Returns an error record from the provided text values for reason, message and detail.
3 | > _function (reason
as text, optional message
as nullable any, optional detail
as nullable any) as record_
4 |
5 | # Description
6 | Returns an error record from the provided text values for reason, message and detail.
7 | # Category
8 | Error
9 |
--------------------------------------------------------------------------------
/docs/Expression/Expression.Constant.md:
--------------------------------------------------------------------------------
1 | # Expression.Constant
2 | Expression.Constant
3 | > _function (optional value
as nullable any) as text_
4 |
5 | # Description
6 | Expression.Constant
7 | # Category
8 | Expression
9 |
--------------------------------------------------------------------------------
/docs/Expression/Expression.Evaluate.md:
--------------------------------------------------------------------------------
1 | # Expression.Evaluate
2 | Expression.Evaluate
3 | > _function (document
as text, optional environment
as nullable record) as nullable any_
4 |
5 | # Description
6 | Expression.Evaluate
7 | # Category
8 | Expression
9 |
--------------------------------------------------------------------------------
/docs/Expression/Expression.Identifier.md:
--------------------------------------------------------------------------------
1 | # Expression.Identifier
2 | Expression.Identifier
3 | > _function (name
as text) as text_
4 |
5 | # Description
6 | Expression.Identifier
7 | # Category
8 | Expression
9 |
--------------------------------------------------------------------------------
/docs/Function/Function.Invoke.md:
--------------------------------------------------------------------------------
1 | # Function.Invoke
2 | Invokes the given function
3 | > _function (function
as function, args
as list) as nullable any_
4 |
5 | # Description
6 | Invokes the given function using the specified list of arguments and returns the result.
7 | # Category
8 | Function
9 | # Examples
10 | Invokes Record.FieldNames with one argument [A=1,B=2]
11 | ```
12 | Function.Invoke(Record.FieldNames, {[A=1,B=2]})
13 | ```
14 | > { "A", "B" }
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Function/Function.InvokeAfter.md:
--------------------------------------------------------------------------------
1 | # Function.InvokeAfter
2 | Invokes the given function after the specified duration has passed.
3 | > _function (function
as function, delay
as duration) as nullable any_
4 |
5 | # Description
6 | Returns the result of invoking function
after duration delay
has passed.
7 | # Category
8 | Function
9 |
--------------------------------------------------------------------------------
/docs/Lines/Lines.FromBinary.md:
--------------------------------------------------------------------------------
1 | # Lines.FromBinary
2 | Converts a binary value to a list of text values split at lines breaks. If a quote style is specified, then line breaks may appear within quotes. If includeLineSeparators is true, then the line break characters are included in the text.
3 | > _function (binary
as binary, optional quoteStyle
as nullable any, optional includeLineSeparators
as nullable any, optional encoding
as nullable any) as list_
4 |
5 | # Description
6 | Converts a binary value to a list of text values split at lines breaks. If a quote style is specified, then line breaks may appear within quotes. If includeLineSeparators is true, then the line break characters are included in the text.
7 | # Category
8 | Lines
9 |
--------------------------------------------------------------------------------
/docs/Lines/Lines.ToBinary.md:
--------------------------------------------------------------------------------
1 | # Lines.ToBinary
2 | Converts a list of text into a binary value using the specified encoding and lineSeparator.The specified lineSeparator is appended to each line. If not specified then the carriage return and line feed characters are used.
3 | > _function (lines
as list, optional lineSeparator
as nullable any, optional encoding
as nullable any, optional includeByteOrderMark
as nullable any) as binary_
4 |
5 | # Description
6 | Converts a list of text into a binary value using the specified encoding and lineSeparator.The specified lineSeparator is appended to each line. If not specified then the carriage return and line feed characters are used.
7 | # Category
8 | Lines
9 |
--------------------------------------------------------------------------------
/docs/Lines/Lines.ToText.md:
--------------------------------------------------------------------------------
1 | # Lines.ToText
2 | Converts a list of text into a single text. The specified lineSeparator is appended to each line. If not specified then the carriage return and line feed characters are used.
3 | > _function (lines
as list, optional lineSeparator
as nullable any) as text_
4 |
5 | # Description
6 | Converts a list of text into a single text. The specified lineSeparator is appended to each line. If not specified then the carriage return and line feed characters are used.
7 | # Category
8 | Lines
9 |
--------------------------------------------------------------------------------
/docs/List/List.Accumulate.md:
--------------------------------------------------------------------------------
1 | # List.Accumulate
2 | Accumulates a summary value from the items in the list.
3 | > _function (list
as list, optional seed
as nullable any, accumulator
as function) as nullable any_
4 |
5 | # Description
6 | Accumulates a summary value from the items in the list list
, using accumulator
.
7 | An optional seed parameter, seed
, may be set.
8 | # Category
9 | List.Transformation functions
10 | # Examples
11 | Accumulates the summary value from the items in the list {1, 2, 3, 4, 5} using ((state, current) => state + current ).
12 | ```
13 | List.Accumulate({1, 2, 3, 4, 5}, 0, (state, current) => state + current)
14 | ```
15 | > 15
16 |
17 | ***
18 |
--------------------------------------------------------------------------------
/docs/List/List.AllTrue.md:
--------------------------------------------------------------------------------
1 | # List.AllTrue
2 | Returns true if all expressions are true.
3 | > _function (list
as list) as logical_
4 |
5 | # Description
6 | Returns true if all expressions in the list list
are true.
7 | # Category
8 | List.Membership functions
9 | # Examples
10 | Determine if all the expressions in the list {true, true, 2 > 0} are true.
11 | ```
12 | List.AllTrue({true, true, 2 > 0})
13 | ```
14 | > true
15 |
16 | ***
17 | Determine if all the expressions in the list {true, true, 2 < 0} are true.
18 | ```
19 | List.AllTrue({true, false, 2 < 0})
20 | ```
21 | > false
22 |
23 | ***
24 |
--------------------------------------------------------------------------------
/docs/List/List.AnyTrue.md:
--------------------------------------------------------------------------------
1 | # List.AnyTrue
2 | Returns true if any expression is true.
3 | > _function (list
as list) as logical_
4 |
5 | # Description
6 | Returns true if any expression in the list list
is true.
7 | # Category
8 | List.Membership functions
9 | # Examples
10 | Determine if any of the expressions in the list {true, false, 2 > 0} are true.
11 | ```
12 | List.AnyTrue({true, false, 2>0})
13 | ```
14 | > true
15 |
16 | ***
17 | Determine if any of the expressions in the list {2 = 0, false, 2 < 0} are true.
18 | ```
19 | List.AnyTrue({2 = 0, false, 2 < 0})
20 | ```
21 | > false
22 |
23 | ***
24 |
--------------------------------------------------------------------------------
/docs/List/List.Buffer.md:
--------------------------------------------------------------------------------
1 | # List.Buffer
2 | Buffers a list.
3 | > _function (list
as list) as list_
4 |
5 | # Description
6 | Buffers the list list
in memory. The result of this call is a stable list.
7 | # Category
8 | List.Selection
9 | # Examples
10 | Create a stable copy of the list {1..10}.
11 | ```
12 | List.Buffer({1..10})
13 | ```
14 | > {1, 2, 3, 4, 5, 6, 7, 8, 9, 10}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.Combine.md:
--------------------------------------------------------------------------------
1 | # List.Combine
2 | Returns a single list by combining multiple lists.
3 | > _function (lists
as list) as list_
4 |
5 | # Description
6 | Takes a list of lists, lists
, and merges them into a single new list.
7 | # Category
8 | List.Transformation functions
9 | # Examples
10 | Combine the two simple lists {1, 2} and {3, 4}.
11 | ```
12 | List.Combine({ {1, 2}, {3, 4} })
13 | ```
14 | > {
15 | 1,
16 | 2,
17 | 3,
18 | 4
19 | }
20 |
21 | ***
22 | Combine the two lists, {1, 2} and {3, {4, 5} }, one of which contains a nested list.
23 | ```
24 | List.Combine({ {1, 2}, {3, {4, 5} }})
25 | ```
26 | > {
27 | 1,
28 | 2,
29 | 3, {4,
30 | 5}
31 | }
32 |
33 | ***
34 |
--------------------------------------------------------------------------------
/docs/List/List.Count.md:
--------------------------------------------------------------------------------
1 | # List.Count
2 | Returns the number of items in the list.
3 | > _function (list
as list) as number_
4 |
5 | # Description
6 | Returns the number of items in the list list
.
7 | # Category
8 | List.Information
9 | # Examples
10 | Find the number of values in the list {1, 2, 3}.
11 | ```
12 | List.Count({1, 2, 3})
13 | ```
14 | > 3
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.Covariance.md:
--------------------------------------------------------------------------------
1 | # List.Covariance
2 | Returns the covariance between the two lists of numbers.
3 | > _function (numberList1
as list, numberList2
as list) as nullable any_
4 |
5 | # Description
6 | Returns the covariance between two lists, numberList1
and numberList2
. numberList1
and numberList2
must contain the same number of number
values.
7 | # Category
8 | List.Numerics
9 | # Examples
10 | Calculate the covariance between two lists.
11 | ```
12 | List.Covariance({1, 2, 3},{1, 2, 3})
13 | ```
14 | > 0.66666666666666607
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.Distinct.md:
--------------------------------------------------------------------------------
1 | # List.Distinct
2 | Returns a list of values with duplicates removed.
3 | > _function (list
as list, optional equationCriteria
as nullable any) as list_
4 |
5 | # Description
6 | Returns a list that contains all the values in list list
with duplicates removed. If the list is empty, the result is an empty list.
7 | # Category
8 | List.Selection
9 | # Examples
10 | Remove the duplicates from the list {1, 1, 2, 3, 3, 3}.
11 | ```
12 | List.Distinct({1, 1, 2, 3, 3, 3})
13 | ```
14 | > {1, 2, 3}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.FindText.md:
--------------------------------------------------------------------------------
1 | # List.FindText
2 | Returns a list of values (including record fields) that contain the specified text.
3 | > _function (list
as list, text
as text) as list_
4 |
5 | # Description
6 | Returns a list of the values from the list list
which contained the value text
.
7 | # Category
8 | List.Selection
9 | # Examples
10 | Find the text values in the list {"a", "b", "ab"} that match "a".
11 | ```
12 | List.FindText({"a", "b", "ab"}, "a")
13 | ```
14 | > {"a", "ab"}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.Intersect.md:
--------------------------------------------------------------------------------
1 | # List.Intersect
2 | Returns the intersection of the list values found in the input.
3 | > _function (lists
as list, optional equationCriteria
as nullable any) as list_
4 |
5 | # Description
6 | Returns the intersection of the list values found in the input list lists
. An optional parameter, equationCriteria
, can be specifed.
7 | # Category
8 | List.Set operations
9 | # Examples
10 | Find the intersection of the lists {1..5}, {2..6}, {3..7}.
11 | ```
12 | List.Intersect({ {1..5}, {2..6}, {3..7} })
13 | ```
14 | > {3, 4, 5}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.IsDistinct.md:
--------------------------------------------------------------------------------
1 | # List.IsDistinct
2 | Indicates whether there are duplicates in the list.
3 | > _function (list
as list, optional equationCriteria
as nullable any) as logical_
4 |
5 | # Description
6 | Returns a logical value whether there are duplicates in the list list
; true
if the list is distinct, false
if there are duplicate values.
7 | # Category
8 | List.Selection
9 | # Examples
10 | Find if the list {1, 2, 3} is distinct (i.e. no duplicates).
11 | ```
12 | List.IsDistinct({1, 2, 3})
13 | ```
14 | > true
15 |
16 | ***
17 | Find if the list {1, 2, 3, 3} is distinct (i.e. no duplicates).
18 | ```
19 | List.IsDistinct({1, 2, 3, 3})
20 | ```
21 | > false
22 |
23 | ***
24 |
--------------------------------------------------------------------------------
/docs/List/List.IsEmpty.md:
--------------------------------------------------------------------------------
1 | # List.IsEmpty
2 | Returns true if the list is empty.
3 | > _function (list
as list) as logical_
4 |
5 | # Description
6 | Returns true
if the list, list
, contains no values (length 0). If the list contains values (length > 0), returns false
.
7 | # Category
8 | List.Information
9 | # Examples
10 | Find if the list {} is empty.
11 | ```
12 | List.IsEmpty({})
13 | ```
14 | > true
15 |
16 | ***
17 | Find if the list {1, 2} is empty.
18 | ```
19 | List.IsEmpty({1, 2})
20 | ```
21 | > false
22 |
23 | ***
24 |
--------------------------------------------------------------------------------
/docs/List/List.Last.md:
--------------------------------------------------------------------------------
1 | # List.Last
2 | Returns the last value of the list or the specified default if empty.
3 | > _function (list
as list, optional defaultValue
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the last item in the list list
, or the optional default value, defaultValue
, if the list is empty.
7 | If the list is empty and a default value is not specified, the function returns null
.
8 | # Category
9 | List.Selection
10 | # Examples
11 | Find the last value in the list {1, 2, 3}.
12 | ```
13 | List.Last({1, 2, 3})
14 | ```
15 | > 3
16 |
17 | ***
18 | Find the last value in the list {} or -1 if it empty.
19 | ```
20 | List.Last({}, -1)
21 | ```
22 | > -1
23 |
24 | ***
25 |
--------------------------------------------------------------------------------
/docs/List/List.NonNullCount.md:
--------------------------------------------------------------------------------
1 | # List.NonNullCount
2 | Returns the number of non-null items in the list.
3 | > _function (list
as list) as number_
4 |
5 | # Description
6 | Returns the number of non-null items in the list list
.
7 | # Category
8 | List.Information
9 |
--------------------------------------------------------------------------------
/docs/List/List.Positions.md:
--------------------------------------------------------------------------------
1 | # List.Positions
2 | Returns a list of offsets for the input.
3 | > _function (list
as list) as list_
4 |
5 | # Description
6 | Returns a list of offsets for the input list list
.
7 | When using List.Transform to change a list, the list of positions can be used to give the transform access to the position.
8 | # Category
9 | List.Selection
10 | # Examples
11 | Find the offsets of values in the list {1, 2, 3, 4, null, 5}.
12 | ```
13 | List.Positions({1, 2, 3, 4, null, 5})
14 | ```
15 | > {0, 1, 2, 3, 4, 5}
16 |
17 | ***
18 |
--------------------------------------------------------------------------------
/docs/List/List.Product.md:
--------------------------------------------------------------------------------
1 | # List.Product
2 | Returns the product of the numbers in the list.
3 | > _function (numbersList
as list, optional precision
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the product of the non-null numbers in the list, numbersList
. Returns null if there are no non-null values in the list.
7 | # Category
8 | List.Numerics
9 | # Examples
10 | Find the product of the numbers in the list {1, 2, 3, 3, 4, 5, 5}
.
11 | ```
12 | List.Product({1, 2, 3, 3, 4, 5, 5})
13 | ```
14 | > 1800
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.RemoveItems.md:
--------------------------------------------------------------------------------
1 | # List.RemoveItems
2 | Removes items from list1 that are present in list.
3 | > _function (list1
as list, list2
as list) as list_
4 |
5 | # Description
6 | Removes all occurrences of the given values in the list2
from list1
. If the values in list2
don't exist in list1
, the original list is returned.
7 | # Category
8 | List.Transformation functions
9 | # Examples
10 | Remove the items in the list {2, 4, 6} from the list {1, 2, 3, 4, 2, 5, 5}.
11 | ```
12 | List.RemoveItems({1, 2, 3, 4, 2, 5, 5}, {2, 4, 6})
13 | ```
14 | > {1, 3, 5, 5}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.RemoveNulls.md:
--------------------------------------------------------------------------------
1 | # List.RemoveNulls
2 | Removes all "null" values from the specified list.
3 | > _function (list
as list) as list_
4 |
5 | # Description
6 | Removes all occurrences of "null" values in the list
. If there are no 'null' values in the list, the original list is returned.
7 | # Category
8 | List.Transformation functions
9 | # Examples
10 | Remove the "null" values from the list {1, 2, 3, null, 4, 5, null, 6}.
11 | ```
12 | List.RemoveNulls({1, 2, 3, null, 4, 5, null, 6})
13 | ```
14 | > {1, 2, 3, 4, 5, 6}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.RemoveRange.md:
--------------------------------------------------------------------------------
1 | # List.RemoveRange
2 | Removes count number of values starting at the specified position.
3 | > _function (list
as list, index
as number, optional count
as nullable any) as list_
4 |
5 | # Description
6 | Removes count
values in the list
starting at the specified position, index
.
7 | # Category
8 | List.Transformation functions
9 | # Examples
10 | Remove 3 values in the list {1, 2, 3, 4, -6, -2, -1, 5} starting at index 4.
11 | ```
12 | List.RemoveRange({1, 2, 3, 4, -6, -2, -1, 5}, 4, 3)
13 | ```
14 | > {1, 2, 3, 4, 5}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.Repeat.md:
--------------------------------------------------------------------------------
1 | # List.Repeat
2 | Returns a list that is count repetitions of the original list.
3 | > _function (list
as list, count
as number) as list_
4 |
5 | # Description
6 | Returns a list that is count
repetitions of the original list, list
.
7 | # Category
8 | List.Transformation functions
9 | # Examples
10 | Create a list that has {1, 2} repeated 3 times.
11 | ```
12 | List.Repeat({1, 2}, 3)
13 | ```
14 | > {1, 2, 1, 2, 1, 2}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.ReplaceRange.md:
--------------------------------------------------------------------------------
1 | # List.ReplaceRange
2 | Replaces count number of values starting at position with the replacement values.
3 | > _function (list
as list, index
as number, count
as number, replaceWith
as list) as list_
4 |
5 | # Description
6 | Replaces count
values in the list
with the list replaceWith
, starting at specified position, index
.
7 | # Category
8 | List.Transformation functions
9 | # Examples
10 | Replace {7, 8, 9} in the list {1, 2, 7, 8, 9, 5} with {3, 4}.
11 | ```
12 | List.ReplaceRange({1, 2, 7, 8, 9, 5}, 2, 3, {3, 4})
13 | ```
14 | > {1, 2, 3, 4, 5}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.ReplaceValue.md:
--------------------------------------------------------------------------------
1 | # List.ReplaceValue
2 | Searches a list for the specified value and replaces it.
3 | > _function (list
as list, optional oldValue
as nullable any, optional newValue
as nullable any, replacer
as function) as list_
4 |
5 | # Description
6 | Searches a list of values, list
, for the value oldValue
and replaces each occurrence with the replacement value newValue
.
7 | # Category
8 | List.Transformation functions
9 | # Examples
10 | Replace all the "a" values in the list {"a", "B", "a", "a"} with "A".
11 | ```
12 | List.ReplaceValue({"a", "B", "a", "a"}, "a", "A", Replacer.ReplaceText)
13 | ```
14 | > {"A", "B", "A", "A"}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.Reverse.md:
--------------------------------------------------------------------------------
1 | # List.Reverse
2 | Reverses the order of values in the list.
3 | > _function (list
as list) as list_
4 |
5 | # Description
6 | Returns a list with the values in the list list
in reversed order.
7 | # Category
8 | List.Transformation functions
9 | # Examples
10 | Create a list from {1..10} in reverse order.
11 | ```
12 | List.Reverse({1..10})
13 | ```
14 | > {10, 9, 8, 7, 6, 5, 4, 3, 2, 1}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.Select.md:
--------------------------------------------------------------------------------
1 | # List.Select
2 | Returns a list of values that match the condition.
3 | > _function (list
as list, selection
as function) as list_
4 |
5 | # Description
6 | Returns a list of values from the list list
, that match the selection condition selection
.
7 | # Category
8 | List.Selection
9 | # Examples
10 | Find the values in the list {1, -3, 4, 9, -2} that are greater than 0.
11 | ```
12 | List.Select({1, -3, 4, 9, -2}, each _ > 0)
13 | ```
14 | > {1, 4, 9}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.Single.md:
--------------------------------------------------------------------------------
1 | # List.Single
2 | Returns the one list item for a list of length one, otherwise throws an exception.
3 | > _function (list
as list) as nullable any_
4 |
5 | # Description
6 | If there is only one item in the list list
, returns that item.
7 | If there is more than one item or the list is empty, the function throws an exception.
8 | # Category
9 | List.Selection
10 | # Examples
11 | Find the single value in the list {1}.
12 | ```
13 | List.Single({1})
14 | ```
15 | > 1
16 |
17 | ***
18 | Find the single value in the list {1, 2, 3}.
19 | ```
20 | List.Single({1, 2, 3})
21 | ```
22 | > [Expression.Error] There were too many elements in the enumeration to complete the operation.
23 |
24 | ***
25 |
--------------------------------------------------------------------------------
/docs/List/List.Split.md:
--------------------------------------------------------------------------------
1 | # List.Split
2 | Splits the specified list into a list of lists using the specified page size.
3 | > _function (list
as list, pageSize
as number) as list_
4 |
5 | # Description
6 | Splits list
into a list of lists where the first element of the output list is a list containing the first pageSize
elements from
7 | the source list, the next element of the output list is a list containing the next pageSize
elements from the source list, etc.
8 | # Category
9 | List.Transformation functions
10 |
--------------------------------------------------------------------------------
/docs/List/List.StandardDeviation.md:
--------------------------------------------------------------------------------
1 | # List.StandardDeviation
2 | Returns a sample based estimate of the standard deviation.
3 | > _function (numbersList
as list) as nullable any_
4 |
5 | # Description
6 | Returns a sample based estimate of the standard deviation of the values in the list, numbersList
.
7 | If numbersList
is a list of numbers, a number is returned.
8 | An exception is thrown on an empty list or a list of items that is not type number
.
9 | # Category
10 | List.Averages
11 | # Examples
12 | Find the standard deviation of the numbers 1 through 5.
13 | ```
14 | List.StandardDeviation({1..5})
15 | ```
16 | > 1.5811388300841898
17 |
18 | ***
19 |
--------------------------------------------------------------------------------
/docs/List/List.Sum.md:
--------------------------------------------------------------------------------
1 | # List.Sum
2 | Returns the sum of the items in the list.
3 | > _function (list
as list, optional precision
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the sum of the non-null values in the list, list
. Returns null if there are no non-null values in the list.
7 | # Category
8 | List.Addition
9 | # Examples
10 | Find the sum of the numbers in the list {1, 2, 3}
.
11 | ```
12 | List.Sum({1, 2, 3})
13 | ```
14 | > 6
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.Transform.md:
--------------------------------------------------------------------------------
1 | # List.Transform
2 | Returns a new list of values computed from this list.
3 | > _function (list
as list, transform
as function) as list_
4 |
5 | # Description
6 | Returns a new list of values by applying the transform function transform
to the list, list
.
7 | # Category
8 | List.Transformation functions
9 | # Examples
10 | Add 1 to each value in the list {1, 2}.
11 | ```
12 | List.Transform({1, 2}, each _ + 1)
13 | ```
14 | > {2, 3}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/List/List.Zip.md:
--------------------------------------------------------------------------------
1 | # List.Zip
2 | Returns a list of lists by combining items at the same position in multiple lists.
3 | > _function (lists
as list) as list_
4 |
5 | # Description
6 | Takes a list of lists, lists
, and returns a list of lists combining items at the same position.
7 | # Category
8 | List.Transformation functions
9 | # Examples
10 | Zips the two simple lists {1, 2} and {3, 4}.
11 | ```
12 | List.Zip({ {1, 2}, {3, 4} })
13 | ```
14 | > {
15 | { 1, 3 },
16 | { 2, 4 }
17 | }
18 |
19 | ***
20 | Zips the two simple lists of different lengths {1, 2} and {3}.
21 | ```
22 | List.Zip({ {1, 2}, {3} })
23 | ```
24 | > {
25 | { 1, 3 },
26 | { 2, null }
27 | }
28 |
29 | ***
30 |
--------------------------------------------------------------------------------
/docs/Logical/Logical.ToText.md:
--------------------------------------------------------------------------------
1 | # Logical.ToText
2 | Returns the text "true" or "false" given a logical value.
3 | > _function (optional logicalValue
as nullable any) as nullable any_
4 |
5 | # Description
6 | Creates a text value from the logical value logicalValue
, either true
or false
. If logicalValue
is not a logical value, an exception is thrown.
7 | # Category
8 | Logical
9 | # Examples
10 | Create a text value from the logical true
.
11 | ```
12 | Logical.ToText(true)
13 | ```
14 | > "true"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Metadata/Value.Metadata.md:
--------------------------------------------------------------------------------
1 | # Value.Metadata
2 | Returns a record containing the input's metadata.
3 | > _function (optional value
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns a record containing the input's metadata.
7 | # Category
8 | Metadata
9 |
--------------------------------------------------------------------------------
/docs/Metadata/Value.RemoveMetadata.md:
--------------------------------------------------------------------------------
1 | # Value.RemoveMetadata
2 | Strips the input of metadata.
3 | > _function (optional value
as nullable any, optional metaValue
as nullable any) as nullable any_
4 |
5 | # Description
6 | Strips the input of metadata.
7 | # Category
8 | Metadata
9 |
--------------------------------------------------------------------------------
/docs/Metadata/Value.ReplaceMetadata.md:
--------------------------------------------------------------------------------
1 | # Value.ReplaceMetadata
2 | Replaces the input's metadata information.
3 | > _function (optional value
as nullable any, optional metaValue
as nullable any) as nullable any_
4 |
5 | # Description
6 | Replaces the input's metadata information.
7 | # Category
8 | Metadata
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.Abs.md:
--------------------------------------------------------------------------------
1 | # Number.Abs
2 | Returns the absolute value of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the absolute value of number
. If number
is null, Number.Abs
returns null.
7 | number
: A number
for which the absolute value is to be calculated.number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the arccosine of number
.
7 | # Category
8 | Number.Trigonometry
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.Asin.md:
--------------------------------------------------------------------------------
1 | # Number.Asin
2 | Returns the arcsine of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the arcsine of number
.
7 | # Category
8 | Number.Trigonometry
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.Atan.md:
--------------------------------------------------------------------------------
1 | # Number.Atan
2 | Returns the arctangent of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the arctangent of number
.
7 | # Category
8 | Number.Trigonometry
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.Atan2.md:
--------------------------------------------------------------------------------
1 | # Number.Atan2
2 | Returns the arctangent of the division of the two numbers.
3 | > _function (optional y
as nullable any, optional x
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the arctangent of the division of the two numbers, y
and x
. The divison will be constructed as y
/x
.
7 | # Category
8 | Number.Trigonometry
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.BitwiseAnd.md:
--------------------------------------------------------------------------------
1 | # Number.BitwiseAnd
2 | Returns the result of performing a bitwise "And" operation between the two inputs.
3 | > _function (optional number1
as nullable any, optional number2
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of performing a bitwise "And" operation between number1
and number2
.
7 | # Category
8 | Number.Bytes
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.BitwiseNot.md:
--------------------------------------------------------------------------------
1 | # Number.BitwiseNot
2 | Returns a byte where each bit is the opposite of the input.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of performing a bitwise "Not" operation on number
.
7 | # Category
8 | Number.Bytes
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.BitwiseOr.md:
--------------------------------------------------------------------------------
1 | # Number.BitwiseOr
2 | Returns the result of performing a bitwise "Or" between the two inputs.
3 | > _function (optional number1
as nullable any, optional number2
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of performing a bitwise "Or" between number1
and number2
.
7 | # Category
8 | Number.Bytes
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.BitwiseShiftLeft.md:
--------------------------------------------------------------------------------
1 | # Number.BitwiseShiftLeft
2 | Shifts the bits set to the left.
3 | > _function (optional number1
as nullable any, optional number2
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of performing a bitwise shift to the left on number1
, by the specified number of bits number2
.
7 | # Category
8 | Number.Bytes
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.BitwiseShiftRight.md:
--------------------------------------------------------------------------------
1 | # Number.BitwiseShiftRight
2 | Shifts the bits set to the right.
3 | > _function (optional number1
as nullable any, optional number2
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of performing a bitwise shift to the right on number1
, by the specified number of bits number2
.
7 | # Category
8 | Number.Bytes
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.BitwiseXor.md:
--------------------------------------------------------------------------------
1 | # Number.BitwiseXor
2 | Returns the result of performing a bitwise "XOR" (Exclusive-OR) between the two inputs.
3 | > _function (optional number1
as nullable any, optional number2
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of performing a bitwise "XOR" (Exclusive-OR) between number1
and number2
.
7 | # Category
8 | Number.Bytes
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.Cos.md:
--------------------------------------------------------------------------------
1 | # Number.Cos
2 | Returns the cosine of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the cosine of number
.
7 | # Category
8 | Number.Trigonometry
9 | # Examples
10 | Find the cosine of the angle 0.
11 | ```
12 | Number.Cos(0)
13 | ```
14 | > 1
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Number/Number.Cosh.md:
--------------------------------------------------------------------------------
1 | # Number.Cosh
2 | Returns the hyperbolic cosine of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the hyperbolic cosine of number
.
7 | # Category
8 | Number.Trigonometry
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.Exp.md:
--------------------------------------------------------------------------------
1 | # Number.Exp
2 | Raises e to the given power.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of raising e to the power of number
(exponential function).
7 | number
: A number
for which the exponential function is to be calculated. If number
is null, Number.Exp
returns null. number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the factorial of the number number
.
7 | # Category
8 | Number.Operations
9 | # Examples
10 | Find the factorial of 10.
11 | ```
12 | Number.Factorial(10)
13 | ```
14 | > 3628800
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Number/Number.IsEven.md:
--------------------------------------------------------------------------------
1 | # Number.IsEven
2 | Indicates if the value is even.
3 | > _function (number
as number) as logical_
4 |
5 | # Description
6 | Indicates if the value, number
, is even by returning true
if it is even, false
otherwise.
7 | # Category
8 | Number.Information
9 | # Examples
10 | Check if 625 is an even number.
11 | ```
12 | Number.IsEven(625)
13 | ```
14 | > false
15 |
16 | ***
17 | Check if 82 is an even number.
18 | ```
19 | Number.IsEven(82)
20 | ```
21 | > true
22 |
23 | ***
24 |
--------------------------------------------------------------------------------
/docs/Number/Number.IsNaN.md:
--------------------------------------------------------------------------------
1 | # Number.IsNaN
2 | Indicates if the value is NaN (Not a number).
3 | > _function (number
as number) as logical_
4 |
5 | # Description
6 | Indicates if the value is NaN (Not a number). Returns true
if number
is equivalent to Number.IsNaN
, false
otherwise.
7 | # Category
8 | Number.Information
9 | # Examples
10 | Check if 0 divided by 0 is NaN.
11 | ```
12 | Number.IsNaN(0/0)
13 | ```
14 | > true
15 |
16 | ***
17 | Check if 1 divided by 0 is NaN.
18 | ```
19 | Number.IsNaN(1/0)
20 | ```
21 | > false
22 |
23 | ***
24 |
--------------------------------------------------------------------------------
/docs/Number/Number.IsOdd.md:
--------------------------------------------------------------------------------
1 | # Number.IsOdd
2 | Indicates if the value is odd.
3 | > _function (number
as number) as logical_
4 |
5 | # Description
6 | Indicates if the value is odd. Returns true
if number
is an odd number, false
otherwise.
7 | # Category
8 | Number.Information
9 | # Examples
10 | Check if 625 is an odd number.
11 | ```
12 | Number.IsOdd(625)
13 | ```
14 | > true
15 |
16 | ***
17 | Check if 82 is an odd number.
18 | ```
19 | Number.IsOdd(82)
20 | ```
21 | > false
22 |
23 | ***
24 |
--------------------------------------------------------------------------------
/docs/Number/Number.Ln.md:
--------------------------------------------------------------------------------
1 | # Number.Ln
2 | Returns the natural logarithm of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the natural logarithm of a number, number
. If number
is null Number.Ln
returns null.
7 | # Category
8 | Number.Operations
9 | # Examples
10 | Get the natural logarithm of 15.
11 | ```
12 | Number.Ln(15)
13 | ```
14 | > 2.70805020110221
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Number/Number.Log10.md:
--------------------------------------------------------------------------------
1 | # Number.Log10
2 | Returns the base 10 logarithm of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the base 10 logarithm of a number, number
. If number
is null Number.Log10
returns null.
7 | # Category
8 | Number.Operations
9 | # Examples
10 | Get the base 10 logarithm of 2.
11 | ```
12 | Number.Log10(2)
13 | ```
14 | > 0.3010299956639812
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Number/Number.Permutations.md:
--------------------------------------------------------------------------------
1 | # Number.Permutations
2 | Returns the number of permutations.
3 | > _function (optional setSize
as nullable any, optional permutationSize
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the number of permutations that can be generated from a number of items, setSize
, with a specified permutation size, permutationSize
.
7 | # Category
8 | Number.Operations
9 | # Examples
10 | Find the number of permutations from a total of 5 items in groups of 3.
11 | ```
12 | Number.Permutations(5, 3)
13 | ```
14 | > 60
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Number/Number.Power.md:
--------------------------------------------------------------------------------
1 | # Number.Power
2 | Raises a number to the given power.
3 | > _function (optional number
as nullable any, optional power
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of raising number
to the power of power
.
7 | If number
or power
are null, Number.Power
returns null.
8 | number
: The base.power
: The exponent.bottom
as number, top
as number) as number_
4 |
5 | # Description
6 | Returns a random number between bottom
and top
.
7 | # Category
8 | Number.Random
9 | # Examples
10 | Get a random number between 1 and 5.
11 | ```
12 | Number.RandomBetween(1, 5)
13 | ```
14 | > 2.546797
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Number/Number.RoundTowardZero.md:
--------------------------------------------------------------------------------
1 | # Number.RoundTowardZero
2 | Returns the result of rounding positive numbers down and negative numbers up. The number of digits can be specified.
3 | > _function (optional number
as nullable any, optional digits
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of rounding number
based on the sign of the number. This function will round positive numbers down and negative numbers up.
7 | If digits
is specified, number
is rounded to the digits
number of decimal digits.
8 | # Category
9 | Number.Rounding
10 |
--------------------------------------------------------------------------------
/docs/Number/Number.Sign.md:
--------------------------------------------------------------------------------
1 | # Number.Sign
2 | Returns 1 if the number is positive, -1 if it is negative, and 0 if it is zero.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns 1 for if number
is a positive number, -1 if it is a negative number, and 0 if it is zero.
7 | If number
is null, Number.Sign
returns null.
8 | # Category
9 | Number.Operations
10 | # Examples
11 | Determine the sign of 182.
12 | ```
13 | Number.Sign(182)
14 | ```
15 | > 1
16 |
17 | ***
18 | Determine the sign of -182.
19 | ```
20 | Number.Sign(-182)
21 | ```
22 | > -1
23 |
24 | ***
25 | Determine the sign of 0.
26 | ```
27 | Number.Sign(0)
28 | ```
29 | > 0
30 |
31 | ***
32 |
--------------------------------------------------------------------------------
/docs/Number/Number.Sin.md:
--------------------------------------------------------------------------------
1 | # Number.Sin
2 | Returns the sine of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the sine of number
.
7 | # Category
8 | Number.Trigonometry
9 | # Examples
10 | Find the sine of the angle 0.
11 | ```
12 | Number.Sin(0)
13 | ```
14 | > 0
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Number/Number.Sinh.md:
--------------------------------------------------------------------------------
1 | # Number.Sinh
2 | Returns the hyperbolic sine of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the hyperbolic sine of number
.
7 | # Category
8 | Number.Trigonometry
9 |
--------------------------------------------------------------------------------
/docs/Number/Number.Sqrt.md:
--------------------------------------------------------------------------------
1 | # Number.Sqrt
2 | Returns the square root of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the square root of number
.
7 | If number
is null, Number.Sqrt
returns null. If it is a negative value, Number.NaN
is returned (Not a number).
8 | # Category
9 | Number.Operations
10 | # Examples
11 | Find the square root of 625.
12 | ```
13 | Number.Sqrt(625)
14 | ```
15 | > 25
16 |
17 | ***
18 | Find the square root of 85.
19 | ```
20 | Number.Sqrt(85)
21 | ```
22 | > 9.2195444572928871
23 |
24 | ***
25 |
--------------------------------------------------------------------------------
/docs/Number/Number.Tan.md:
--------------------------------------------------------------------------------
1 | # Number.Tan
2 | Returns the tangent of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the tangent of number
.
7 | # Category
8 | Number.Trigonometry
9 | # Examples
10 | Find the tangent of the angle 1.
11 | ```
12 | Number.Tan(1)
13 | ```
14 | > 1.5574077246549023
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Number/Number.Tanh.md:
--------------------------------------------------------------------------------
1 | # Number.Tanh
2 | Returns the hyperbolic tangent of the number.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the hyperbolic tangent of number
.
7 | # Category
8 | Number.Trigonometry
9 |
--------------------------------------------------------------------------------
/docs/Record/Record.AddField.md:
--------------------------------------------------------------------------------
1 | # Record.AddField
2 | Adds a field to a record.
3 | > _function (record
as record, fieldName
as text, optional value
as nullable any, optional delayed
as nullable any) as record_
4 |
5 | # Description
6 | Adds a field to a record record
, given the name of the field fieldName
and the value value
.
7 | # Category
8 | Record.Transformations
9 | # Examples
10 | Add the field Address to the record.
11 | ```
12 | Record.AddField([CustomerID = 1, Name = "Bob", Phone = "123-4567"], "Address", "123 Main St.")
13 | ```
14 | > [CustomerID=1, Name= "Bob", Phone="123-4567", Address="123 Main St."]
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Record/Record.Combine.md:
--------------------------------------------------------------------------------
1 | # Record.Combine
2 | Combines the records in the given list.
3 | > _function (records
as list) as record_
4 |
5 | # Description
6 | Combines the records in the given records
. If the records
contains non-record values, an error is returned.
7 | # Category
8 | Record.Transformations
9 | # Examples
10 | Create a combined record from the records.
11 | ```
12 | Record.Combine({ [CustomerID =1, Name ="Bob"] , [Phone = "123-4567"]})
13 | ```
14 | > [CustomerID=1, Name="Bob", Phone="123-4567"]
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Record/Record.Field.md:
--------------------------------------------------------------------------------
1 | # Record.Field
2 | Returns the value of the specified field in a record.
3 | > _function (record
as record, field
as text) as nullable any_
4 |
5 | # Description
6 | Returns the value of the specified field
in the record
. If the field is not found, an exception is thrown.
7 | # Category
8 | Record.Selection
9 | # Examples
10 | Find the value of field "CustomerID" in the record.
11 | ```
12 | Record.Field([CustomerID = 1, Name = "Bob", Phone = "123-4567"], "CustomerID")
13 | ```
14 | > 1
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Record/Record.FieldCount.md:
--------------------------------------------------------------------------------
1 | # Record.FieldCount
2 | Returns the number of fields in the record.
3 | > _function (record
as record) as number_
4 |
5 | # Description
6 | Returns the number of fields in the record record
.
7 | # Category
8 | Record.Information
9 | # Examples
10 | Find the number of fields in the record.
11 | ```
12 | Record.FieldCount([CustomerID = 1, Name = "Bob"])
13 | ```
14 | > 2
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Record/Record.FieldNames.md:
--------------------------------------------------------------------------------
1 | # Record.FieldNames
2 | Returns the names of the fields.
3 | > _function (record
as record) as list_
4 |
5 | # Description
6 | Returns the names of the fields in the record record
as text.
7 | # Category
8 | Record.Selection
9 | # Examples
10 | Find the names of the fields in the record.
11 | ```
12 | Record.FieldNames([OrderID = 1, CustomerID = 1, Item = "Fishing rod", Price = 100.0])
13 | ```
14 | > {"OrderID","CustomerID", "Item", "Price"}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Record/Record.FieldValues.md:
--------------------------------------------------------------------------------
1 | # Record.FieldValues
2 | Returns a list of the field values.
3 | > _function (record
as record) as list_
4 |
5 | # Description
6 | Returns a list of the field values in record record
.
7 | # Category
8 | Record.Selection
9 | # Examples
10 | Find the field values in the record.
11 | ```
12 | Record.FieldValues([CustomerID = 1, Name = "Bob", Phone = "123-4567"])
13 | ```
14 | > {1, "Bob", "123-4567"}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Record/Record.SelectFields.md:
--------------------------------------------------------------------------------
1 | # Record.SelectFields
2 | Returns a record that contains only the specified fields.
3 | > _function (record
as record, optional fields
as nullable any, optional missingField
as nullable any) as record_
4 |
5 | # Description
6 | Returns a record which includes only the fields specified in list fields
from the input record
.
7 | # Category
8 | Record.Selection
9 | # Examples
10 | Select the fields "Item" and "Price" in the record.
11 | ```
12 | Record.SelectFields( [OrderID = 1, CustomerID = 1, Item = "Fishing rod", Price = 100.0] , {"Item", "Price"})
13 | ```
14 | > [Item = "Fishing rod", Price = 100]
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Record/Record.ToList.md:
--------------------------------------------------------------------------------
1 | # Record.ToList
2 | Returns a list of values containing the field values of the input record.
3 | > _function (record
as record) as list_
4 |
5 | # Description
6 | Returns a list of values containing the field values from the input record
.
7 | # Category
8 | Record.Serialization
9 | # Examples
10 | Extract the field values from a record.
11 | ```
12 | Record.ToList([A = 1, B = 2, C = 3])
13 | ```
14 | > {1, 2, 3}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Record/Record.ToTable.md:
--------------------------------------------------------------------------------
1 | # Record.ToTable
2 | Returns a table with each row being a field name and value of the input record.
3 | > _function (record
as record) as table_
4 |
5 | # Description
6 | Returns a table containing the columns Name
and Value
with a row for each field in record
.
7 | # Category
8 | Record.Serialization
9 | # Examples
10 | Return the table from the record.
11 | ```
12 | Record.ToTable([OrderID = 1, CustomerID = 1, Item = "Fishing rod", Price = 100.0])
13 | ```
14 | > Table.FromRecords({[Name="OrderID", Value=1],[Name="CustomerID", Value=1],[Name="Item", Value="Fishing rod"],[Name="Price", Value=100]})
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Replacer/Replacer.ReplaceText.md:
--------------------------------------------------------------------------------
1 | # Replacer.ReplaceText
2 | Replaces text within the provided input.
3 | > _function (optional text
as nullable any, old
as text, new
as text) as nullable any_
4 |
5 | # Description
6 | Replaces the old
text in the original text
with the new
text. This replacer function can be used in List.ReplaceValue
and Table.ReplaceValue
.
7 | # Category
8 | Replacer
9 | # Examples
10 | Replace the text "hE" with "He" in the string "hEllo world".
11 | ```
12 | Replacer.ReplaceText("hEllo world","hE","He")
13 | ```
14 | > "Hello world"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Replacer/Replacer.ReplaceValue.md:
--------------------------------------------------------------------------------
1 | # Replacer.ReplaceValue
2 | Replaces values within the provided input.
3 | > _function (optional value
as nullable any, optional old
as nullable any, optional new
as nullable any) as nullable any_
4 |
5 | # Description
6 | Replaces the old
value in the original value
with the new
value. This replacer function can be used in List.ReplaceValue
and Table.ReplaceValue
.
7 | # Category
8 | Replacer
9 | # Examples
10 | Replace the value 11 with the value 10.
11 | ```
12 | Replacer.ReplaceValue(11, 11, 10)
13 | ```
14 | > 10
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Splitter/Splitter.SplitByNothing.md:
--------------------------------------------------------------------------------
1 | # Splitter.SplitByNothing
2 | Returns a function that does no splitting, returning its argument as a single element list.
3 | > _function () as function_
4 |
5 | # Description
6 | Returns a function that does no splitting, returning its argument as a single element list.
7 | # Category
8 | Splitter
9 |
--------------------------------------------------------------------------------
/docs/Splitter/Splitter.SplitTextByAnyDelimiter.md:
--------------------------------------------------------------------------------
1 | # Splitter.SplitTextByAnyDelimiter
2 | Returns a function that splits text into a list of text at any of the specified delimiters.
3 | > _function (delimiters
as list, optional quoteStyle
as nullable any, optional startAtEnd
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that splits text into a list of text at any of the specified delimiters.
7 | # Category
8 | Splitter
9 |
--------------------------------------------------------------------------------
/docs/Splitter/Splitter.SplitTextByDelimiter.md:
--------------------------------------------------------------------------------
1 | # Splitter.SplitTextByDelimiter
2 | Returns a function that splits text into a list of text according to the specified delimiter.
3 | > _function (delimiter
as text, optional quoteStyle
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that splits text into a list of text according to the specified delimiter.
7 | # Category
8 | Splitter
9 |
--------------------------------------------------------------------------------
/docs/Splitter/Splitter.SplitTextByEachDelimiter.md:
--------------------------------------------------------------------------------
1 | # Splitter.SplitTextByEachDelimiter
2 | Returns a function that splits text into a list of text at each specified delimiter in sequence.
3 | > _function (delimiters
as list, optional quoteStyle
as nullable any, optional startAtEnd
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that splits text into a list of text at each specified delimiter in sequence.
7 | # Category
8 | Splitter
9 |
--------------------------------------------------------------------------------
/docs/Splitter/Splitter.SplitTextByLengths.md:
--------------------------------------------------------------------------------
1 | # Splitter.SplitTextByLengths
2 | Returns a function that splits text into a list of text by each specified length.
3 | > _function (lengths
as list, optional startAtEnd
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that splits text into a list of text by each specified length.
7 | # Category
8 | Splitter
9 |
--------------------------------------------------------------------------------
/docs/Splitter/Splitter.SplitTextByPositions.md:
--------------------------------------------------------------------------------
1 | # Splitter.SplitTextByPositions
2 | Returns a function that splits text into a list of text at each specified position.
3 | > _function (positions
as list, optional startAtEnd
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that splits text into a list of text at each specified position.
7 | # Category
8 | Splitter
9 |
--------------------------------------------------------------------------------
/docs/Splitter/Splitter.SplitTextByRanges.md:
--------------------------------------------------------------------------------
1 | # Splitter.SplitTextByRanges
2 | Returns a function that splits text into a list of text according to the specified offsets and lengths.
3 | > _function (ranges
as list, optional startAtEnd
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that splits text into a list of text according to the specified offsets and lengths.
7 | # Category
8 | Splitter
9 |
--------------------------------------------------------------------------------
/docs/Splitter/Splitter.SplitTextByRepeatedLengths.md:
--------------------------------------------------------------------------------
1 | # Splitter.SplitTextByRepeatedLengths
2 | Returns a function that splits text into a list of text after the specified length repeatedly.
3 | > _function (length
as number, optional startAtEnd
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that splits text into a list of text after the specified length repeatedly.
7 | # Category
8 | Splitter
9 |
--------------------------------------------------------------------------------
/docs/Splitter/Splitter.SplitTextByWhitespace.md:
--------------------------------------------------------------------------------
1 | # Splitter.SplitTextByWhitespace
2 | Returns a function that splits text into a list of text at whitespace.
3 | > _function (optional quoteStyle
as nullable any) as function_
4 |
5 | # Description
6 | Returns a function that splits text into a list of text at whitespace.
7 | # Category
8 | Splitter
9 |
--------------------------------------------------------------------------------
/docs/Table/RowExpression.Column.md:
--------------------------------------------------------------------------------
1 | # RowExpression.Column
2 | Returns an AST that represents access to a column within a row expression.
3 | > _function (columnName
as text) as record_
4 |
5 | # Description
6 | Returns an AST that represents access to column columnName
of the row within a row expression.
7 | # Category
8 | Table.Table construction
9 | # Examples
10 | Creates an AST representing access of column "CustomerName".
11 | ```
12 | RowExpression.Column("CustomerName")
13 | ```
14 | > [
15 | Kind = "FieldAccess",
16 | Expression = RowExpression.Row,
17 | MemberName = "CustomerName"
18 | ]
19 |
20 | ***
21 |
--------------------------------------------------------------------------------
/docs/Table/Table.Buffer.md:
--------------------------------------------------------------------------------
1 | # Table.Buffer
2 | Buffers a table in memory, isolating it from external changes during evaluation.
3 | > _function (table
as table) as table_
4 |
5 | # Description
6 | Buffers a table in memory, isolating it from external changes during evaluation.
7 | # Category
8 | Table.Other
9 |
--------------------------------------------------------------------------------
/docs/Table/Table.Column.md:
--------------------------------------------------------------------------------
1 | # Table.Column
2 | Returns a specified column of data from the table as a list.
3 | > _function (table
as table, column
as text) as list_
4 |
5 | # Description
6 | Returns the column of data specified by column
from the table table
as a list.
7 | # Category
8 | Table.Column operations
9 | # Examples
10 | Returns the values from the [Name] column in the table.
11 | ```
12 | Table.Column(Table.FromRecords({ [CustomerID = 1, Name = "Bob", Phone = "123-4567"], [CustomerID = 2, Name = "Jim", Phone = "987-6543"], [CustomerID = 3, Name = "Paul", Phone = "543-7890"], [CustomerID = 4, Name = "Ringo", Phone = "232-1550"]}), "Name")
13 | ```
14 | > {"Bob", "Jim", "Paul", "Ringo"}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Table/Table.ColumnCount.md:
--------------------------------------------------------------------------------
1 | # Table.ColumnCount
2 | Returns the number of columns in the table.
3 | > _function (table
as table) as number_
4 |
5 | # Description
6 | Returns the number of columns in the table table
.
7 | # Category
8 | Table.Information
9 | # Examples
10 | Find the number of columns in the table.
11 | ```
12 | Table.ColumnCount(Table.FromRecords({[CustomerID =1, Name ="Bob", Phone = "123-4567"],[CustomerID =2, Name ="Jim", Phone = "987-6543"],[CustomerID =3, Name ="Paul", Phone = "543-7890"]}))
13 | ```
14 | > 3
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Table/Table.ColumnNames.md:
--------------------------------------------------------------------------------
1 | # Table.ColumnNames
2 | Returns the column names as a list.
3 | > _function (table
as table) as list_
4 |
5 | # Description
6 | Returns the column names in the table table
as a list of text.
7 | # Category
8 | Table.Column operations
9 | # Examples
10 | Find the column names of the table.
11 | ```
12 | Table.ColumnNames(Table.FromRecords({ [CustomerID = 1, Name = "Bob", Phone = "123-4567"], [CustomerID = 2, Name = "Jim", Phone = "987-6543"] , [CustomerID = 3, Name = "Paul", Phone = "543-7890"] , [CustomerID = 4, Name = "Ringo", Phone = "232-1550"]}))
13 | ```
14 | > {"CustomerID", "Name", "Phone"}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Table/Table.ColumnsOfType.md:
--------------------------------------------------------------------------------
1 | # Table.ColumnsOfType
2 | Returns a list with the names of the columns that match the specified types.
3 | > _function (table
as table, listOfTypes
as list) as list_
4 |
5 | # Description
6 | Returns a list with the names of the columns from table table
that match the types specified in listOfTypes
.
7 | # Category
8 | Table.Column operations
9 | # Examples
10 | Return the names of columns of type Number.Type from the table.
11 | ```
12 | Table.ColumnsOfType(Table.FromRecords({[a=1,b="hello"]}, type table[a=Number.Type, b=Text.Type]), {type number})
13 | ```
14 | > {"a"}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Table/Table.CombineColumns.md:
--------------------------------------------------------------------------------
1 | # Table.CombineColumns
2 | Combines the specified columns into a new column using the specified combiner function.
3 | > _function (table
as table, sourceColumns
as list, combiner
as function, column
as text) as table_
4 |
5 | # Description
6 | Combines the specified columns into a new column using the specified combiner function.
7 | # Category
8 | Table.Transformation
9 |
--------------------------------------------------------------------------------
/docs/Table/Table.FilterWithDataTable.md:
--------------------------------------------------------------------------------
1 | # Table.FilterWithDataTable
2 | Table.FilterWithDataTable
3 | > _function (table
as table, dataTableIdentifier
as text) as nullable any_
4 |
5 | # Description
6 | Table.FilterWithDataTable
7 | # Category
8 | Table.Transformation
9 |
--------------------------------------------------------------------------------
/docs/Table/Table.FirstValue.md:
--------------------------------------------------------------------------------
1 | # Table.FirstValue
2 | Returns the first column of the first row of the table or a specified default value.
3 | > _function (table
as table, optional default
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the first column of the first row of the table table
or a specified default value.
7 | # Category
8 | Table.Row operations
9 |
--------------------------------------------------------------------------------
/docs/Table/Table.Keys.md:
--------------------------------------------------------------------------------
1 | # Table.Keys
2 | Table.Keys
3 | > _function (table
as table) as list_
4 |
5 | # Description
6 | Table.Keys
7 | # Category
8 | Table.Transformation
9 |
--------------------------------------------------------------------------------
/docs/Table/Table.Profile.md:
--------------------------------------------------------------------------------
1 | # Table.Profile
2 | Returns a profile of the columns of a table.
3 | > _function (table
as table) as table_
4 |
5 | # Description
6 | Returns a profile for the columns in table
.
The following information is returned for each column (when applicable): 8 |
table
as table, keys
as list) as table_
4 |
5 | # Description
6 | Table.ReplaceKeys
7 | # Category
8 | Table.Transformation
9 |
--------------------------------------------------------------------------------
/docs/Table/Table.ReplaceRelationshipIdentity.md:
--------------------------------------------------------------------------------
1 | # Table.ReplaceRelationshipIdentity
2 | Table.ReplaceRelationshipIdentity
3 | > _function (optional value
as nullable any, identity
as text) as nullable any_
4 |
5 | # Description
6 | Table.ReplaceRelationshipIdentity
7 | # Category
8 | Table.Transformation
9 |
--------------------------------------------------------------------------------
/docs/Table/Table.RowCount.md:
--------------------------------------------------------------------------------
1 | # Table.RowCount
2 | Returns the number of rows in the table.
3 | > _function (table
as table) as number_
4 |
5 | # Description
6 | Returns the number of rows in the table
.
7 | # Category
8 | Table.Information
9 | # Examples
10 | Find the number of rows in the table.
11 | ```
12 | Table.RowCount(Table.FromRecords({[CustomerID =1, Name ="Bob", Phone = "123-4567"],[CustomerID =2, Name ="Jim", Phone = "987-6543"],[CustomerID =3, Name ="Paul", Phone = "543-7890"]}))
13 | ```
14 | > 3
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Table/Table.SingleRow.md:
--------------------------------------------------------------------------------
1 | # Table.SingleRow
2 | Returns the single row in the table.
3 | > _function (table
as table) as record_
4 |
5 | # Description
6 | Returns the single row in the one row table
. If the table
has more than one row, an exception is thrown.
7 | # Category
8 | Table.Row operations
9 | # Examples
10 | Return the single row in the table.
11 | ```
12 | Table.SingleRow(Table.FromRecords({[CustomerID = 1, Name = "Bob", Phone = "123-4567"]}))
13 | ```
14 | > [CustomerID = 1, Name = "Bob", Phone = "123-4567"]
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Table/Table.ToColumns.md:
--------------------------------------------------------------------------------
1 | # Table.ToColumns
2 | Creates a list of nested lists of column values from a table.
3 | > _function (table
as table) as list_
4 |
5 | # Description
6 | Creates a list of nested lists from the table, table
. Each list item is an inner list that contains the column values.
7 | # Category
8 | Table.Conversions
9 | # Examples
10 | Create a list of the column values from the table.
11 | ```
12 | Table.ToColumns(Table.FromRecords({[CustomerID = 1, Name = "Bob", Phone = "123-4567"], [CustomerID = 2, Name = "Jim", Phone = "987-6543"] }))
13 | ```
14 | > { {1, 2},{"Bob", "Jim"},{ "123-4567", "987-6543"} }
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Table/Table.ToRecords.md:
--------------------------------------------------------------------------------
1 | # Table.ToRecords
2 | Converts a table to a list of records.
3 | > _function (table
as table) as list_
4 |
5 | # Description
6 | Converts a table, table
, to a list of records.
7 | # Category
8 | Table.Conversions
9 | # Examples
10 | Convert the table to a list of records.
11 | ```
12 | Table.ToRecords(Table.FromRows({ {1, "Bob", "123-4567"} , {2, "Jim", "987-6543"}, {3, "Paul", "543-7890"} },{"CustomerID", "Name", "Phone"}))
13 | ```
14 | > {[CustomerID = 1, Name = "Bob", Phone = "123-4567"], [CustomerID = 2, Name = "Jim", Phone = "987-6543"], [CustomerID = 3, Name = "Paul", Phone = "543-7890"]}
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Table/Table.ToRows.md:
--------------------------------------------------------------------------------
1 | # Table.ToRows
2 | Creates a list of nested lists of row values from a table.
3 | > _function (table
as table) as list_
4 |
5 | # Description
6 | Creates a list of nested lists from the table, table
. Each list item is an inner list that contains the row values.
7 | # Category
8 | Table.Conversions
9 | # Examples
10 | Create a list of the row values from the table.
11 | ```
12 | Table.ToRows(Table.FromRecords({[CustomerID =1, Name ="Bob", Phone = "123-4567"],[CustomerID =2, Name ="Jim", Phone = "987-6543"],[CustomerID =3, Name ="Paul", Phone = "543-7890"]}))
13 | ```
14 | > { {1, "Bob", "123-4567"},{2, "Jim", "987-6543"},{3, "Paul", "543-7890"} }
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Table/Tables.GetRelationships.md:
--------------------------------------------------------------------------------
1 | # Tables.GetRelationships
2 | Gets the relationships among a set of tables.
3 | > _function (tables
as table, optional dataColumn
as nullable any) as table_
4 |
5 | # Description
6 | Gets the relationships among a set of tables. The set tables
is assumed to have a structure similar to that of a navigation table. The column defined by dataColumn
contains the actual data tables.
7 | # Category
8 | Table.Information
9 |
--------------------------------------------------------------------------------
/docs/Text/Character.FromNumber.md:
--------------------------------------------------------------------------------
1 | # Character.FromNumber
2 | Converts the number to its character value.
3 | > _function (optional number
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the character equivalent of the number.
7 | # Category
8 | Text.Conversions from and to text
9 | # Examples
10 | Given the number 9, find the character value.
11 | ```
12 | Character.FromNumber(9)
13 | ```
14 | > "#(tab)"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Character.ToNumber.md:
--------------------------------------------------------------------------------
1 | # Character.ToNumber
2 | Converts a character to its number value.
3 | > _function (optional character
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the number equivalent of the character, character
.
7 | # Category
8 | Text.Conversions from and to text
9 | # Examples
10 | Given the character "#(tab)" 9, find the number value.
11 | ```
12 | Character.ToNumber("#(tab)")
13 | ```
14 | > 9
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.At.md:
--------------------------------------------------------------------------------
1 | # Text.At
2 | Returns the character at the specified position.
3 | > _function (optional text
as nullable any, index
as number) as nullable any_
4 |
5 | # Description
6 | Returns the character in the text value, text
at position index
. The first character in the text is at position 0.
7 | # Category
8 | Text.Extraction
9 | # Examples
10 | Find the character at position 4 in string "Hello, World".
11 | ```
12 | Text.At("Hello, World", 4)
13 | ```
14 | > "o"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.Clean.md:
--------------------------------------------------------------------------------
1 | # Text.Clean
2 | Returns the text value with all non-printable characters removed.
3 | > _function (optional text
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns a text value with all non-printable characters of text
removed.
7 | # Category
8 | Text.Transformations
9 | # Examples
10 | Remove line feeds and other non-printable characters from a text value.
11 | ```
12 | Text.Clean("ABC#(lf)D")
13 | ```
14 | > "ABCD"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.End.md:
--------------------------------------------------------------------------------
1 | # Text.End
2 | Returns the last characters of the text.
3 | > _function (optional text
as nullable any, count
as number) as nullable any_
4 |
5 | # Description
6 | Returns a text
value that is the last count
characters of the text
value text
.
7 | # Category
8 | Text.Extraction
9 | # Examples
10 | Get the last 5 characters of the text "Hello, World".
11 | ```
12 | Text.End("Hello, World", 5)
13 | ```
14 | > "World"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.FromBinary.md:
--------------------------------------------------------------------------------
1 | # Text.FromBinary
2 | Decodes data from a binary form into text.
3 | > _function (optional binary
as nullable any, optional encoding
as nullable any) as nullable any_
4 |
5 | # Description
6 | Decodes data, binary
, from a binary value in to a text value, using encoding
type.
7 | # Category
8 | Text.Conversions from and to text
9 |
--------------------------------------------------------------------------------
/docs/Text/Text.Insert.md:
--------------------------------------------------------------------------------
1 | # Text.Insert
2 | Inserts one text value into another at a given position.
3 | > _function (optional text
as nullable any, offset
as number, newText
as text) as nullable any_
4 |
5 | # Description
6 | Returns the result of inserting text value newText
into the text value text
at position offset
. Positions start at number 0.
7 | # Category
8 | Text.Modification
9 | # Examples
10 | Insert "C" between "B" and "D" in "ABD".
11 | ```
12 | Text.Insert("ABD", 2, "C")
13 | ```
14 | > "ABCD"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.Length.md:
--------------------------------------------------------------------------------
1 | # Text.Length
2 | Returns the number of characters.
3 | > _function (optional text
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the number of characters in the text text
.
7 | # Category
8 | Text.Information
9 | # Examples
10 | Find how many characters are in the text "Hello World".
11 | ```
12 | Text.Length("Hello World")
13 | ```
14 | > 11
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.Lower.md:
--------------------------------------------------------------------------------
1 | # Text.Lower
2 | Converts all characters to lowercase.
3 | > _function (optional text
as nullable any, optional culture
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of converting all characters in text
to lowercase.
7 | # Category
8 | Text.Transformations
9 | # Examples
10 | Get the lowercase version of "AbCd".
11 | ```
12 | Text.Lower("AbCd")
13 | ```
14 | > "abcd"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.NewGuid.md:
--------------------------------------------------------------------------------
1 | # Text.NewGuid
2 | Returns a new, random globally unique identifier (GUID).
3 | > _function () as text_
4 |
5 | # Description
6 | Returns a new, random globally unique identifier (GUID).
7 | # Category
8 | Text.Conversions from and to text
9 |
--------------------------------------------------------------------------------
/docs/Text/Text.Proper.md:
--------------------------------------------------------------------------------
1 | # Text.Proper
2 | Capitalizes the first letter of each word.
3 | > _function (optional text
as nullable any, optional culture
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of capitalizing only the first letter of each word in text value text
. All other letters are returned in lowercase.
7 | # Category
8 | Text.Transformations
9 | # Examples
10 | Use Text.Proper
on a simple sentence.
11 | ```
12 | Text.Proper("the QUICK BrOWn fOx jUmPs oVER tHe LAzy DoG")
13 | ```
14 | > "The Quick Brown Fox Jumps Over The Lazy Dog"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.Remove.md:
--------------------------------------------------------------------------------
1 | # Text.Remove
2 | Removes all occurrences of the given character or list of characters from the input text value.
3 | > _function (optional text
as nullable any, optional removeChars
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns a copy of the text value text
with all the characters from removeChars
removed.
7 | # Category
8 | Text.Modification
9 | # Examples
10 | Remove characters , and ; from the text value.
11 | ```
12 | Text.Remove("a,b;c",{",",";"})
13 | ```
14 | > "abc"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.Repeat.md:
--------------------------------------------------------------------------------
1 | # Text.Repeat
2 | Returns a text value composed of the input text repeated a specified number of times.
3 | > _function (optional text
as nullable any, count
as number) as nullable any_
4 |
5 | # Description
6 | Returns a text value composed of the input text text
repeated count
times.
7 | # Category
8 | Text.Transformations
9 | # Examples
10 | Repeat the text "a" five times.
11 | ```
12 | Text.Repeat("a", 5)
13 | ```
14 | > "aaaaa"
15 |
16 | ***
17 | Repeat the text "helloworld" three times.
18 | ```
19 | Text.Repeat("helloworld.", 3)
20 | ```
21 | > "helloworld.helloworld.helloworld."
22 |
23 | ***
24 |
--------------------------------------------------------------------------------
/docs/Text/Text.Replace.md:
--------------------------------------------------------------------------------
1 | # Text.Replace
2 | Replaces all occurrences of the given substring in the text.
3 | > _function (optional text
as nullable any, old
as text, new
as text) as nullable any_
4 |
5 | # Description
6 | Returns the result of replacing all occurrences of text value old
in text value text
with text value new
. This function is case sensitive.
7 | # Category
8 | Text.Modification
9 | # Examples
10 | Replace every occurrence of "the" in a sentence with "a".
11 | ```
12 | Text.Replace("the quick brown fox jumps over the lazy dog", "the", "a")
13 | ```
14 | > "a quick brown fox jumps over a lazy dog"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.Reverse.md:
--------------------------------------------------------------------------------
1 | # Text.Reverse
2 | Text.Reverse
3 | > _function (optional text
as nullable any) as nullable any_
4 |
5 | # Description
6 | Reverses the provided text
.
7 | # Category
8 | Text.Transformations
9 | # Examples
10 | Reverse the text "123".
11 | ```
12 | Text.Reverse("123")
13 | ```
14 | > "321"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.Select.md:
--------------------------------------------------------------------------------
1 | # Text.Select
2 | Selects all occurrences of the given character or list of characters from the input text value.
3 | > _function (optional text
as nullable any, optional selectChars
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns a copy of the text value text
with all the characters not in selectChars
removed.
7 | # Category
8 | Text.Modification
9 | # Examples
10 | Select all characters in the range of 'a' to 'z' from the text value.
11 | ```
12 | Text.Select("a,b;c", {"a".."z"})
13 | ```
14 | > "abc"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.Split.md:
--------------------------------------------------------------------------------
1 | # Text.Split
2 | Splits text into a list of text values based upon a specified delimiter.
3 | > _function (text
as text, separator
as text) as list_
4 |
5 | # Description
6 | Returns a list of text values resulting from the splitting a text value text
based on the specified delimiter, separator
.
7 | # Category
8 | Text.Transformations
9 | # Examples
10 | Create a list from the "|" delimited text value "Name|Address|PhoneNumber".
11 | ```
12 | Text.Split("Name|Address|PhoneNumber", "|")
13 | ```
14 | > {
15 | "Name",
16 | "Address",
17 | "PhoneNumber"
18 | }
19 |
20 | ***
21 |
--------------------------------------------------------------------------------
/docs/Text/Text.Start.md:
--------------------------------------------------------------------------------
1 | # Text.Start
2 | Returns the start of the text.
3 | > _function (optional text
as nullable any, count
as number) as nullable any_
4 |
5 | # Description
6 | Returns the first count
characters of text
as a text value.
7 | # Category
8 | Text.Extraction
9 | # Examples
10 | Get the first 5 characters of "Hello, World".
11 | ```
12 | Text.Start("Hello, World", 5)
13 | ```
14 | > "Hello"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.ToBinary.md:
--------------------------------------------------------------------------------
1 | # Text.ToBinary
2 | Encodes text into a binary form.
3 | > _function (optional text
as nullable any, optional encoding
as nullable any, optional includeByteOrderMark
as nullable any) as nullable any_
4 |
5 | # Description
6 | Encodes the given text value, text
, into a binary value using the specified encoding
.
7 | # Category
8 | Text.Conversions from and to text
9 |
--------------------------------------------------------------------------------
/docs/Text/Text.ToList.md:
--------------------------------------------------------------------------------
1 | # Text.ToList
2 | Returns a list of character values from the given text value.
3 | > _function (text
as text) as list_
4 |
5 | # Description
6 | Returns a list of character values from the given text value text
.
7 | # Category
8 | Text.Conversions from and to text
9 | # Examples
10 | Create a list of character values from the text "Hello World".
11 | ```
12 | Text.ToList("Hello World")
13 | ```
14 | > {"H",
15 | "e",
16 | "l",
17 | "l",
18 | "o",
19 | " ",
20 | "W",
21 | "o",
22 | "r",
23 | "l",
24 | "d"}
25 |
26 | ***
27 |
--------------------------------------------------------------------------------
/docs/Text/Text.Trim.md:
--------------------------------------------------------------------------------
1 | # Text.Trim
2 | Removes all leading and trailing whitespace.
3 | > _function (optional text
as nullable any, optional trim
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of removing all leading and trailing whitespace from text value text
.
7 | # Category
8 | Text.Transformations
9 | # Examples
10 | Remove leading and trailing whitespace from " a b c d ".
11 | ```
12 | Text.Trim(" a b c d ")
13 | ```
14 | > "a b c d"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.TrimEnd.md:
--------------------------------------------------------------------------------
1 | # Text.TrimEnd
2 | Removes all trailing whitespace.
3 | > _function (optional text
as nullable any, optional trim
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of removing all trailing whitespace from text value text
.
7 | # Category
8 | Text.Transformations
9 | # Examples
10 | Remove trailing whitespace from " a b c d ".
11 | ```
12 | Text.TrimEnd(" a b c d ")
13 | ```
14 | > " a b c d"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.TrimStart.md:
--------------------------------------------------------------------------------
1 | # Text.TrimStart
2 | Removes all leading whitespace.
3 | > _function (optional text
as nullable any, optional trim
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of removing all leading whitespace from text value text
.
7 | # Category
8 | Text.Transformations
9 | # Examples
10 | Remove leading whitespace from " a b c d ".
11 | ```
12 | Text.TrimStart(" a b c d ")
13 | ```
14 | > "a b c d "
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Text.Upper.md:
--------------------------------------------------------------------------------
1 | # Text.Upper
2 | Converts all characters to uppercase.
3 | > _function (optional text
as nullable any, optional culture
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of converting all characters in text
to uppercase.
7 | # Category
8 | Text.Transformations
9 | # Examples
10 | Get the uppercase version of "aBcD".
11 | ```
12 | Text.Upper("aBcD")
13 | ```
14 | > "ABCD"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Text/Value.FromText.md:
--------------------------------------------------------------------------------
1 | # Value.FromText
2 | Creates a strongly-typed value from a textual representation.
3 | > _function (optional text
as nullable any, optional culture
as nullable any) as nullable any_
4 |
5 | # Description
6 | Decodes a value from a textual representation, text
, and interprets it as a value with an appropriate type.
7 | Value.FromText
takes a text value and returns a number, a logical value, a null value, a datetime value, a duration value, or a text value. The empty text value is interpreted as a null value.
8 | # Category
9 | Text.Conversions from and to text
10 |
--------------------------------------------------------------------------------
/docs/Time/Time.Hour.md:
--------------------------------------------------------------------------------
1 | # Time.Hour
2 | Returns the hour component.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the hour component of the provided time
, datetime
, or datetimezone
value, dateTime
.
7 | # Category
8 | Time
9 | # Examples
10 | Find the hour in #datetime(2011, 12, 31, 9, 15, 36).
11 | ```
12 | Time.Hour(#datetime(2011, 12, 31, 9, 15, 36))
13 | ```
14 | > 9
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Time/Time.Minute.md:
--------------------------------------------------------------------------------
1 | # Time.Minute
2 | Returns the minute component.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the minute component of the provided time
, datetime
, or datetimezone
value, dateTime
.
7 | # Category
8 | Time
9 | # Examples
10 | Find the minute in #datetime(2011, 12, 31, 9, 15, 36).
11 | ```
12 | Time.Minute(#datetime(2011, 12, 31, 9, 15, 36))
13 | ```
14 | > 15
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Time/Time.Second.md:
--------------------------------------------------------------------------------
1 | # Time.Second
2 | Returns the second component.
3 | > _function (optional dateTime
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the second component of the provided time
, datetime
, or datetimezone
value, dateTime
.
7 | # Category
8 | Time
9 | # Examples
10 | Find the second value from a datetime value.
11 | ```
12 | Time.Second(#datetime(2011, 12, 31, 9, 15, 36.5))
13 | ```
14 | > 36.5
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Time/Time.ToRecord.md:
--------------------------------------------------------------------------------
1 | # Time.ToRecord
2 | Returns a record containing the Time value's parts.
3 | > _function (time
as time) as record_
4 |
5 | # Description
6 | Returns a record containing the parts of the given Time value, time
.
7 | time
: A time
value for from which the record of its parts is to be calculated.#time(11, 56, 2)
value into a record containing Time values.
14 | ```
15 | Time.ToRecord(#time(11, 56, 2))
16 | ```
17 | > [
18 | Hour = 11,
19 | Minute = 56,
20 | Second = 2
21 | ]
22 |
23 | ***
24 |
--------------------------------------------------------------------------------
/docs/Type/Function.IsDataSource.md:
--------------------------------------------------------------------------------
1 | # Function.IsDataSource
2 | Returns whether or not a particular function is considered a data source.
3 | > _function (function
as function) as logical_
4 |
5 | # Description
6 | Returns whether or not function
is considered a data source.
7 | # Category
8 | Type
9 |
--------------------------------------------------------------------------------
/docs/Type/Type.AddTableKey.md:
--------------------------------------------------------------------------------
1 | # Type.AddTableKey
2 | Adds a key to the given table type.
3 | > _function (table
as type, columns
as list, isPrimary
as logical) as type_
4 |
5 | # Description
6 | Adds a key to the given table type.
7 | # Category
8 | Type
9 |
--------------------------------------------------------------------------------
/docs/Type/Type.ClosedRecord.md:
--------------------------------------------------------------------------------
1 | # Type.ClosedRecord
2 | Returns a closed version of the given record type (or the same type, if it is already closed).
3 | > _function (type
as type) as type_
4 |
5 | # Description
6 | Returns a closed version of the given record
type
(or the same type, if it is already closed).
7 | # Category
8 | Type
9 | # Examples
10 | Create a closed version of type [ A = number,?]
.
11 | ```
12 | Type.ClosedRecord(type [ A = number,...])
13 | ```
14 | > type [
15 | A = number
16 | ]
17 |
18 | ***
19 |
--------------------------------------------------------------------------------
/docs/Type/Type.Facets.md:
--------------------------------------------------------------------------------
1 | # Type.Facets
2 | Returns the facets of a type.
3 | > _function (type
as type) as record_
4 |
5 | # Description
6 | Returns a record containing the facets of type
.
7 | # Category
8 | Type
9 |
--------------------------------------------------------------------------------
/docs/Type/Type.ForFunction.md:
--------------------------------------------------------------------------------
1 | # Type.ForFunction
2 | Returns a type that represents functions with specific parameter and return type constraints.
3 | > _function (signature
as record, min
as number) as type_
4 |
5 | # Description
6 | Creates a function type
from signature
, a record of ReturnType
and Parameters
, and min
, the minimum number of arguments required to invoke the function.
7 | # Category
8 | Type
9 | # Examples
10 | Creates the type for a function that takes a number parameter named X and returns a number.
11 | ```
12 | Type.ForFunction([ReturnType = type number, Parameters = [X = type number]], 1)
13 | ```
14 | > type function (X as number) as number
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Type/Type.ForRecord.md:
--------------------------------------------------------------------------------
1 | # Type.ForRecord
2 | Returns a type that represents records with specific type constraints on fields.
3 | > _function (fields
as record, open
as logical) as type_
4 |
5 | # Description
6 | Returns a type that represents records with specific type constraints on fields.
7 | # Category
8 | Type
9 |
--------------------------------------------------------------------------------
/docs/Type/Type.FunctionParameters.md:
--------------------------------------------------------------------------------
1 | # Type.FunctionParameters
2 | Returns a record with field values set to the name of the parameters of a function type, and their values set to their corresponding types.
3 | > _function (type
as type) as record_
4 |
5 | # Description
6 | Returns a record with field values set to the name of the parameters of type
, and their values set to their corresponding types.
7 | # Category
8 | Type
9 | # Examples
10 | Find the types of the parameters to the function (x as number, y as text)
.
11 | ```
12 | Type.FunctionParameters(type function (x as number, y as text) as any)
13 | ```
14 | > [x = type number, y = type text]
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Type/Type.FunctionRequiredParameters.md:
--------------------------------------------------------------------------------
1 | # Type.FunctionRequiredParameters
2 | Returns a number indicating the minimum number of parameters required to invoke the type of function.
3 | > _function (type
as type) as number_
4 |
5 | # Description
6 | Returns a number indicating the minimum number of parameters required to invoke the input type
of function.
7 | # Category
8 | Type
9 | # Examples
10 | Find the number of required parameters to the function (x as number, optional y as text)
.
11 | ```
12 | Type.FunctionRequiredParameters(type function (x as number, optional y as text) as any)
13 | ```
14 | > 1
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Type/Type.FunctionReturn.md:
--------------------------------------------------------------------------------
1 | # Type.FunctionReturn
2 | Returns a type returned by a function type.
3 | > _function (type
as type) as type_
4 |
5 | # Description
6 | Returns a type returned by a function type
.
7 | # Category
8 | Type
9 | # Examples
10 | Find the return type of () as any)
.
11 | ```
12 | Type.FunctionReturn(type function () as any)
13 | ```
14 | > type any
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Type/Type.Is.md:
--------------------------------------------------------------------------------
1 | # Type.Is
2 | Type.Is
3 | > _function (type1
as type, type2
as type) as logical_
4 |
5 | # Description
6 | Type.Is
7 | # Category
8 | Type
9 |
--------------------------------------------------------------------------------
/docs/Type/Type.IsNullable.md:
--------------------------------------------------------------------------------
1 | # Type.IsNullable
2 | Returns true if a type is a nullable type; otherwise, false.
3 | > _function (type
as type) as logical_
4 |
5 | # Description
6 | Returns true
if a type is a nullable
type; otherwise, false
.
7 | # Category
8 | Type
9 | # Examples
10 | Determine if number
is nullable.
11 | ```
12 | Type.IsNullable(type number)
13 | ```
14 | > false
15 |
16 | ***
17 | Determine if type nullable number
is nullable.
18 | ```
19 | Type.IsNullable(type nullable number)
20 | ```
21 | > true
22 |
23 | ***
24 |
--------------------------------------------------------------------------------
/docs/Type/Type.IsOpenRecord.md:
--------------------------------------------------------------------------------
1 | # Type.IsOpenRecord
2 | Returns whether a record type is open.
3 | > _function (type
as type) as logical_
4 |
5 | # Description
6 | Returns a logical
indicating whether a record type
is open.
7 | # Category
8 | Type
9 | # Examples
10 | Determine if the record type [ A = number, ...]
is open.
11 | ```
12 | Type.IsOpenRecord(type [ A = number,...])
13 | ```
14 | > true
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Type/Type.ListItem.md:
--------------------------------------------------------------------------------
1 | # Type.ListItem
2 | Returns an item type from a list type.
3 | > _function (type
as type) as type_
4 |
5 | # Description
6 | Returns an item type from a list type
.
7 | # Category
8 | Type
9 | # Examples
10 | Find item type from the list {number}
.
11 | ```
12 | Type.ListItem(type {number})
13 | ```
14 | > type number
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Type/Type.NonNullable.md:
--------------------------------------------------------------------------------
1 | # Type.NonNullable
2 | Returns the non nullable type from a type.
3 | > _function (type
as type) as type_
4 |
5 | # Description
6 | Returns the non nullable
type from the type
.
7 | # Category
8 | Type
9 | # Examples
10 | Return the non nullable type of type nullable number
.
11 | ```
12 | Type.NonNullable(type nullable number)
13 | ```
14 | > type number
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Type/Type.OpenRecord.md:
--------------------------------------------------------------------------------
1 | # Type.OpenRecord
2 | Returns an opened version of the given record type (or the same type, if it is already open).
3 | > _function (type
as type) as type_
4 |
5 | # Description
6 | Returns an opened version of the given record
type
(or the same type, if it is already opened).
7 | # Category
8 | Type
9 | # Examples
10 | Create an opened version of type [ A = number]
.
11 | ```
12 | Type.OpenRecord(type [ A = number])
13 | ```
14 | > type [
15 | A = number, ...
16 | ]
17 |
18 | ***
19 |
--------------------------------------------------------------------------------
/docs/Type/Type.ReplaceFacets.md:
--------------------------------------------------------------------------------
1 | # Type.ReplaceFacets
2 | Replaces the facets of a type.
3 | > _function (type
as type, facets
as record) as type_
4 |
5 | # Description
6 | Replaces the facets of type
with the facets contained in the record facets
.
7 | # Category
8 | Type
9 |
--------------------------------------------------------------------------------
/docs/Type/Type.ReplaceTableKeys.md:
--------------------------------------------------------------------------------
1 | # Type.ReplaceTableKeys
2 | Returns a new table type with all keys replaced by the specified list of keys.
3 | > _function (tableType
as type, keys
as list) as type_
4 |
5 | # Description
6 | Returns a new table type with all keys replaced by the specified list of keys.
7 | # Category
8 | Type
9 |
--------------------------------------------------------------------------------
/docs/Type/Type.TableColumn.md:
--------------------------------------------------------------------------------
1 | # Type.TableColumn
2 | Returns the type of a column in a table.
3 | > _function (tableType
as type, column
as text) as type_
4 |
5 | # Description
6 | Returns the type of the column column
in the table type tableType
.
7 | # Category
8 | Type
9 |
--------------------------------------------------------------------------------
/docs/Type/Type.TableKeys.md:
--------------------------------------------------------------------------------
1 | # Type.TableKeys
2 | Returns the possibly empty list of keys for the given table type.
3 | > _function (tableType
as type) as list_
4 |
5 | # Description
6 | Returns the possibly empty list of keys for the given table type.
7 | # Category
8 | Type
9 |
--------------------------------------------------------------------------------
/docs/Type/Type.TableRow.md:
--------------------------------------------------------------------------------
1 | # Type.TableRow
2 | Type.TableRow
3 | > _function (table
as type) as type_
4 |
5 | # Description
6 | Type.TableRow
7 | # Category
8 | Type
9 |
--------------------------------------------------------------------------------
/docs/Type/Type.TableSchema.md:
--------------------------------------------------------------------------------
1 | # Type.TableSchema
2 | Returns a table containing a description of the columns (i.e. the schema) of the specified table type.
3 | > _function (tableType
as type) as table_
4 |
5 | # Description
6 | Returns a table describing the columns of tableType
.
See the documentation for Table.Schema
for a description of the resulting table.
types
as list) as type_
4 |
5 | # Description
6 | Returns the union of the types in types
.
7 | # Category
8 | Type
9 |
--------------------------------------------------------------------------------
/docs/Uri/Uri.BuildQueryString.md:
--------------------------------------------------------------------------------
1 | # Uri.BuildQueryString
2 | Assemble a record into a URI query string.
3 | > _function (query
as record) as text_
4 |
5 | # Description
6 | Assemble the record query
into a URI query string, escaping characters as necessary.
7 | # Category
8 | Uri
9 | # Examples
10 | Encode a query string which contains some special characters.
11 | ```
12 | Uri.BuildQueryString([a="1", b="+$"])
13 | ```
14 | > "a=1&b=%2B%24"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Uri/Uri.Combine.md:
--------------------------------------------------------------------------------
1 | # Uri.Combine
2 | Returns an absolute URI that is the combination of the input base URI and relative URI.
3 | > _function (baseUri
as text, relativeUri
as text) as text_
4 |
5 | # Description
6 | Returns an absolute URI that is the combination of the input baseUri
and relativeUri
.
7 | # Category
8 | Uri
9 |
--------------------------------------------------------------------------------
/docs/Uri/Uri.EscapeDataString.md:
--------------------------------------------------------------------------------
1 | # Uri.EscapeDataString
2 | Encodes special characters in accordance with RFC 3986.
3 | > _function (data
as text) as text_
4 |
5 | # Description
6 | Encodes special characters in the input data
according to the rules of RFC 3986.
7 | # Category
8 | Uri
9 | # Examples
10 | Encode the special characters in "+money$".
11 | ```
12 | Uri.EscapeDataString("+money$")
13 | ```
14 | > "%2Bmoney%24"
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Values/DirectQueryCapabilities.From.md:
--------------------------------------------------------------------------------
1 | # DirectQueryCapabilities.From
2 | DirectQueryCapabilities.From
3 | > _function (optional value
as nullable any) as table_
4 |
5 | # Description
6 | DirectQueryCapabilities.From
7 | # Category
8 | Values.Implementation
9 |
--------------------------------------------------------------------------------
/docs/Values/Embedded.Value.md:
--------------------------------------------------------------------------------
1 | # Embedded.Value
2 | Accesses a value by name in an embedded mashup.
3 | > _function (optional value
as nullable any, path
as text) as nullable any_
4 |
5 | # Description
6 | Accesses a value by name in an embedded mashup.
7 | # Category
8 | Values.Implementation
9 |
--------------------------------------------------------------------------------
/docs/Values/Pdf.Tables.md:
--------------------------------------------------------------------------------
1 | # Pdf.Tables
2 | Pdf.Tables
3 | > _function (pdf
as binary) as table_
4 |
5 | # Description
6 | Returns any tables found in pdf
.
7 | # Category
8 |
9 | # Examples
10 | Returns the tables contained in sample.pdf.
11 | ```
12 | Pdf.Tables(File.Contents("c:\sample.pdf"))
13 | ```
14 | > #table({"Name", "Kind", "Data"}, ...)
15 |
16 | ***
17 |
--------------------------------------------------------------------------------
/docs/Values/Resource.Access.md:
--------------------------------------------------------------------------------
1 | # Resource.Access
2 | Resource.Access
3 | > _function (optional resource
as nullable any, optional nativeQuery
as nullable any, optional options
as nullable record) as nullable any_
4 |
5 | # Description
6 | Resource.Access
7 | # Category
8 |
--------------------------------------------------------------------------------
/docs/Values/SqlExpression.SchemaFrom.md:
--------------------------------------------------------------------------------
1 | # SqlExpression.SchemaFrom
2 | SqlExpression.SchemaFrom
3 | > _function (optional schema
as nullable any) as nullable any_
4 |
5 | # Description
6 | SqlExpression.SchemaFrom
7 | # Category
8 | Values.Implementation
9 |
--------------------------------------------------------------------------------
/docs/Values/SqlExpression.ToExpression.md:
--------------------------------------------------------------------------------
1 | # SqlExpression.ToExpression
2 | SqlExpression.ToExpression
3 | > _function (sql
as text, environment
as record) as text_
4 |
5 | # Description
6 | SqlExpression.ToExpression
7 | # Category
8 | Values.Implementation
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.Add.md:
--------------------------------------------------------------------------------
1 | # Value.Add
2 | Returns the sum of the two values.
3 | > _function (optional value1
as nullable any, optional value2
as nullable any, optional precision
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the sum of value1
and value2
. An optional precision
parameter may be specified, by default Precision.Double
is used.
7 | # Category
8 | Values.Arithmetic operations
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.As.md:
--------------------------------------------------------------------------------
1 | # Value.As
2 | Value.As
3 | > _function (optional value
as nullable any, type
as type) as nullable any_
4 |
5 | # Description
6 | Value.As
7 | # Category
8 | Values.Types
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.Compare.md:
--------------------------------------------------------------------------------
1 | # Value.Compare
2 | Returns -1, 0, or 1 based on whether the first value is less than, equal to, or greater than the second one.
3 | > _function (optional value1
as nullable any, optional value2
as nullable any, optional precision
as nullable any) as number_
4 |
5 | # Description
6 | Returns -1, 0, or 1 based on whether the first value is less than, equal to, or greater than the second one.
7 | # Category
8 | Values
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.Divide.md:
--------------------------------------------------------------------------------
1 | # Value.Divide
2 | Returns the result of dividing the first value by the second.
3 | > _function (optional value1
as nullable any, optional value2
as nullable any, optional precision
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the result of dividing value1
by value2
. An optional precision
parameter may be specified, by default Precision.Double
is used.
7 | # Category
8 | Values.Arithmetic operations
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.Equals.md:
--------------------------------------------------------------------------------
1 | # Value.Equals
2 | Returns whether two values are equal.
3 | > _function (optional value1
as nullable any, optional value2
as nullable any, optional precision
as nullable any) as logical_
4 |
5 | # Description
6 | Returns true if value value1
is equal to value value2
, false otherwise.
7 | # Category
8 | Values
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.Firewall.md:
--------------------------------------------------------------------------------
1 | # Value.Firewall
2 | Value.Firewall
3 | > _function (key
as text) as nullable any_
4 |
5 | # Description
6 | Value.Firewall
7 | # Category
8 | Values.Implementation
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.Is.md:
--------------------------------------------------------------------------------
1 | # Value.Is
2 | Value.Is
3 | > _function (optional value
as nullable any, type
as type) as logical_
4 |
5 | # Description
6 | Value.Is
7 | # Category
8 | Values.Types
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.Multiply.md:
--------------------------------------------------------------------------------
1 | # Value.Multiply
2 | Returns the product of the two values.
3 | > _function (optional value1
as nullable any, optional value2
as nullable any, optional precision
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the product of multiplying value1
by value2
. An optional precision
parameter may be specified, by default Precision.Double
is used.
7 | # Category
8 | Values.Arithmetic operations
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.NullableEquals.md:
--------------------------------------------------------------------------------
1 | # Value.NullableEquals
2 | Returns whether two values are equal.
3 | > _function (optional value1
as nullable any, optional value2
as nullable any, optional precision
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns null if either argument 'value1
', 'value2
' is null, otherwise equivalent to Value.Equals.
7 | # Category
8 | Values
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.ReplaceType.md:
--------------------------------------------------------------------------------
1 | # Value.ReplaceType
2 | Value.ReplaceType
3 | > _function (optional value
as nullable any, type
as type) as nullable any_
4 |
5 | # Description
6 | Value.ReplaceType
7 | # Category
8 | Values.Types
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.ResourceExpression.md:
--------------------------------------------------------------------------------
1 | # Value.ResourceExpression
2 | Value.ResourceExpression
3 | > _function (optional value
as nullable any) as nullable any_
4 |
5 | # Description
6 | Value.ResourceExpression
7 | # Category
8 |
--------------------------------------------------------------------------------
/docs/Values/Value.Subtract.md:
--------------------------------------------------------------------------------
1 | # Value.Subtract
2 | Returns the difference of the two values.
3 | > _function (optional value1
as nullable any, optional value2
as nullable any, optional precision
as nullable any) as nullable any_
4 |
5 | # Description
6 | Returns the difference of value1
and value2
. An optional precision
parameter may be specified, by default Precision.Double
is used.
7 | # Category
8 | Values.Arithmetic operations
9 |
--------------------------------------------------------------------------------
/docs/Values/Value.Type.md:
--------------------------------------------------------------------------------
1 | # Value.Type
2 | Returns the type of the given value.
3 | > _function (optional value
as nullable any) as type_
4 |
5 | # Description
6 | Returns the type of the given value.
7 | # Category
8 | Values
9 |
--------------------------------------------------------------------------------
/docs/Values/Variable.Value.md:
--------------------------------------------------------------------------------
1 | # Variable.Value
2 | Variable.Value
3 | > _function (identifier
as text) as nullable any_
4 |
5 | # Description
6 | Variable.Value
7 | # Category
8 | Values.Implementation
9 |
--------------------------------------------------------------------------------
/dox.pbix:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Hugoberry/PowerQuery/fff831548fe5039bc0929c5d25b1cf48eb02444f/dox.pbix
--------------------------------------------------------------------------------
/node_modules/balanced-match/.npmignore:
--------------------------------------------------------------------------------
1 | test
2 | .gitignore
3 | .travis.yml
4 | Makefile
5 | example.js
6 |
--------------------------------------------------------------------------------
/node_modules/concat-map/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | node_js:
3 | - 0.4
4 | - 0.6
5 |
--------------------------------------------------------------------------------
/node_modules/concat-map/example/map.js:
--------------------------------------------------------------------------------
1 | var concatMap = require('../');
2 | var xs = [ 1, 2, 3, 4, 5, 6 ];
3 | var ys = concatMap(xs, function (x) {
4 | return x % 2 ? [ x - 0.1, x, x + 0.1 ] : [];
5 | });
6 | console.dir(ys);
7 |
--------------------------------------------------------------------------------
/node_modules/concat-map/index.js:
--------------------------------------------------------------------------------
1 | module.exports = function (xs, fn) {
2 | var res = [];
3 | for (var i = 0; i < xs.length; i++) {
4 | var x = fn(xs[i], i);
5 | if (isArray(x)) res.push.apply(res, x);
6 | else res.push(x);
7 | }
8 | return res;
9 | };
10 |
11 | var isArray = Array.isArray || function (xs) {
12 | return Object.prototype.toString.call(xs) === '[object Array]';
13 | };
14 |
--------------------------------------------------------------------------------
/node_modules/inherits/inherits.js:
--------------------------------------------------------------------------------
1 | try {
2 | var util = require('util');
3 | if (typeof util.inherits !== 'function') throw '';
4 | module.exports = util.inherits;
5 | } catch (e) {
6 | module.exports = require('./inherits_browser.js');
7 | }
8 |
--------------------------------------------------------------------------------
/node_modules/markdown-parser/.npmignore:
--------------------------------------------------------------------------------
1 | # Created by http://www.gitignore.io
2 |
3 | ### Node ###
4 | lib-cov
5 | lcov.info
6 | *.seed
7 | *.log
8 | *.csv
9 | *.dat
10 | *.out
11 | *.pid
12 | *.gz
13 |
14 | pids
15 | logs
16 | results
17 | build
18 | .grunt
19 |
20 | node_modules
21 | bower_components
22 |
--------------------------------------------------------------------------------
/node_modules/markdown-parser/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | node_js:
3 | - "0.11"
4 | - "0.10"
--------------------------------------------------------------------------------
/node_modules/path-is-absolute/index.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 |
3 | function posix(path) {
4 | return path.charAt(0) === '/';
5 | }
6 |
7 | function win32(path) {
8 | // https://github.com/nodejs/node/blob/b3fcc245fb25539909ef1d5eaa01dbf92e168633/lib/path.js#L56
9 | var splitDeviceRe = /^([a-zA-Z]:|[\\\/]{2}[^\\\/]+[\\\/]+[^\\\/]+)?([\\\/])?([\s\S]*?)$/;
10 | var result = splitDeviceRe.exec(path);
11 | var device = result[1] || '';
12 | var isUnc = Boolean(device && device.charAt(1) !== ':');
13 |
14 | // UNC paths are always absolute
15 | return Boolean(result[2] || isUnc);
16 | }
17 |
18 | module.exports = process.platform === 'win32' ? win32 : posix;
19 | module.exports.posix = posix;
20 | module.exports.win32 = win32;
21 |
--------------------------------------------------------------------------------