Merge pull request #14 from kuzudb/swift-documentation-update-1652aafc7a0b207874a5b9bc3e931d5f3f77e44b

Update Swift API documentations

Author: mewim

swift/data/documentation/kuzu.json

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

swift/data/documentation/kuzu/connection.json

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