Update Swift API documentations

Author: CI User

swift/data/documentation/kuzu.json

@@ -1 +1 @@
-{"metadata":{"roleHeading":"Instance Method","externalID":"s:4Kuzu10ConnectionC7executeyAA11QueryResultCAA17PreparedStatementC_SDySSxSgGtKlF","title":"execute(_:_:)","modules":[{"name":"Kuzu"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"execute","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":">(","kind":"text"},{"text":"PreparedStatement","preciseIdentifier":"s:4Kuzu17PreparedStatementC","kind":"typeIdentifier"},{"text":", [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":"?]) ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"QueryResult","preciseIdentifier":"s:4Kuzu11QueryResultC","kind":"typeIdentifier"}],"symbolKind":"method"},"abstract":[{"text":"Executes the specified prepared statement with the given parameters and returns the result.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"execute"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"preparedStatement"},{"kind":"text","text":": "},{"identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/PreparedStatement","kind":"typeIdentifier","preciseIdentifier":"s:4Kuzu17PreparedStatementC","text":"PreparedStatement"},{"kind":"text","text":", "},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":"?]) "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/QueryResult","kind":"typeIdentifier","preciseIdentifier":"s:4Kuzu11QueryResultC","text":"QueryResult"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"The prepared statement to execute","type":"text"}],"type":"paragraph"}],"name":"preparedStatement"},{"name":"parameters","content":[{"inlineContent":[{"type":"text","text":"A dictionary mapping parameter names to their values"}],"type":"paragraph"}]}]},{"content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"inlineContent":[{"text":"A QueryResult containing the results of the query","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"content":[{"inlineContent":[{"text":"KuzuError if query execution fails","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note","name":"Throws"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/kuzu\/connection\/execute(_:_:)"]}],"kind":"symbol","identifier":{"url":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/execute(_:_:)","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/Kuzu\/documentation\/Kuzu","doc:\/\/Kuzu\/documentation\/Kuzu\/Connection"]]},"references":{"doc://Kuzu/documentation/Kuzu/PreparedStatement":{"type":"topic","url":"\/documentation\/kuzu\/preparedstatement","title":"PreparedStatement","abstract":[{"type":"text","text":"A class representing a prepared statement in Kuzu."},{"type":"text","text":" "},{"type":"text","text":"PreparedStatement can be used to execute a query with parameters."},{"type":"text","text":" "},{"type":"text","text":"It is returned by the "},{"code":"prepare","type":"codeVoice"},{"type":"text","text":" method of Connection."}],"kind":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/PreparedStatement","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreparedStatement"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"PreparedStatement"}]},"doc://Kuzu/documentation/Kuzu":{"type":"topic","title":"Kuzu","url":"\/documentation\/kuzu","role":"collection","kind":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu","abstract":[]},"doc://Kuzu/documentation/Kuzu/QueryResult":{"kind":"symbol","url":"\/documentation\/kuzu\/queryresult","navigatorTitle":[{"kind":"identifier","text":"QueryResult"}],"type":"topic","abstract":[{"text":"A class representing the result of a query, which can be used to iterate over the result set.","type":"text"},{"text":" ","type":"text"},{"text":"QueryResult is returned by the ","type":"text"},{"code":"query","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"execute","type":"codeVoice"},{"text":" methods of Connection.","type":"text"},{"text":" ","type":"text"},{"text":"It conforms to ","type":"text"},{"code":"CustomStringConvertible","type":"codeVoice"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"Sequence"},{"type":"text","text":" protocols for easy string representation and iteration."}],"role":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"QueryResult"}],"title":"QueryResult","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/QueryResult"},"doc://Kuzu/documentation/Kuzu/Connection":{"kind":"symbol","url":"\/documentation\/kuzu\/connection","role":"symbol","title":"Connection","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection","navigatorTitle":[{"kind":"identifier","text":"Connection"}],"abstract":[{"type":"text","text":"Represents a connection to a Kuzu database."}],"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Connection"}],"type":"topic"},"doc://Kuzu/documentation/Kuzu/Connection/execute(_:_:)":{"url":"\/documentation\/kuzu\/connection\/execute(_:_:)","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"execute"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"kind":"typeIdentifier","preciseIdentifier":"s:4Kuzu17PreparedStatementC","text":"PreparedStatement"},{"kind":"text","text":", ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":"?]) "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:4Kuzu11QueryResultC","text":"QueryResult"}],"identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/execute(_:_:)","title":"execute(_:_:)","abstract":[{"text":"Executes the specified prepared statement with the given parameters and returns the result.","type":"text"}],"role":"symbol","type":"topic"}}}
+{"kind":"symbol","abstract":[{"type":"text","text":"Executes the specified prepared statement with the given parameters and returns the result."}],"metadata":{"symbolKind":"method","modules":[{"name":"Kuzu"}],"roleHeading":"Instance Method","role":"symbol","title":"execute(_:_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"execute"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"preciseIdentifier":"s:4Kuzu17PreparedStatementC","kind":"typeIdentifier","text":"PreparedStatement"},{"kind":"text","text":", ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":"?]) "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:4Kuzu11QueryResultC","kind":"typeIdentifier","text":"QueryResult"}],"externalID":"s:4Kuzu10ConnectionC7executeyAA11QueryResultCAA17PreparedStatementC_SDySSxSgGtKlF"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/Kuzu\/documentation\/Kuzu","doc:\/\/Kuzu\/documentation\/Kuzu\/Connection"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/execute(_:_:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"execute","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":">(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"preparedStatement","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/PreparedStatement","text":"PreparedStatement","kind":"typeIdentifier","preciseIdentifier":"s:4Kuzu17PreparedStatementC"},{"text":", ","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"parameters","kind":"internalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":"?]) ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:4Kuzu11QueryResultC","text":"QueryResult","kind":"typeIdentifier","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/QueryResult"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The prepared statement to execute"}]}],"name":"preparedStatement"},{"content":[{"type":"paragraph","inlineContent":[{"text":"A dictionary mapping parameter names to their values","type":"text"}]}],"name":"parameters"}]},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"text":"A QueryResult containing the results of the query","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"type":"aside","style":"note","content":[{"inlineContent":[{"text":"KuzuError if query execution fails","type":"text"}],"type":"paragraph"}],"name":"Throws"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/kuzu\/connection\/execute(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://Kuzu/documentation/Kuzu":{"role":"collection","title":"Kuzu","url":"\/documentation\/kuzu","kind":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu","type":"topic","abstract":[]},"doc://Kuzu/documentation/Kuzu/QueryResult":{"abstract":[{"text":"A class representing the result of a query, which can be used to iterate over the result set.","type":"text"},{"text":" ","type":"text"},{"text":"QueryResult is returned by the ","type":"text"},{"code":"query","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"execute","type":"codeVoice"},{"text":" methods of Connection.","type":"text"},{"text":" ","type":"text"},{"text":"It conforms to ","type":"text"},{"code":"CustomStringConvertible","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"Sequence","type":"codeVoice"},{"text":" protocols for easy string representation and iteration.","type":"text"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"QueryResult"}],"url":"\/documentation\/kuzu\/queryresult","title":"QueryResult","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"QueryResult"}],"identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/QueryResult","type":"topic","role":"symbol"},"doc://Kuzu/documentation/Kuzu/PreparedStatement":{"type":"topic","title":"PreparedStatement","kind":"symbol","url":"\/documentation\/kuzu\/preparedstatement","role":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/PreparedStatement","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreparedStatement"}],"navigatorTitle":[{"kind":"identifier","text":"PreparedStatement"}],"abstract":[{"type":"text","text":"A class representing a prepared statement in Kuzu."},{"type":"text","text":" "},{"type":"text","text":"PreparedStatement can be used to execute a query with parameters."},{"type":"text","text":" "},{"type":"text","text":"It is returned by the "},{"type":"codeVoice","code":"prepare"},{"type":"text","text":" method of Connection."}]},"doc://Kuzu/documentation/Kuzu/Connection/execute(_:_:)":{"title":"execute(_:_:)","url":"\/documentation\/kuzu\/connection\/execute(_:_:)","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/execute(_:_:)","type":"topic","abstract":[{"text":"Executes the specified prepared statement with the given parameters and returns the result.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"execute","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":">(","kind":"text"},{"text":"PreparedStatement","preciseIdentifier":"s:4Kuzu17PreparedStatementC","kind":"typeIdentifier"},{"text":", [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":"?]) ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:4Kuzu11QueryResultC","text":"QueryResult","kind":"typeIdentifier"}]},"doc://Kuzu/documentation/Kuzu/Connection":{"title":"Connection","navigatorTitle":[{"text":"Connection","kind":"identifier"}],"url":"\/documentation\/kuzu\/connection","type":"topic","kind":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Connection","kind":"identifier"}],"role":"symbol","abstract":[{"text":"Represents a connection to a Kuzu database.","type":"text"}]}}}

swift/data/documentation/kuzu/connection.json

@@ -1 +1 @@
-{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getMaxNumThreadForExec"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s6UInt64V","text":"UInt64"}],"platforms":["macOS"]}]},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"The maximum number of threads"}],"type":"paragraph"}],"kind":"content"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/kuzu\/connection\/getmaxnumthreadforexec()"]}],"hierarchy":{"paths":[["doc:\/\/Kuzu\/documentation\/Kuzu","doc:\/\/Kuzu\/documentation\/Kuzu\/Connection"]]},"sections":[],"metadata":{"modules":[{"name":"Kuzu"}],"title":"getMaxNumThreadForExec()","externalID":"s:4Kuzu10ConnectionC22getMaxNumThreadForExecs6UInt64VyF","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getMaxNumThreadForExec","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"UInt64","kind":"typeIdentifier","preciseIdentifier":"s:s6UInt64V"}],"role":"symbol","symbolKind":"method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/getMaxNumThreadForExec()"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Returns the maximum number of threads that can be used for executing a query in parallel.","type":"text"}],"references":{"doc://Kuzu/documentation/Kuzu":{"type":"topic","title":"Kuzu","url":"\/documentation\/kuzu","role":"collection","kind":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu","abstract":[]},"doc://Kuzu/documentation/Kuzu/Connection/getMaxNumThreadForExec()":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getMaxNumThreadForExec","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"UInt64","preciseIdentifier":"s:s6UInt64V","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/getMaxNumThreadForExec()","title":"getMaxNumThreadForExec()","url":"\/documentation\/kuzu\/connection\/getmaxnumthreadforexec()","abstract":[{"type":"text","text":"Returns the maximum number of threads that can be used for executing a query in parallel."}],"role":"symbol"},"doc://Kuzu/documentation/Kuzu/Connection":{"kind":"symbol","url":"\/documentation\/kuzu\/connection","role":"symbol","title":"Connection","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection","navigatorTitle":[{"kind":"identifier","text":"Connection"}],"abstract":[{"type":"text","text":"Represents a connection to a Kuzu database."}],"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Connection"}],"type":"topic"}}}
+{"identifier":{"url":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/getMaxNumThreadForExec()","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/Kuzu\/documentation\/Kuzu","doc:\/\/Kuzu\/documentation\/Kuzu\/Connection"]]},"metadata":{"modules":[{"name":"Kuzu"}],"symbolKind":"method","role":"symbol","roleHeading":"Instance Method","title":"getMaxNumThreadForExec()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getMaxNumThreadForExec","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:s6UInt64V","text":"UInt64","kind":"typeIdentifier"}],"externalID":"s:4Kuzu10ConnectionC22getMaxNumThreadForExecs6UInt64VyF"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getMaxNumThreadForExec"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"UInt64","preciseIdentifier":"s:s6UInt64V"}]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The maximum number of threads"}]}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Returns the maximum number of threads that can be used for executing a query in parallel.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/kuzu\/connection\/getmaxnumthreadforexec()"]}],"references":{"doc://Kuzu/documentation/Kuzu":{"role":"collection","title":"Kuzu","url":"\/documentation\/kuzu","kind":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu","type":"topic","abstract":[]},"doc://Kuzu/documentation/Kuzu/Connection/getMaxNumThreadForExec()":{"title":"getMaxNumThreadForExec()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getMaxNumThreadForExec","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"UInt64","preciseIdentifier":"s:s6UInt64V","kind":"typeIdentifier"}],"kind":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/getMaxNumThreadForExec()","type":"topic","url":"\/documentation\/kuzu\/connection\/getmaxnumthreadforexec()","abstract":[{"text":"Returns the maximum number of threads that can be used for executing a query in parallel.","type":"text"}],"role":"symbol"},"doc://Kuzu/documentation/Kuzu/Connection":{"title":"Connection","navigatorTitle":[{"text":"Connection","kind":"identifier"}],"url":"\/documentation\/kuzu\/connection","type":"topic","kind":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Connection","kind":"identifier"}],"role":"symbol","abstract":[{"text":"Represents a connection to a Kuzu database.","type":"text"}]}}}