Skip to content

Commit 8f7a8ea

Browse files
authored
Merge pull request #7 from kuzudb/swift-documentation-update-b93722f643fe6d5149acc5c6b9dd9dbce60931d2
Update Swift API documentations
2 parents 7de14b1 + 34e2e0d commit 8f7a8ea

File tree

345 files changed

+724
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

345 files changed

+724
-0
lines changed

swift/css/866.60f074fd.css

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swift/css/989.4f123103.css

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swift/css/documentation-topic.91c07ba9.css

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swift/css/index.3a335429.css

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swift/css/topic.4be8f56d.css

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swift/css/tutorials-overview.7942d777.css

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swift/data/documentation/kuzu.json

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"final"},{"kind":"text","text":" "},{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Connection"}],"languages":["swift"],"platforms":["macOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection"},"abstract":[{"text":"Represents a connection to a Kuzu database.","type":"text"}],"topicSections":[{"identifiers":["doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/init(_:)"],"generated":true,"anchor":"Initializers","title":"Initializers"},{"identifiers":["doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/execute(_:_:)","doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/getMaxNumThreadForExec()","doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/interrupt()","doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/prepare(_:)","doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/query(_:)","doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/setMaxNumThreadForExec(_:)","doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/setQueryTimeout(_:)"],"generated":true,"anchor":"Instance-Methods","title":"Instance Methods"}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Connection"}],"externalID":"s:4Kuzu10ConnectionC","modules":[{"name":"Kuzu"}],"role":"symbol","title":"Connection","navigatorTitle":[{"kind":"identifier","text":"Connection"}],"symbolKind":"class","roleHeading":"Class"},"variants":[{"paths":["\/documentation\/kuzu\/connection"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/Kuzu\/documentation\/Kuzu"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/Kuzu\/s8SendableP"],"type":"conformsTo","title":"Conforms To"}],"references":{"doc://Kuzu/documentation/Kuzu/Connection/init(_:)":{"title":"init(_:)","role":"symbol","abstract":[{"text":"Opens a connection to the specified database.","type":"text"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:4Kuzu8DatabaseC","text":"Database"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"url":"\/documentation\/kuzu\/connection\/init(_:)","type":"topic","kind":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/init(_:)"},"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"},"doc://Kuzu/documentation/Kuzu/Connection/prepare(_:)":{"url":"\/documentation\/kuzu\/connection\/prepare(_:)","title":"prepare(_:)","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/prepare(_:)","type":"topic","abstract":[{"text":"Returns a prepared statement for the specified query string.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The prepared statement can be used to execute the query with parameters."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"prepare"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:4Kuzu17PreparedStatementC","text":"PreparedStatement"}],"role":"symbol","kind":"symbol"},"doc://Kuzu/documentation/Kuzu/Connection/setMaxNumThreadForExec(_:)":{"title":"setMaxNumThreadForExec(_:)","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/setMaxNumThreadForExec(_:)","kind":"symbol","abstract":[{"type":"text","text":"Sets the maximum number of threads that can be used for executing a query in parallel."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setMaxNumThreadForExec"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:s6UInt64V","text":"UInt64"},{"kind":"text","text":")"}],"role":"symbol","type":"topic","url":"\/documentation\/kuzu\/connection\/setmaxnumthreadforexec(_:)"},"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":{"type":"topic","title":"Kuzu","url":"\/documentation\/kuzu","role":"collection","kind":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu","abstract":[]},"doc://Kuzu/documentation/Kuzu/Connection/setQueryTimeout(_:)":{"identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/setQueryTimeout(_:)","abstract":[{"text":"Sets the timeout for the queries executed on the connection.","type":"text"},{"text":" ","type":"text"},{"text":"The timeout is specified in milliseconds. A value of 0 means no timeout.","type":"text"},{"text":" ","type":"text"},{"text":"If a query takes longer than the specified timeout, it will be interrupted.","type":"text"}],"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"setQueryTimeout","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:s6UInt64V","text":"UInt64","kind":"typeIdentifier"},{"text":")","kind":"text"}],"type":"topic","title":"setQueryTimeout(_:)","role":"symbol","url":"\/documentation\/kuzu\/connection\/setquerytimeout(_:)"},"doc://Kuzu/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/Kuzu\/s8SendableP"},"doc://Kuzu/documentation/Kuzu/Connection/query(_:)":{"abstract":[{"type":"text","text":"Executes a query string and returns the result."}],"kind":"symbol","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/query(_:)","url":"\/documentation\/kuzu\/connection\/query(_:)","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"query","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"QueryResult","preciseIdentifier":"s:4Kuzu11QueryResultC","kind":"typeIdentifier"}],"title":"query(_:)"},"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/interrupt()":{"role":"symbol","type":"topic","url":"\/documentation\/kuzu\/connection\/interrupt()","identifier":"doc:\/\/Kuzu\/documentation\/Kuzu\/Connection\/interrupt()","title":"interrupt()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"interrupt","kind":"identifier"},{"text":"()","kind":"text"}],"kind":"symbol","abstract":[{"text":"Interrupts the execution of the current query on the connection.","type":"text"}]}}}

0 commit comments

Comments
 (0)