docs.ftv_RepoObject_AntoraXref - IF

type: IF ( inline function ), modify_date: 2021-10-06 13:45:03

RepoObject_guid: 7BB0089F-AE26-EC11-8529-A81E8446D5B0

Description

generate Antora xref:

@cultures_name is only used for ssas tabular models, for example 'de-DE', 'en-US'

Examples

Example 1. Usage
Select
    ro.RepoObject_guid
  , ax.cultures_name
  , ax.AntoraXrefComponentModule
  , ax.AntoraXrefModule
From
    repo.RepoObject                                                            As ro
    Cross Apply docs.ftv_RepoObject_AntoraXref ( ro.RepoObject_guid, 'de-DE' ) As ax
Order By
    ax.AntoraXrefComponentModule

Select
    rof.RepoObject_guid
  , AntoraXrefCulturesList = String_Agg (
                                            Cast('* ' As NVarchar(Max)) + ax.AntoraXrefComponentModule
                                          , Char ( 13 ) + Char ( 10 )
                                        ) Within Group(Order By
                                                           rof.cultures_name)
  , cultures_count         = Count ( 1 )
From
    docs.RepoObject_OutputFilter_T                                                        As rof
    Cross Apply docs.ftv_RepoObject_AntoraXref ( rof.RepoObject_guid, rof.cultures_name ) As ax
Group By
    rof.RepoObject_guid

Parameters

  • @RepoObject_guid (uniqueidentifier)

  • @cultures_name (nvarchar(10))

Entity Diagram

entity-docs.ftv_repoobject_antoraxref

Columns

Table 1. Columns of docs.ftv_RepoObject_AntoraXref - IF
PK Column Name Data Type NULL? ID

nvarchar(max)

NULL

nvarchar(max)

NULL

nvarchar(10)

NULL

uniqueidentifier

NULL

References

Object Reference Diagram - 1 1

entity_1_1_objectref-docs.ftv_repoobject_antoraxref

Object Reference Diagram - Referenced - 30 0

entity_30_0_objectref-docs.ftv_repoobject_antoraxref

Object Reference Diagram - Referencing - 0 30

entity_0_30_objectref-docs.ftv_repoobject_antoraxref

Column Reference Diagram

entity_1_1_colref-docs.ftv_repoobject_antoraxref

Column Details

_

AntoraXrefComponentModule

AntoraXrefComponentModule

nvarchar(max)

NULL

AntoraXrefModule

AntoraXrefModule

nvarchar(max)

NULL

cultures_name

cultures_name

nvarchar(10)

NULL

RepoObject_guid

RepoObject_guid

uniqueidentifier

NULL

sql_modules_definition

docs.ftv_RepoObject_AntoraXref - IF script
/*
<<property_start>>Description
generate Antora `xref:`

@cultures_name is only used for ssas tabular models, for example 'de-DE', 'en-US'
<<property_end>>

<<property_start>>exampleUsage
Select
    ro.RepoObject_guid
  , ax.cultures_name
  , ax.AntoraXrefComponentModule
  , ax.AntoraXrefModule
From
    repo.RepoObject                                                            As ro
    Cross Apply docs.ftv_RepoObject_AntoraXref ( ro.RepoObject_guid, 'de-DE' ) As ax
Order By
    ax.AntoraXrefComponentModule

Select
    rof.RepoObject_guid
  , AntoraXrefCulturesList = String_Agg (
                                            Cast('* ' As NVarchar(Max)) + ax.AntoraXrefComponentModule
                                          , Char ( 13 ) + Char ( 10 )
                                        ) Within Group(Order By
                                                           rof.cultures_name)
  , cultures_count         = Count ( 1 )
From
    docs.RepoObject_OutputFilter_T                                                        As rof
    Cross Apply docs.ftv_RepoObject_AntoraXref ( rof.RepoObject_guid, rof.cultures_name ) As ax
Group By
    rof.RepoObject_guid
<<property_end>>

check:

SELECT * from [docs].[ftv_RepoObject_AntoraXref]('69CE8EB8-5F62-EB11-84DC-A81E8446D5B0', '')

SELECT * from [docs].[ftv_RepoObject_AntoraXref]('636A4E8B-B80B-EC11-8516-A81E8446D5B0', 'de-DE')

*/
Create   Function docs.ftv_RepoObject_AntoraXref
(
    @RepoObject_guid UniqueIdentifier
  , @cultures_name   NVarchar(10) = ''
)
Returns Table
As
Return
(
    Select
        RepoObject_guid           = @RepoObject_guid
      , cultures_name             = @cultures_name
      , AntoraXrefComponentModule = 'xref:'
                                    --
                                    + config.fs_get_parameter_value ( 'AntoraComponent', '' ) + ':'
                                    --
                                    + config.fs_get_parameter_value ( 'AntoraModule', '' )
                                    + Iif(@cultures_name <> '', '-', '') + @cultures_name + ':'
                                    + docs.fs_cleanStringForFilename ( ro.RepoObject_fullname2 ) + '.adoc[]'
      , AntoraXrefModule          = 'xref:'
                                    --
                                    + config.fs_get_parameter_value ( 'AntoraModule', '' ) + Iif(@cultures_name <> '', '-', '')
                                    + @cultures_name + ':' + docs.fs_cleanStringForFilename ( ro.RepoObject_fullname2 )
                                    + '.adoc[]'
    From
        repo.RepoObject As ro
    Where
        ro.RepoObject_guid = @RepoObject_guid
)