Merge pull request #10 from kuzudb/swift-documentation-update-3e91a73f8dc2380dd2b3530d87aba9decbf615f9

Update Swift API documentations

Author: mewim

swift/data/documentation/kuzu.json

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

swift/data/documentation/kuzu/connection.json

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