ParseSwift Query Question

LilMoke · November 15, 2021, 9:50pm

Hello,

Would someone here be able to show me, or point me, to a sample to query for a user? I have a collection that has a column with a user pointer. I am able to create queries for strings, int, etc. But I am unclear as to the syntax for finding a record that matches a user pointer.

U. hope this makes sense, I have used ParseiOS for a long time and am familiar, but I am new to SwiftUI and ParseSwift. There are not many samples and not much doc so I am struggling with it a bit.

Thanks for any help.

cbaker6 · November 15, 2021, 11:22pm

The playgrounds is the best place for examples:

In terms of querying for pointers, querying on the User class is the same as any other Parse class:

github.com

parse-community/Parse-Swift/blob/25b70d9a7c939c05a8fe86abfe375ebcba081e75/ParseSwift.playground/Pages/8 - Pointers.xcplaygroundpage/Contents.swift#L162-L213

    
      
          //: You can also check if a field is equal to a ParseObject.
          do {
              let query4 = try Author.query("book" == newBook)
                  .includeAll()
          
          
    query4.first { results in
                  switch results {
                  case .success(let author):
                      print("Found author and included all: \(author)")
          
          
        case .failure(let error):
                      assertionFailure("Error querying: \(error)")
                  }
              }
          } catch {
              print("\(error)")
          }
          
          
//: Here's an example of saving Pointers as properties
          do {

This file has been truncated. show original

If you want to use async/await, just use try await instead of try when querying. More on async/await here:

A complete app showing how to use the Swift SDK in SwiftUI is here:

96% of the SDK is documented: ParseSwift Reference

LilMoke · November 16, 2021, 4:35pm

Ok, yes, SnapCat was very helpful, I got qeuries working, but I do have one thing I do not understand.

I can do this: Word.query(WordKey.word == “Some Text”) and it works (string compare)
I can so this: Word.query(WordKey.wordOrder < 8) and it works (int)
But this does not: Word.query(WordKey.isWordNeeded == true) Bool fields do not seem to work, it always return a 0 result set

Is there something special with a bool that I am missing? SnapCat does not query on bools anywhere and the doc part showing comparison functions does not having anything special for bools

cbaker6 · November 16, 2021, 4:52pm

What version of the Parse-Server and Swift SDK are you using?

Your bool query is essentially using:

github.com

parse-community/Parse-Swift/blob/a121bde14587491bf8797d32ede43ac6e049979f/Sources/ParseSwift/Types/Query.swift#L114-L122

    
      
          /**
           Add a constraint that requires that a key is equal to a value.
           - parameter key: The key that the value is stored in.
           - parameter value: The value to compare.
           - returns: The same instance of `QueryConstraint` as the receiver.
           */
          public func == <T>(key: String, value: T) -> QueryConstraint where T: Encodable {
              QueryConstraint(key: key, value: value)
          }

Which should work. It’s possible the server isn’t like how this is being encoded in JSON. Or, the server can have a bug, but this seems like a simple query that should be covered in the server tests.

LilMoke · November 16, 2021, 4:56pm

I think Parse-Server is the latest and my project is Swift 5 Xcode 13.1

Ok, so I checked my code and it seems correct, I will verify which Parse-Server version I am running, but I agree this should be covered as it is pretty basic.

cbaker6 · November 16, 2021, 5:13pm

Can you open an issue on the Swift SDK? I’m guessing this is related to:

Basically, $eq was removed because of the way LiveQuery used it. It’s possible $eq is needed for regular queries and can’t leverage the same way LiveQuery uses it. If this is the case, it’s problematic as the server should choose a specific way or handle both cases.

@davimacedo @dplewis @Manuel if my guess is correct, this is also related to my comments on:

github.com/parse-community/parse-server

GraphQL Subscriptions

parse-community:alpha ← back4app:graphQLSubscriptions

opened 07:42AM - 25 Feb 21 UTC

davimacedo

+428 -6

### New Pull Request Checklist  - [ X ] I am not disclosing a [vulnerability](https://github.com/parse-community/parse-server/blob/master/SECURITY.md). - [ X ] I am creating this PR in reference to an [issue](https://github.com/parse-community/parse-server/issues?q=is%3Aissue). ### Issue Description This PR add subscription support to the GraphQL API. Related issue: https://github.com/parse-community/parse-server/issues/6617 ### Approach We are basically taking a ride with the existing Live Query implementation. In order to use subscriptions, the allowed class names needs to be listed in the liveQuery configuration. A Live Query server is not needed though. We are simulating a ws adapter in order to connect directly to the live query implementation without actually creating sockets (which would not make sense). With something like the following, the GraphQL API, Subscriptions, and Playground will be mounted and can be tested via this PR: ```sh ./bin/parse-server --appId APPLICATION_ID --masterKey MASTER_KEY --databaseURI mongodb://localhost/test --liveQuery '{"classNames": ["MyClass"]}' --mountGraphQL --mountSubscriptions --mountPlayground ``` It is still a work in progress. We need to improve the where input (since most of operations are not available at Live Query), and test/improve the node/originalNode output. We still need to create/fix test-cases. But overall it is working and can be tested. @Moumouls any feedback? ### TODOs before merging  - [ ] Add test cases - [ ] Add entry to changelog - [ ] Add changes to documentation (guides, repository pages, in-code descriptions) - [ ] Add [security check](https://github.com/parse-community/parse-server/blob/master/CONTRIBUTING.md#security-checks) - [ ] Add new Parse Error codes to Parse JS SDK - [ ] ...

Also related to:

github.com/parse-community/parse-server

feat: add support for $eq in LiveQuery

parse-community:alpha ← sadakchap:feat/sendLiveQueryEvent

opened 03:49PM - 05 Oct 21 UTC

sadakchap

+41 -0

### New Pull Request Checklist  - [x] I am not disclosing a [vulnerability](https://github.com/parse-community/parse-server/blob/master/SECURITY.md). - [x] I am creating this PR in reference to an [issue](https://github.com/parse-community/parse-server/issues/7606). ### Issue Description As per this [issue](https://github.com/parse-community/Parse-SDK-JS/issues/1372), currently it is not possible to combine `equalTo` clause with any other clauses and vice-versa using Parse-SDK-JS. After adding support for combining `equalTo` clause with other clauses in [Parse-SDK-JS's pr.](https://github.com/parse-community/Parse-SDK-JS/pull/1373) We need to add support `equalTo` for LiveQuery, so that it triggers correct events for client. Related issue: 7606 ### Approach add support for $eq query in [LiveQuery's matchKeyConstraints](https://github.com/parse-community/parse-server/blob/20cb3333aba67fb89e4e2cda586c559bdb4a23ef/src/LiveQuery/QueryTools.js#L148). ### TODOs before merging  - [ ] Add test cases - [x] Add entry to changelog - [ ] Add changes to documentation (guides, repository pages, in-code descriptions) - [ ] Add [security check](https://github.com/parse-community/parse-server/blob/master/CONTRIBUTING.md#security-checks) - [ ] Add new Parse Error codes to Parse JS SDK

LilMoke · November 16, 2021, 5:19pm

Hmmm, ok, I will post the same thing I posted here on the Swift SDK and see where it goes.

LilMoke · November 16, 2021, 5:24pm

Ok, posted here: Bool query not working... · Issue #282 · parse-community/Parse-Swift · GitHub

cbaker6 · November 16, 2021, 7:57pm

I think this is a false alarm. I checked a bool query in Swift Playgrounds and it works fine as is.

@LilMoke I recommend you check your code and parse dashboard for mistakes. You can test the example I used in Swift Playgrounds here (directions in the README about how to use docker to get a test server up and running in seconds):

github.com

parse-community/Parse-Swift/blob/e0aa6652243f612391be1096fcbfa8262124ca4d/ParseSwift.playground/Pages/2 - Finding Objects.xcplaygroundpage/Contents.swift#L76-L92

    
      
          //: Query highest score using async/await
          #if swift(>=5.5) && canImport(_Concurrency)
          import _Concurrency
          if #available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *) {
              let highestScoresQuery = GameScore.query("isHighest" == true)
              Task {
                  do {
                      let highestScores = try await highestScoresQuery.find()
                      highestScores.forEach { score in
                          print("Found highest score: \(score)")
                      }
                  } catch {
                      print("Error: \(error)")
                  }
              }
          }
          #endif

LilMoke · November 16, 2021, 8:02pm

Hmmmm, ok, I will check it out, thank you for looking further! It could very well be me, a lot of new things for me with SwiftUI and ParseSwift… lol

LilMoke · November 17, 2021, 2:56am

cbaker6, so sorry on the bool, it was my fault, cs101 mistake, but I do have one more question.

I am doing this:

@ObservedObject var wordsWordViewModel = Word.query(WordKey.isActiveButton == true,
												WordKey.cgsUser == User.current)
	.includeAll()
	.order([.ascending(WordKey.buttonOrder)])
	.viewModel

The WordKey.cgsUser is a pointer to a user in the User collection. If I remove that line the bool works, I fixed that issue, but now when I add the pointer to user so I can pull only the records for that user, it does not match. I added .includeAll so it would include the User collection.

What am I doing wrong with this one?

However, on a good note, I have a better understanding of it now, so hopefully the pointer matches are my last crazy questions.

Thanks for the help!!

cbaker6 · November 17, 2021, 11:44am

There needs to be a try? as the Query will fail User.current can’t be converted to a Pointer, or you can convert User.current to a pointer before using it in a query, Functions Reference

Your view model is getting kind of long, you may want to setup your view model in an init, like I did here:

github.com

netreconlab/SnapCat/blob/f8fdcc0e039ea8ff62f9f0884804f8ee90575a0b/SnapCat/Home/TimeLineView.swift#L79-L98

    
      
              init(viewModel: QueryImageViewModel<Post>? = nil) {
                  if let objectId = User.current?.id {
                      currentObjectId = objectId
                  } else {
                      currentObjectId = ""
                  }
                  guard let viewModel = viewModel else {
                      let timeLineQuery = TimeLineViewModel.queryTimeLine()
                          .include(PostKey.user)
                      if let timeLine = timeLineQuery.subscribeCustom {
                          timeLineViewModel = timeLine
                      } else {
                          timeLineViewModel = timeLineQuery.imageViewModel
                      }
                      timeLineViewModel.find()
                      return
                  }
                  timeLineViewModel = viewModel
              }
          }

I used a similar query here:

github.com

netreconlab/SnapCat/blob/f8fdcc0e039ea8ff62f9f0884804f8ee90575a0b/SnapCat/Home/TimeLineViewModel.swift#L50

    
      
              class func queryTimeLine() -> Query<Post> {
                  guard let pointer = try? User.current?.toPointer() else {
                      Logger.home.error("Should have created pointer.")
                      return Post.query().limit(0)
                  }
          
          
        let findFollowings = ProfileViewModel.queryFollowings()
                  let findTimeLineData = Post.query(matchesKeyInQuery(key: PostKey.user,
                                                                      queryKey: ActivityKey.toUser,
                                                                      query: findFollowings))
                  let findTimeLineDataForCurrentUser = Post.query(PostKey.user == pointer)
                  let subQueries = [findTimeLineData, findTimeLineDataForCurrentUser]
                  let query = Post.query(or(queries: subQueries))
                      .order([.descending(ParseKey.createdAt)])
                  return query
              }
          }

The Post model where user is a ParseUser (essentially a Pointer) is here:

github.com

netreconlab/SnapCat/blob/f8fdcc0e039ea8ff62f9f0884804f8ee90575a0b/SnapCat/Models/Post.swift#L19

    
      
          import Foundation
          import ParseSwift
          
          
struct Post: ParseObjectMutable {
          
          
    var objectId: String?
              var createdAt: Date?
              var updatedAt: Date?
              var ACL: ParseACL?
          
          
    var user: User?
              var image: ParseFile?
              var thumbnail: ParseFile?
              var location: ParseGeoPoint?
              var caption: String?
          }
          
          
extension Post {
          
          
    init(image: ParseFile? = nil) {
                  user = User.current

LilMoke · November 18, 2021, 1:15pm

cbaker6, can you briefly explain to me why in SnapCat you set the default calc for all parse objects? I have been using Parse for several UIKit apps over the past few years and have never had to do that.

Is that new for ParseSwift?
Is there an advantage to doing that?
Is it a security reason?
Is there some feature SnapCat has that requires you to do that?

Thank you, BTW, your help above has helped me with loading pointer objects. Lol, I am starting to become a SnapCat lover and expert

cbaker6 · November 18, 2021, 1:56pm

Are you referring to the defaultACL? If so, I believe a few of the SDK’s have this, particularly the Obj-C SDK, iOS Developers Guide | Parse.

To make it super easy to create user-private ACLs for every object, we have a way to set a default ACL that will be used for every new object you create

This is useful if you are creating ParseObject classes from the client side. Many developers use Cloud Code to manage ACL’s and CLP’s; you can also use the Parse Dashboard. In SnapCat, this is done on each ParseObject, because the defaultACL currently isn’t set to the object before a save. I may add this if I get some time later this week.

Thank you, BTW, your help above has helped me with loading pointer objects. Lol, I am starting to become a SnapCat lover and expert

This is great to hear! I’m glad SnapCat is useful. If you find any bugs, feel free to open a PR!

LilMoke · November 18, 2021, 3:33pm

Why do some places you use QueryViewModel and other places, for example, you use TimeLineViewModel, etc. Why do you need QueryViewModel? And, likewise, why can’t you always use classes like TimeLineViewModel… if the question makes sense.

Is it because QueryViewModel is a ParseObject? It seems like TimeLineViewModel and others can be QueryViewModels

LilMoke · November 18, 2021, 3:38pm

Oh wait, I am sorry, I see it know, QueryViewModel us part of ParseSwift. And things like TimeLineViewmodel are your own View Model Classes. And QueryViewModel has some useuful comments with explanation

cbaker6 · November 18, 2021, 3:53pm

Yes, those comments make up the documentation here: QueryViewModel Class Reference

To see how to combine a standard query with live query to make a powerful view model that reactively responds to changes on the server, you can look at QueryImageViewModel which subclasses Subscription → QueryViewModel. This is used whenever you see the property subscribeCustom.

LilMoke · November 18, 2021, 3:59pm

Ahhh ok, yes, I did see that. Thank you. So why does your ProfileView user QueryViewModel and your ActivityView uses ActivityViewModel. Couldn’t ProfileView just use a ProfileViewModel and all the queries required live there? I guess I don’t get why the ProfileView need QueryViewModel?

cbaker6 · November 18, 2021, 4:37pm

It matters what you need for your views. In my case, I’m tying multiple view models to ProfileView (and other views). Some of the view models are simple and can use the Swift SDK stock view model, others are more complicated. Sometimes I want my view models to be reactive using LiveQuery, other times the views can just use standard queries. In the end, it’s about your use-cases and how you choose to design using MVVM (or variations of it).

LilMoke · November 18, 2021, 4:40pm

Ok, that is exactly what I was thinking but I was not sure. It was good to here you validate what I was thinking. That was how it appeared, but I was not entirely sure.